The Optimize API will allow requests against data in our databases, without you needing to log into the platform.
In order to access it, you first need to generate a personal access token. This token will have the same rights as your user - i.e. the same accounts and the same permissions within each account.
To generate a token, navigate to the account overview screen then choose "My Profile" from the nav.
Be aware that this token is a secret API key - you need to save it somewhere safe and we will not store it or display it again. Regenerating a new key will invalidate an existing one.
You will also need the account id which can be found on the "Account Overview" screen.
These two values need to be passed in as headers in any request, with the personal access token prefixed by "Bearer ". The header names are Authorization and x-account-id, as shown.
The rate limit is 100 requests per minute, for a higher limit please reach out via Service Desk.
Rate limit information is available in the headers of the response:
At the time of writing, we have one route available to fetch audience information. This document will be updated as more is made available.
The existing endpoint is https://api.webtrends-optimize.com/v2/getSegments and requires a GET request.