Metrics API

Retrieve metric by dataview ID

Changed on

Retrieves a specific metric for a specified dataview

get/data/dataviews/{dataviewId}/metrics/{metricId}

Request

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

Path parameters

dataviewIdstring required

The dataview ID associated with the metric

metricIdstring required

The metric ID to retrieve. Note: remove "metrics/" from the ID. For example "visitors", not "metrics/visitors".

Query parameters

localestring

Locale

expansionstring[]

Comma-delimited list of additional fields to include on response.

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

idstring
namestring
descriptionstring
sourceFieldIdstring
sourceFieldNamestring
storageIdstring
dataSetIdsstring[]
dataSetType'EVENT' | 'LOOKUP' | 'PROFILE'
schemaTypestring
sourceFieldTypestring
tableNamestring
type'STRING' | 'BOOLEAN' | 'INT' | 'DECIMAL' | 'CURRENCY' | 'PERCENT' | 'TIME' | 'ENUM' | 'ORDERED_ENUM'
requiredboolean
hideFromReportingboolean
schemaPathstring
hasDataboolean
segmentableboolean
favoriteboolean
approvedboolean
tagsobject[]
sharesobject[]
usageSummaryobject
notFoundboolean
hiddenboolean
fromGlobalLookupboolean
multiValuedboolean
countType'instances' | 'values'
precisioninteger
isDeletedboolean

Changes

  • 451e9905bec7Revision changes
    • 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