Reporting API

The Customer Journey Analytics Reporting API allows you to create and retrieve reports programmatically. These APIs use the same data and methods that Adobe uses inside the product UI. See Reports in the Customer Journey Analytics guide for more information.

This guide includes instructions for using the following endpoints:

GET top items report: Retrieves top items for a specified dimension
POST create dataview reports: Creates a report for an existing dataview

Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning. Adobe recommends that you refer to the API documentation of any third-party tool you integrate with our APIs so that such additions are ignored in processing if not understood. If implemented properly, such additions are non-breaking changes for your implementation. Adobe will not remove parameters or add required parameters without first providing standard notification through release notes.

Get top items report

Use this endpoint to retrieve the top items for a specific dimension. This returns only the top items from the report, according to the maximum number of items you want returned, ranked by the specified metric.

GET https://cja.adobe.io/reports/topItems

Example request

Request

curl -X GET "https://cja.adobe.io/reports/topItems?limit=5&page=0&lookupNoneValues=true&dataId=dv_554445545&dimension=pages" \
  -H "accept: application/json" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"
Copied to your clipboard
curl -X GET "https://cja.adobe.io/reports/topItems?limit=5&page=0&lookupNoneValues=true&dataId=dv_554445545&dimension=pages" \
  -H "accept: application/json" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

Example response

Response

{
  "totalPages": 1,
  "firstPage": true,
  "lastPage": true,
  "numberOfElements": 5,
  "number": 0,
  "totalElements": 5,
  "columns": {
    "dimension": {
      "id": "variables/page",
      "type": "string"
    },
    "columnIds": [
      "0"
    ]
  },
  "rows": [
    {
      "itemId": "3306266643",
      "value": "home",
      "data": [
        219567
      ]
    },
    {
      "itemId": "2796092754",
      "value": "category 5", 
      "data": [
        90943
      ]
    },
    {
      "itemId": "1738577623",
      "value": "category 2",
      "data": [
        84192
      ]
    }
  ],
  "summaryData": {
    "filteredTotals": [
      3080619
    ],
    "totals": [
      3080619
    ]
  }
}
Copied to your clipboard
{
  "totalPages": 1,
  "firstPage": true,
  "lastPage": true,
  "numberOfElements": 5,
  "number": 0,
  "totalElements": 5,
  "columns": {
    "dimension": {
      "id": "variables/page",
      "type": "string"
    },
    "columnIds": [
      "0"
    ]
  },
  "rows": [
    {
      "itemId": "3306266643",
      "value": "home",
      "data": [
        219567
      ]
    },
    {
      "itemId": "2796092754",
      "value": "category 5", 
      "data": [
        90943
      ]
    },
    {
      "itemId": "1738577623",
      "value": "category 2",
      "data": [
        84192
      ]
    }
  ],
  "summaryData": {
    "filteredTotals": [
      3080619
    ],
    "totals": [
      3080619
    ]
  }
}

Request parameters

The following table describes the request parameters for the GET /reports/topItems endpoint:

Parameter	Required	Type	Description
`dataId`	Required	String	Data view ID. That data view in the example above is `dv_554445545`.
`dimension`	Required	String	The dimension to retreive top items for. The dimension in the example above is `pages`.
`locale`	Optional	String	Language and country code. The language in the example above is `en_US`.
`lookupNoneValues`	Optional	Boolean	Whether to include None values in the report. Default is `false`
`limit`	Optional	Integer	Number of top items to return. Default is 10. Maximum is 1000
`page`	Optional	Integer	Page number (0-based). Default is 0

Response parameters

The following table describes the response parameters for the GET /reports/topItems endpoint:

Parameter	Type	Description
`totalPages`	Integer	The total number of pages with data
`firstPage`	Boolean	Whether this is the first page of results
`lastPage`	Boolean	Whether this is the last page of results
`numberOfElements`	Integer	The number of item elements in the report
`number`	Integer	The page number, starting with `0`
`totalElements`	Integer	Total number of elements in the report
`columns`	Object	Contains column and `dimension` data
`dimension`	Object	Contains `id` and `type`
`rows`	Array	Contains `itemId`, `value` and `data`
`itemId`	String	The item ID
`value`	String	The name specified for the `itemId` in the report
`data`	Array	The numerical values returned for the requested items
`summaryData`	Object	Contains the summary data totals

Usage notes and limitations

Consider the following when working with the Reports API:

Rate limiting

The Reports API enforces rate limits to ensure optimal performance:

Requests per minute: 60 requests per minute per organization
Concurrent requests: Maximum 6 concurrent requests per organization

Report execution limits

Data range: Maximum 18 months of data per request
Dimension items: Maximum 1000 dimension items per request
Metrics: Maximum 20 metrics per report
Execution time: Report execution timeout is 300 seconds

Best practices

Cache report results when possible to reduce API calls
Use pagination for large result sets
Implement retry logic with exponential backoff for rate-limited requests
Use the topItems endpoint for quick dimension analysis without metrics
Use appropriate date ranges to avoid large data requests

For more information on CJA Reports APIs, see the CJA API reference.

Post create dataview reports

Use this endpoint to create report requests and return data for an existing data view. This corresponds to creating a visualization in the CJA Analysis Workspace UI.

POST https://cja.adobe.io/reports