Retrieve multiple calculated metrics
Changed onA 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
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
Comma-delimited list of additional calculated metric metadata fields to include in response.
Include additional calculated metrics not owned by user. The "all" option takes precedence over "shared"
Filter list to only include calculated metrics tied to a specified dataview ID list (comma-delimited)
Filter list to only include calculated metrics owned by the specified loginId
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
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.
Locale
Filter list to only include calculated metrics that are favorites
Filter list to only include calculated metrics that are approved
return paginated results
Number of results per page
Page number (base 0 - first page is "0")
Sort direction (ASC or DESC)
Property to sort by (name, modified_date, ID is currently allowed)
Headers
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.
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.
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
Changes
- breaking
removed the enum value
reportSuiteNamefrom the propertyitems/of thequeryrequest parameterexpansion - warning
removed the optional property
/from the response with the status
- breaking
- breaking
added the new required
headerrequest parameterAuthorization - breaking
added the new required
headerrequest parameterx-api-key - breaking
added the new required
headerrequest parameterx-gw-ims-org-id
- breaking