Skip to content
Documentation for the Adobe Analytics 2.0 APIs
Branch: master
Clone or download
Latest commit fec384f May 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Updating segments endpoint to make includeType attribute customer facing Mar 22, 2019
examples/jwt/java Fix white space Mar 8, 2019
images updating image as well Apr 11, 2019
.project Initial commit of Analytics Docs Aug 7, 2018
CODE_OF_CONDUCT.md Initial commit of Analytics Docs Aug 7, 2018
CONTRIBUTING.md Initial commit of Analytics Docs Aug 7, 2018
LICENSE Initial commit of Analytics Docs Aug 7, 2018
PULL_REQUEST_TEMPLATE.md Initial commit of Analytics Docs Aug 7, 2018
README.md Discovery API added wording May 6, 2019
calculatedmetrics.md Updates per Tanner edits Mar 27, 2019
create-oauth-client.md Update topic for developer permissions Apr 9, 2019
discovery.md Style Revision May 6, 2019
faq.md Add FAQ page. Mar 14, 2019
jwt.md Style and clarity edit Apr 9, 2019
manifest-api-reference.json Update manifest-api-reference.json Oct 9, 2018
manifest-docs.json Add FAQ page. Mar 14, 2019
migration-guide.md Updated swagger and some docs Aug 23, 2018
oauth-curl.md updating to fix curl typo Jan 29, 2019
oauth-postman.md Added video tutorial links for postman Apr 22, 2019
reporting-guide.md Added multi-level breakdown example Dec 13, 2018
reporting-multiple-breakdowns.md Style revision for multiple breakdowns guide Jan 23, 2019
reporting-tricks.md fixing url to one that works Apr 11, 2019
segments-guide.md Create segments-guide.md (#41) Nov 29, 2018
segments.md update segments.md (#44) Nov 29, 2018
support.md Fix the spelling of Github to GitHub Mar 27, 2019

README.md

Analytics 2.0 APIs

Documentation for the analytics 2.0 APIs

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.

Getting Started

To get started with Analytics 2.0 APIs you must first decide whether your application will need an OAuth client or a JWT client.

Authentication

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.

OAuth

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: Refresh tokens are not supported with OAuth for the Adobe Analytics APIs

JWT

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 Now

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.

Discovery API

The Discovery API returns information on the user's company that is necessary for making other Adobe Analytics API calls.

Reporting API Guide

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.

Segments API Guide

The Segments API Guide provides configuration guidance and best practices for the /segments endpoint.

Migrating from 1.4 APIs to 2.0 APIs

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.

API Request Timeouts

The timeout for API requests through adobe.io is currently 60 seconds.

Rate Limiting

The default rate limit for an Adobe Analytics Company is 120 requests per minute. (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"}

You can’t perform that action at this time.