v1

latestSwagger 2.02026-07-175658186.8 KB

Calculated Metrics

Validate a calculated metric definition

post/{globalCompanyId}/calculatedmetrics/validate

Path parameters

globalCompanyIdstring required

The Global Company ID for the Adobe Analytics organization

Query parameters

localestring

Locale

migratingboolean

Include migration functions in validation

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

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

Response

successful operation