Sign in

v1

latestSwagger 2.02026-07-175658186.8 KB
Annotations

Create new annotation

post/{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.

localestring

Locale

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.

Request body

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

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