v1
latestSwagger 2.02026-07-175658186.8 KBCalculated Metrics
Retrieve a single calculated metric by ID
A calculated metric response will always include these default items: id, name, description, rsid, owner, polarity, precision, type
Other attributes can be optionally requested through the 'expansion' field:
- modified: Date that the metric was last modified (ISO 8601)
- definition: Calculated metric definition as JSON object
- compatibility: Products that the metric is compatible with
- reportSuiteName: Also return the friendly report suite name for the RSID
- tags: Gives all existing tags associated with the calculated metric
For more information, see the Calculated Metrics API endpoint guide
get/{globalCompanyId}/calculatedmetrics/{id}
Path parameters
globalCompanyIdstring required
The Global Company ID for the Adobe Analytics organization
idstring required
The calculated metric ID to retrieve
Query parameters
localestring
Locale
expansionstring[]
Comma-delimited list of additional calculated metric metadata fields to include on response.
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