Sign in
Metrics

Retrieve metrics for a report suite

This returns the metrics list primarily for the Analytics product. The platform identity API Returns a list of all possible metrics for the supported systems.

get/{globalCompanyId}/metrics

Path parameters

globalCompanyIdstring required

The Global Company ID for the Adobe Analytics organization

Query parameters

rsidstring required

ID of desired report suite

localestring

Locale that system named metrics should be returned in

segmentableboolean

Filter the metrics by if they are valid in a segment.

expansionstring[]

Add extra metadata to items (comma-delimited list)

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
titlestring
namestring
type'STRING' | 'INT' | 'DECIMAL' | 'CURRENCY' | 'PERCENT' | 'TIME' | 'ENUM' | 'ORDERED_ENUM'
extraTitleInfostring
categorystring
categoriesstring[]
supportstring[]
allocationboolean
precisioninteger
calculatedboolean
segmentableboolean
descriptionstring
polarity'positive' | 'negative'
helpLinkstring
allowedForReportingboolean

Changes

Changed in 3 of the 9 revisions of this API.21