This branch is being retired in favor of the main branch, which uses the latest Adobe I/O publishing workflow. Please make any changes or updates to the documentation on the main branch.
This documentation provides instructions for Adobe Analytics 2.0 APIs. For working with Analytics 1.4 APIs, see Analytics 1.4 API Documentation.
The Adobe Analytics APIs are a collection of APIs that power Adobe Analytics products like Analysis Workspace. The APIs allow for the creation of data rich user interfaces that you can use to manipulate and integrate data. You can also create reports to explore, get insights, or answer important questions about your data.
CONTRIBUTING: We encourage you to participate in our open documentation initiative, if you have suggestions, corrections, additions or deletions for this documentation, check out the source from this github repo, and submit a pull request with your contribution. For more information, refer to the Contributing page.
It is assumed that you have an understanding of the Adobe Analytics product, its features and capabilities and that you know how to use the product. Thus an introduction to Adobe Analytics is outside of the scope of this documentation. For more information about the Adobe Analytics product, refer to the Adobe Analytics documentation.
To get started with Analytics 2.0 APIs you must first decide whether your application will need an OAuth client or a JWT client.
There multiple types of authentication for authenticating with the analytics APIs. General information about authenticating with Adobe's APIs is located here. Specific information related to authenticating with the analytics APIs is available in the sections below.
Use an OAuth client if you are creating an application that requires an end user to authenticate before calling the Adobe Analytics APIs. The OAuth tokens expire after 24 hours and the end user must then re-authenticate before they will be able to call the APIs. To authenticate with an OAuth client, you first create an OAuth client on the Adobe I/O Console. You can then use either method below with your client:
Note: The refresh token grant type is automatically added to OAuth clients created after September 18, 2019
A JWT client is best if you are creating an application that needs to programmatically authenticate calls to the Adobe Analytics APIs. A new JWT token can be generated whenever the old one is about to expire so your application can continue to make API calls.
For more information see JWT authentication.
Try the Analytics 2.0 API in seconds. Use our Swagger UI to explore APIs, make calls and get a response. Our Swagger UI also includes the full endpoint descriptions.
The Discovery API returns information on the user's company that is necessary for making other Adobe Analytics API calls.
The Reporting API Guide provides configuration guidance and best practices for the /reports endpoint.
Please also refer to the Reporting Tricks Guide to learn how to use analysis workspace to build and validate your API requests.
The Segments API Guide provides configuration guidance and best practices for the /segments endpoint.
The Projects API Guide provides configuration guidance and best practices for the /projects endpoint.
The Report Suite API Guide provides more details on configuring report suites and virtual report suites.
See the Analytics Bulk Data Insertion API User's Guide
See the Data Repair API Guide
For help migrating from the 1.3/1.4 versions of the Analytics API to the newer and more capable /reports API, refer to the migration guide.
The timeout for API requests through adobe.io is currently 60 seconds.
The default rate limit for an Adobe Analytics Company is 120 requests per minute per user. (The limit is enforced as 12 requests every 6 seconds). When rate limiting is being enforced you will get 429 HTTP response codes with the following response body: {"error_code":"429050","message":"Too many requests"}