v1

latestSwagger 2.02026-07-175658186.8 KB

Reports

Retrieve top items report

Get the top X items (based on paging restriction) for the specified dimension and rsid. Defaults to last 90 days.

get/{globalCompanyId}/reports/topItems

Path parameters

globalCompanyIdstring required

The Global Company ID for the Adobe Analytics organization

Query parameters

rsidstring required

ID of desired report suite ie. myrsid

dimensionstring required

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

localestring

Locale that system named metrics should be returned in

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.

lookupNoneValuesboolean

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 AA API client integration, prefixed with "Bearer ".

x-api-keystring required

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

Response

Successful operation

totalPagesinteger

firstPageboolean

lastPageboolean

numberOfElementsinteger

numberinteger

totalElementsinteger

messagestring

reportIdstring

searchAndstring

searchOrstring

searchNotstring

searchPhrasestring

oberonRequestXMLstring

oberonResponseXMLstring