LoginSign UpGet Demo
Get accountRequest Demo
DocumentationIntegrationsTools
BlogChangelogPricingLogin
Back

Adobe Analytics API Essential Guide

Aug 7, 2024 • 6 minute read

What type of API does Adobe Analytics provide?

API Types and Details:

  1. REST API:

    • Used for web services communication with Adobe Commerce and Magento Open Source.
    • Supports authentication methods like OAuth 1.0a, tokens, and login credentials.
    • Follows CRUD (create, read, update, delete) & search model.

  2. SOAP API:

    • Also supported for web services communication.
    • Uses the same authentication methods as REST API.

  3. GraphQL API:

    • Implemented as an alternative to REST and SOAP for frontend development.
    • Has its own schema and playground for testing queries.
    • Accessed via the endpoint http://<commerce-server>/graphql.

Does the Adobe Analytics API have webhooks?

Does Adobe Analytics API have webhooks?

The official Adobe Analytics API itself does not appear to have direct webhook functionality. However, Adobe offers webhook capabilities through Adobe I/O Events, which can be used in conjunction with various Adobe services, including potentially Adobe Analytics.

Key points about Adobe I/O Events webhooks:

  1. Adobe I/O Events allows applications to subscribe to be notified when certain events occur across Adobe services.

  2. To receive events, you create an event registration specifying a webhook URL and the types of events you want to receive.

  3. Each event results in an HTTP POST request to the specified webhook URL, notifying your application.

  4. Adobe I/O Events supports both webhooks for near real-time notifications (push) and a Journaling API (pull) to retrieve groups of events.

  5. Adobe I/O Events provides durable delivery, delivering each event at least once for each registration.

  6. Webhook requests include security measures like digital signatures and client ID verification to ensure authenticity.

Types of events available:

While the search results don't specifically mention Adobe Analytics events, they do list several Adobe services that support events through I/O Events, including:

  • Creative Cloud Libraries
  • Adobe XD
  • Adobe Document Cloud
  • Platform notifications
  • Analytics Triggers
  • Marketo Data Streams
  • Privacy Service
  • Cloud Manager
  • AEM
  • Adobe Campaign Standard

It's worth noting that "Analytics Triggers" is mentioned, which may be related to Adobe Analytics.

Best practices:

  1. Implement proper security verification for incoming webhook requests.
  2. Set up retry mechanisms and handle potential downtime of your webhook endpoint.
  3. Use the Journaling API to retrieve missed events if your webhook was temporarily unavailable.

In conclusion, while the Adobe Analytics API itself may not directly offer webhooks, you can likely integrate Adobe Analytics data with webhooks through Adobe I/O Events platform, especially using Analytics Triggers. For specific Adobe Analytics event types, you would need to consult the Adobe Analytics documentation or contact Adobe support for more detailed information.

Rate Limits and other limitations

Based on the search results, here are the key points about the API rate limits for Adobe Analytics:

Rate Limits

  • The API rate limits are per company and are hourly [3].
  • The specific limit depends on the contract with Adobe [3].
  • There is no fixed number provided for the rate limit, as it varies by contract.

Timeout

  • API requests submitted through adobe.io currently time out at 60 seconds [4].

Approaching and Exceeding Limits

  • You will receive API responses when you get close to your limit and when you exceed the limit [3].
  • When exceeding the limit, you may receive an error message like: 
    {"error":{"code":"50301","domain":"Request.OverLimit","message":"Please reduce request rate"}}
    [3]

Best Practices

  • Reduce the request rate if you encounter rate limit errors [1][3].
  • Avoid requesting too small of a granularity over too large of a date range (e.g., a year's worth of data broken down in 1-minute increments) [1].
  • Don't request fully-processed data on intervals less than 45 minutes, as data typically takes up to 45 minutes to process [1].
  • Use scheduled Data Warehouse deliveries or Data Feeds for large-scale bulk exports instead of the reporting API [1].

Additional Notes

  • In rare cases, Adobe may increase the throttle limit for some customers if they submit a request through their Account Manager or Customer Success Manager and explain their use case [1].
  • The API is part of the paid Adobe Analytics service; there isn't a separate "paid version" of the API [3].

It's important to note that the specific rate limits are not publicly disclosed and depend on your contract with Adobe. If you need to know your exact limits or request an increase, you should contact your Adobe account representative.

Latest API Version

Based on the search results provided, the most recent version of the Adobe Analytics API is version 2.0. Here are the key points:

Current Version

  • The current version of the Adobe Analytics API is 2.0 [3].

Key Points

  • The Adobe Analytics 2.0 APIs allow you to directly call Adobe's servers to perform almost any action that you can perform in the user interface [3].

  • With the 2.0 APIs, you can create reports to explore, get insights, or answer important questions about your data. You can also manage components of Adobe Analytics, such as creating segments or calculated metrics [3].

End-of-Life Notice

  • The older Adobe Analytics API (version 1.4) has an end-of-life notice [2]:
    • On August 12, 2026, the Analytics Legacy API services (version 1.4) will reach their end-of-life and will be shut down [2].
    • Integrations using the Adobe Analytics API (version 1.4) must migrate to the Adobe Analytics 2.0 API [2].

Authentication Changes

  • Adobe is migrating from JWT to OAuth Server-to-Server credentials [2]:
    • By January 1, 2025, customers using Adobe I/O JWT credentials must migrate to Adobe I/O OAuth Server-to-Server credentials [2].
    • Starting May 1, 2024, Adobe I/O will not allow new JWT credentials to be created [2].

Best Practices

  • It's recommended to use the latest version (2.0) of the Adobe Analytics API for new integrations and to migrate existing integrations from older versions [2][3].

  • When working with the 2.0 API, refer to the official documentation for the most up-to-date information on endpoints, authentication, and best practices [3].

In summary, the Adobe Analytics 2.0 API is the current and recommended version, with the older 1.4 version set to be discontinued in the future. Developers should focus on using and migrating to the 2.0 version for their integrations.

How to get a Adobe Analytics developer account and API Keys?

To get a developer account for Adobe Analytics and create an API integration, you need to follow these steps:

1. Obtain the necessary permissions

Before you can create an API integration, you need to ensure that your account has the correct permissions:

  • You must be assigned as a developer for an Analytics product profile in the Adobe Admin Console.
  • A system administrator or product profile admin needs to give you the correct API permissions.

2. Create an API client in Adobe Developer Console

Once you have the necessary permissions, you can create an API client:

  • Log in to the Adobe Developer Console.
  • Make sure you're logged in to the correct organization (check the top right corner).
  • Click on "Create new project" or select an existing project.
  • Click "Add to Project" and select "API" from the drop-down menu.
  • Under the Experience Cloud section, select "Adobe Analytics".

3. Choose authentication method

You'll need to decide how you want to authenticate with the API:

  • OAuth User: Use your own account to authenticate with the API.
  • OAuth Server to Server: Use a server-to-server account to authenticate with the API.

Note: JWT authentication is deprecated and will only be supported until January 1, 2025.

4. Complete the API client setup

  • Select "OAuth Server-to-Server" authentication.
  • Choose a Product Profile to assign the integration to a specific Adobe Analytics role.
  • Complete the remaining steps in the API client wizard.

5. Obtain credentials

After creating the API client, you'll receive:

  • Client ID (API Key)
  • Organization ID
  • Client Secret
  • Scopes

You'll need these credentials when making API calls.

What can you do with the Adobe Analytics API?

Based on the search results provided, here is a list of data models you can interact with using the Adobe Analytics API, along with what is possible for each:

Reporting Data Models

  • Fully Processed Data

    • Latency: 30-90 minutes
    • Full processing completion
    • Supports visitor profile processing and segmentation
    • Accessible via Analysis Workspace, Report Builder, and API [2]

  • Real-Time Data

    • Latency: Seconds to 10 minutes
    • Partial processing
    • Available through Real-Time report in Report Builder and 1.4 API [2]

  • Livestream Data

    • Latency: Seconds
    • Hit-level data
    • Available only through API [2]

  • Data Warehouse

    • Latency: 90+ minutes
    • Full processing completion
    • Accessible via Data Warehouse interface and API [2]

Component Data Models

  • Segments

    • Create, manage, and apply unique user segments based on behaviors
    • Use across reports and other Adobe Experience Cloud solutions [1]

  • Calculated Metrics

    • Create and manage advanced calculated metrics
    • Combine metrics to create mathematical and statistical operations [1]

  • Date Ranges

    • Define and manage custom date ranges for reporting [4]

  • Virtual Report Suites

    • Create and manage virtual report suites [4]

  • Projects

    • Manage Analysis Workspace projects programmatically [4]

Other Data Models

  • Anomaly Detection

    • Access anomaly detection algorithms used in Analysis Workspace [4]

  • Attribution Models

    • Utilize Attribution IQ models available in Analysis Workspace [4]

  • Audience Data

    • Incorporate audience data from Adobe Audience Manager [1]

  • Advertising Analytics

    • Import search engine data (impressions, clicks, cost, etc.) [1]

  • Cross-Device Analytics

    • Unify app and web data for cross-device analysis [1]

API Capabilities

  • Perform almost any action available in the user interface [3]
  • Create reports to explore data and gain insights [3]
  • Manage Adobe Analytics components (e.g., segments, calculated metrics) [3]
  • Access newest Analytics features [4]
  • Integrate with other Experience Cloud products [4]

It's important to note that the Adobe Analytics 2.0 APIs offer improved performance, more flexible querying capabilities, and access to advanced features compared to earlier versions [4]. When migrating from 1.4 to 2.0 APIs, be aware of some differences in how certain features like Data Warehouse reports are handled [4].

Ship integrations on autopilot

Get Demo
Resources
DocumentationIntegrationsAPI Integration GuidesBlogChangelogPricingSupport
Legal
Terms of ServicePrivacy PolicyGoogle API
© 2024 Playbook Software Inc.