Calculated Metrics API

Retrieve a calculated metric by ID

Changed on

A calculated metric response includes these items: ID, name, description, dataview ID, owner, polarity, precision, and 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
  • tags: Gives all existing tags associated with the calculated metric

For more information, see the Calculated metrics overview

get/calculatedmetrics/{id}

Request

  • Base URL: https://cja.adobe.io
  • URL: https://cja.adobe.io/calculatedmetrics/{id}
  • Auth: none declared. Required headers: Authorization, x-api-key, x-gw-ims-org-id

Path parameters

idstring required

The calculated metric ID to retrieve

Query parameters

expansionstring[]

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

includeHiddenboolean

Whether to include variables hidden in the UI or that are not permitted for the user

toBeUsedInRsidstring

The dataview ID to be associated with the calculated metric. The dataview is used to determine compatibility and permissions. If not specified, the permissions are 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, the compatibility returned is based on the compatibility from the last time the calculated metric was saved.

localestring

Locale

Headers

Authorizationstring required

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-keystring required

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-idstring required

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Response

Successful operation

rsidstring
dataIdstring
dataNamestring
idstring
namestring
descriptionstring
isDeletedboolean
migratedIdsstring[]
internalboolean
ownerobject
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'
definitionobject required

Calculated metric definition object

legacyIdstring
templateboolean
dataGroupstring
solutionboolean
curatedItemboolean
categoriesstring[]
reportTimeAttributionboolean
tagsobject[]
sharesobject[]
approvedboolean
favoriteboolean
usageSummaryobject
siteTitlestring
modifiedstring date-time

Changes

  • f3c3a0000bd2Revision changes
    • info

      added the enum value usedIn to the property items/ of the query request parameter expansion

  • 01853ba09619Revision changes
    • breaking

      removed the enum value reportSuiteName from the property items/ of the query request parameter expansion

    • warning

      removed the optional property from the response with the status