v1

latestSwagger 2.02026-07-175658186.8 KB

Calculated Metrics

Retrieve multiple calculated metrics

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

Path parameters

globalCompanyIdstring required

The Global Company ID for the Adobe Analytics organization

Query parameters

rsidsstring

Filter list to only include calculated metrics tied to specified RSID list (comma-delimited)

ownerIdinteger

Filter list to only include calculated metrics owned by the specified loginId

filterByIdsstring

Filter list to only include calculated metrics in the specified list (comma-delimited list of IDs) (this is the same as calculatedMetricFilter, and is overwritten by calculatedMetricFilter

toBeUsedInRsidstring

The report suite where the calculated metric intended to be used. This report suite will be used to determine things like compatibility and permissions. If it is not specified then the permissions will be calculated based on the union of all metrics authorized in all groups the user belongs to. If the compatibility expansion is specified and toBeUsedInRsid is not then the compatibility returned is based off the compatibility from the last time the calculated metric was saved.

localestring

Locale

namestring

Filter list to only include calculated metrics that contains the Name

tagNamesstring

Filter list to only include calculated metrics that contains one of the tags

favoriteboolean

Filter list to only include calculated metrics that are favorites

approvedboolean

Filter list to only include calculated metrics that are approved

limitinteger

Number of results per page

pageinteger

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

sortDirectionstring

Sort direction (ASC or DESC)

sortPropertystring

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

expansionstring[]

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

includeTypestring[]

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

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

System generated id

namestring

descriptionstring

rsidstring

The report suite id for which the component was created/updated

reportSuiteNamestring

The report suite name for which the component was created/updated

polarity'positive' | 'negative'

Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive

precisioninteger

Number of decimal places to include in calculated metric result

type'CURRENCY' | 'TIME' | 'DECIMAL' | 'PERCENT'

definitionCalculatedMetricDef required

categoriesstring[]

siteTitlestring

modifiedstring date-time

createdstring date-time

Calculated metric creation date