Calculated Metrics API

Retrieve multiple calculated metrics

Changed on

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

For more information, see the Calculated metrics overview

get/calculatedmetrics

Request

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

Query parameters

expansionstring[]

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

includeTypestring[]

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

dataIdsstring

Filter list to only include calculated metrics tied to a specified dataview ID list (comma-delimited)

ownerIdstring

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 dataview 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

favoriteboolean

Filter list to only include calculated metrics that are favorites

approvedboolean

Filter list to only include calculated metrics that are approved

pagination'true' | 'false'

return paginated results

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)

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, indicating whether it's desirable or undesirable 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

    • 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

    • breaking

      added the new required header request parameter Authorization

    • breaking

      added the new required header request parameter x-api-key

    • breaking

      added the new required header request parameter x-gw-ims-org-id