Calculated Metrics API

Validate calculated metric

Changed on

Validates a calculated metric definition

post/calculatedmetrics/validate

Request

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

Query parameters

localestring

Locale

migratingboolean

Include migration functions in validation

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.

Request body

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

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

    • warning

      removed the request property

    • 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