Accessing & Using the API Key

Your API key allows you to use the ObservePoint API, Journey Manager, and ObservePoint Labs (Google Sheet Add-on). 

Note: Your API Key serves as a credential to your account, so make secure it like you would any username or password.

Accessing the API Key

To access the API key, navigate to your Profile page.

Note: The API Key field will only be visible if API Access is enabled in your account. This feature is limited to accounts that hsvr this included in their contracts. Please reach out to Support if you have any questions or need assistance with this. 

The API Key field is located below your user information. You can copy and paste the string wherever the API key is needed. The key is approximately 100 characters in length.

Clicking the Revoke & Set New button will remove and disable the current key and generate a new one.

Note: If you regenerate your API key, all apps or scripts using the old one must be replaced with the new one in order to function. Once an API key has been revoked, it cannot be re-enabled; you must use a new key.

If a key does not show in your profile, click Generate New API Key. If the button does not show, API access may not be enabled for your account. Contact Support or your Success Manager if this option isn't available.

Using the API Key

Using the API key to access the ObservePoint API, Journey Manager, or ObservePoint Labs (Google Sheet Add-on) is as simple as copying and pasting the key into the required field.

If you are using the ObservePoint API to make a request in a script or in Postman, you will need to ensure that you use the correct format to authenticate.

To authenticate include the following Authorization header in your request(s):

"Authorization" : "api_key {insert api key here}"