v1

latestSwagger 2.02026-07-175658186.8 KB
Calculated Metrics

Create a new calculated metric

Creates a new calculated metric. The following attributes are available when creating a calculated metric:

IMPORTANT: Required Fields: name, definition, rsid

Optional fields: description

Example definition for use in testing API below ("Visits per visitor"):


"definition": {
      "formula": {
        "func": "divide",
        "col1": {
          "func": "metric",
          "name": "metrics/visits",
          "description": "Visits"
        },
        "col2": {
          "func": "metric",
          "name": "metrics/visitors",
          "description": "Unique Visitors"
        }
      },
      "func": "calc-metric",
      "version": [
        1,
        0,
        0
      ]
    }

A calculated metric response will always include these default items:* id, name, description, rsid, owner*

Additional attributes can be optionally requested in the 'expansion' field as described in the GET calculated metrics section.

post/{globalCompanyId}/calculatedmetrics

Path parameters

globalCompanyIdstring required

The Global Company ID for the Adobe Analytics organization

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.

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

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