Reporting API

Retrieve a top items dimension report

Changed on

Retrieves the top items (based on paging restriction) for the specified dimension and Data ID. Defaults to last 90 days.

Search Clause examples: contains test: 'test'

contains test or test1: 'test' OR 'test1'

contains test and test1: 'test' AND 'test1'

contains test and not (test1 or test2): 'test' AND NOT ('test1' OR 'test2')

does not contain test: NOT 'test'

get/reports/topItems

Request

  • Base URL: https://cja.adobe.io
  • URL: https://cja.adobe.io/reports/topItems
  • Auth: none declared. Required headers: Authorization, x-api-key, x-gw-ims-org-id

Query parameters

dataIdstring required

Data Group or Data View to run the report against

dimensionstring required

Dimension to run the report against. Example: "variables/page"

localestring

Locale

dateRangestring

Format: YYYY-MM-DD/YYYY-MM-DD

search-clausestring

General search string; wrap with single quotes. Example: 'PageABC'

startDatestring

Format: YYYY-MM-DD

endDatestring

Format: YYYY-MM-DD

searchAndstring

Search terms that will be AND-ed together. Space delimited.

searchOrstring

Search terms that will be OR-ed together. Space delimited.

searchNotstring

Search terms that will be treated as NOT including. Space delimited.

searchPhrasestring

A full search phrase that will be searched for.

includeOberonXmltrue | false

Controls if Oberon XML should be returned in the response - DEBUG ONLY

lookupNoneValuestrue | false

Controls None values to be included

limitinteger

Number of results per page

pageinteger

Page number (base 0 - first page is "0")

Headers

Authorizationstring required

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-keystring required

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-idstring required

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Response

Successful operation

totalPagesinteger
firstPageboolean
lastPageboolean
numberOfElementsinteger
numberinteger
totalElementsinteger
messagestring
reportIdstring
searchAndstring
searchOrstring
searchNotstring
searchPhrasestring
oberonRequestXMLstring
oberonResponseXMLstring

Changes

  • 451e9905bec7Revision changes
    • breaking

      added the new required header request parameter Authorization

    • breaking

      added the new required header request parameter x-api-key

    • breaking

      added the new required header request parameter x-gw-ims-org-id