Using the API Key

Your API key will be provided by your technical account manager.

A Carbon API key allows access to Carbon data from an external system without an active Dashboard login.

In order to use the API Key, callers must provide an 'api-key' value, either via a query string parameter or request header. The parameter name for both is "api-key" For example:

https://api.carbon.clicksco.com/api/profiles/{profileId}/interests/{date-from}/{date-to}?api-key={your-api-key}

You are advised to keep your API Keys safe to prevent malicious third parties making Carbon requests on your behalf. While we don't currently throttle or rate limit API Key requests, we will disable keys used improperly.

If for any reason you seem to be struggling to get a response from the API please reach out to your technical account manager and they will be able to help