Sign in

v1

latestSwagger 2.02026-07-175658186.8 KB
Annotations

Retrieve all annotations.

get/{globalCompanyId}/annotations

Path parameters

globalCompanyIdstring required

The Global Company ID for the Adobe Analytics organization

Query parameters

expansionstring[]

Comma-delimited list of additional annotation metadata fields to include on response.

includeTypestring[]

Include additional annotations not owned by user. The "all" option takes precedence over "shared"

localestring

Locale

filterByIdsstring
filterByModifiedAfterstring

Filter list to only include annotations modified since this date (ISO8601 format)

filterByDateRangestring

Filter list to only include annotations in the specified date range with format yyyy-MM-dd'T'HH:mm:ss/yyyy-MM-dd'T'hh:MM:ss

limitinteger

Number of results per page

pageinteger

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

sortDirectioninteger

Sort direction (ASC or DESC

sortPropertystring

Property to sort by (name, modified_date, id is currently allowed)

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

idstring
namestring
descriptionstring
dateRangestring
color'STANDARD1' | 'STANDARD2' | 'STANDARD3' | 'STANDARD4' | 'STANDARD5' | 'STANDARD6' | 'STANDARD7' | 'STANDARD8' | 'STANDARD9'
applyToAllReportsboolean
createdDatestring date-time
modifiedDatestring date-time
modifiedByIdstring
tagsobject[]
sharesobject[]
approvedboolean
favoriteboolean
usageSummaryobject
systemUserOwnedboolean
companyIdinteger
reportSuiteNamestring
rsidstring
All 56 operations