Table of Contents
API Overview
Adobe Analytics is a powerful web analytics platform that provides businesses with insights into their website traffic, marketing campaigns, and customer behavior. It offers a comprehensive suite of features, including real-time reporting, segmentation, and advanced analysis tools. Adobe Analytics helps businesses understand how their customers interact with their website, identify areas for improvement, and optimize their marketing strategies.
Adobe Analytics API provides developers with programmatic access to Adobe Analytics data and functionality. It offers a range of REST APIs that allow developers to retrieve data, create and manage reports, and perform other tasks. The API also supports webhooks, which allow developers to receive notifications when certain events occur in Adobe Analytics. To ensure fair usage and prevent abuse, Adobe Analytics API imposes rate limits on the number of requests that can be made per minute.
API Request Limits
SDKs
APIs
Method: GET
Description: Returns a list of analytics data..
Endpoint: /reports
Parameters: start_date, end_date, metric, dimension, filter, sort, limit, offset, totals, include_empty_rows, include_totals, segment, metadata, user_segment, result_format
Method: GET
Description: Returns a list of all analytics data..
Endpoint: /reports
Parameters:
Method: GET
Description: Returns a list of analytics data for a specific property..
Endpoint: /reports/:property_id
Parameters: start_date, end_date, metric, dimension, filter, sort, limit, offset, totals, include_empty_rows, include_totals, segment, metadata, user_segment, result_format
Method: GET
Description: Returns a list of analytics data for a specific property and date range..
Endpoint: /reports/:property_id/:date_range
Parameters: metric, dimension, filter, sort, limit, offset, totals, include_empty_rows, include_totals, segment, metadata, user_segment, result_format
Method: GET
Description: Returns a list of analytics data for a specific property and date range..
Endpoint: /reports/:property_id/:date_range/:metric
Parameters: dimension, filter, sort, limit, offset, totals, include_empty_rows, include_totals, segment, metadata, user_segment, result_format
Method: GET
Description: Returns a list of analytics data for a specific property and date range..
Endpoint: /reports/:property_id/:date_range/:metric/:dimension
Parameters: filter, sort, limit, offset, totals, include_empty_rows, include_totals, segment, metadata, user_segment, result_format
Method: GET
Description: Returns a list of analytics data for a specific property and date range..
Endpoint: /reports/:property_id/:date_range/:metric/:dimension/:filter
Parameters: sort, limit, offset, totals, include_empty_rows, include_totals, segment, metadata, user_segment, result_format
Method: GET
Description: Returns a list of analytics data for a specific property and date range..
Endpoint: /reports/:property_id/:date_range/:metric/:dimension/:filter/:sort
Parameters: limit, offset, totals, include_empty_rows, include_totals, segment, metadata, user_segment, result_format
Method: GET
Description: Returns a list of analytics data for a specific property and date range..
Endpoint: /reports/:property_id/:date_range/:metric/:dimension/:filter/:sort/:limit
Parameters: offset, totals, include_empty_rows, include_totals, segment, metadata, user_segment, result_format
Method: GET
Description: Returns a list of analytics data for a specific property and date range..
Endpoint: /reports/:property_id/:date_range/:metric/:dimension/:filter/:sort/:limit/:offset
Parameters: totals, include_empty_rows, include_totals, segment, metadata, user_segment, result_format
Method: GET
Description: Returns a list of dimensions..
Endpoint: /dimensions
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of dimensions for a specific property..
Endpoint: /dimensions/:property_id
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of dimensions for a specific property and category..
Endpoint: /dimensions/:property_id/:dimension_category
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of metrics..
Endpoint: /metrics
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of metrics for a specific property..
Endpoint: /metrics/:property_id
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of metrics for a specific property and category..
Endpoint: /metrics/:property_id/:metric_category
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of segments..
Endpoint: /segments
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of segments for a specific property..
Endpoint: /segments/:property_id
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of segments for a specific property and type..
Endpoint: /segments/:property_id/:segment_type
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of properties..
Endpoint: /
Parameters: limit, offset, sort
Method: GET
Description: Returns a list of properties for a specific parent property..
Endpoint: /:parent_property_id
Parameters: limit, offset, sort
Method: GET
Description: Returns a test..
Endpoint: /:test_id
Parameters: test_name
Method: POST
Description: Creates a new test..
Endpoint: /
Parameters: test_name, disable_auto_pause, traffic_allocation, exclusion_groups, placement_targeting, web_property_id, test_experience, status, mobile_web_property_id, web_property_name, mobile_web_property_name
Method: PUT
Description: Updates a test..
Endpoint: /:test_id
Parameters: test_name, disable_auto_pause, traffic_allocation, exclusion_groups, placement_targeting, web_property_id, test_experience, status, mobile_web_property_id, web_property_name, mobile_web_property_name
Method: DELETE
Description: Deletes a test..
Endpoint: /:test_id
Parameters:
Method: GET
Description: Returns a list of tests..
Endpoint: /
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of tests for a specific property..
Endpoint: /:property_id
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of tests for a specific property and type..
Endpoint: /:property_id/:test_type
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of test experiences..
Endpoint: /
Parameters: filter, limit, offset, sort
Method: GET
Description: Returns a list of test experiences for a specific test..
Endpoint: /:test_id
Parameters: filter, limit, offset, sort
FAQ
How do I get started with the Adobe Analytics APIs?
To get started with the Adobe Analytics APIs, you will need to sign up for a developer account and create a project. You will also need to obtain a client ID and client secret for authentication.
What are the rate limits for the Adobe Analytics APIs?
The rate limits for the Adobe Analytics APIs vary depending on the API method. You can find the rate limits for each API method in the API documentation.
How do I authenticate to the Adobe Analytics APIs?
You can authenticate to the Adobe Analytics APIs using OAuth 2.0. To do this, you will need to obtain a client ID and client secret from your developer account.
How do I access the Adobe Analytics APIs in a sandbox environment?
To access the Adobe Analytics APIs in a sandbox environment, you will need to create a sandbox account. You can create a sandbox account from your developer account.
How can I get help with the Adobe Analytics APIs?
You can get help with the Adobe Analytics APIs by visiting the Adobe Analytics API documentation or by posting a question on the Adobe Analytics API forum.