Dimensions API

The CJA Dimensions APIs allow you to retrieve dimensions programmatically through Adobe Developer. These APIs use the same data and methods that Adobe uses inside the product UI. See Dimensions in the Customer Journey Analytics guide for more information.

The endpoints described in this guide are routed through analytics.adobe.io. To use them, you will need to first create a client with access to Customer Journey Analytics APIs. For more information, refer to Getting started with the Customer Journey Analytics API.

Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning. Adobe recommends that you refer to the API documentation of any third-party tool you integrate with our APIs so that such additions are ignored in processing if not understood. If implemented properly, such additions are non-breaking changes for your implementation. Adobe will not remove parameters or add required parameters without first providing standard notification through release notes.

This guide includes instructions for using the following endpoints:

GET multiple dimensions: Retrieves a list of metrics for a specified dataview ID
GET a single dimension: Retrieves information for a single metric from a dataview

Retrieve multiple dimensions

Use this endpoint to retrieve a list of dimensions for a specified dataview ID

GET https://cja.adobe.io/data/dataviews/{dataviewId}/dimensions

Request and response examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

Request

Response

curl -X GET "https://cja.adobe.io/data/dataviews/{DATAVIEW_ID}/dimensions?includeType=shared" \
    -H "x-api-key: {CLIENT_ID}" \
    -H "x-gw-ims-org-id: {IMS_ORG_ID}" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
Copied to your clipboard
curl -X GET "https://cja.adobe.io/data/dataviews/{DATAVIEW_ID}/dimensions?includeType=shared" \
    -H "x-api-key: {CLIENT_ID}" \
    -H "x-gw-ims-org-id: {IMS_ORG_ID}" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"

{
    "content": [
        {
            "id": "variables/daterangeweek",
            "name": "Week"
        },
        {
            "id": "variables/daterangemonth",
            "name": "Month"
        },
        {
            "id": "variables/daterangefifteenminute",
            "name": "15 Minute"
        },
        {
            "id": "variables/daterangehour",
            "name": "Hour"
        },
        {
            "id": "variables/daterangeyear",
            "name": "Year"
        },
        {
            "id": "variables/daterangeday",
            "name": "Day"
        }
    ],
    "totalElements": 6,
    "totalPages": 1,
    "number": 0,
    "numberOfElements": 6,
    "firstPage": true,
    "lastPage": true,
    "sort": null,
    "size": 6
}
Copied to your clipboard
{
    "content": [
        {
            "id": "variables/daterangeweek",
            "name": "Week"
        },
        {
            "id": "variables/daterangemonth",
            "name": "Month"
        },
        {
            "id": "variables/daterangefifteenminute",
            "name": "15 Minute"
        },
        {
            "id": "variables/daterangehour",
            "name": "Hour"
        },
        {
            "id": "variables/daterangeyear",
            "name": "Year"
        },
        {
            "id": "variables/daterangeday",
            "name": "Day"
        }
    ],
    "totalElements": 6,
    "totalPages": 1,
    "number": 0,
    "numberOfElements": 6,
    "firstPage": true,
    "lastPage": true,
    "sort": null,
    "size": 6
}

Request example details

The above example request shows a request that includes a required dataviewId in the path. It also includes a query parameter for includeType values that are shared.

Response example details

The above example shows the ID and name of six dimensions for a specified dataview.

Request parameters

The GET multiple dimensions endpoints includes one request path parameter (dataviewId) and three optional query parameters, as shown below:

Parameter	Req/Opt	Type	Description
`dataviewId`	required	string	The ID of the dataview containing the dimension
`includeType`	optional	array of strings	A comma-delimited list of include types
`locale`	optional	string	The language to use in the response
`expansion`	optional	array of strings	A comma-delimited list of additional fields to include in the response. For a complete list of these fields see the reference.

Response parameters

The Retrieve multiple dimensions endpoint includes the following response parameters:

Parameter	Type	Description
`id`	string	Dimension ID
`name`	string	Dimension name
`description`	string	Contents of dimension description field in report
`sourceFieldId`	string	ID of source field
`sourceFieldName`	string	Name of source field
`storageId`	string	ID of storage
`dataSetIds`	array of strings	Lists the ID for each dataset returned
`dataSetType`	array of strings	One of three `enum` dataset types: `EVENT`, `LOOKUP`, or `PROFILE`
`schemaType`	string	Type of schema
`sourceFieldType`	string	Type of source field
`tableName`	string	Name of table
`type`	string	Dimension data type that is listed as an `enum` of one of the following: `string`, `boolean`, `int`, `decimal`, `currency`, `percent`, `time`, `enum`, and `ordered_enum`.
`required`	boolean	Whether it is required
`hideFromReporting`	boolean	Whether the dimension is hidden in reports
`schemaPath`	string	Path of schema
`hasData`	boolean	Whether the dimension contains data
`segmentable`	boolean	Whether the dimension is segmentable
`favorite`	boolean	Whether the dimension is tagged as a favorite
`approved`	boolean	Whether the dimension is approved
`tags`	array of objects	Contains `property` objects that contain data associated with the dimension. For example, `property1`, `property2`, etc. each contain data in key-value pairs for the dimension.
`shares`	array of objects	Contains `property` objects that contain data associated with the dimension. For example, `property1`, `property2`, etc. each contain data in key-value pairs for the dimension.
`usageSummary`	array of objects	Contains `property` objects that contain data associated with the dimension. For example, `property1`, `property2`, etc. each contain data in key-value pairs for the dimension.
`notFound`	boolean	Whether the dimension is found
`hidden`	boolean	Whether the dimension is hidden
`fromGlobalLookup`	boolean	Whether the dimension is sourced from global lookup
`multiValued`	boolean	Whether the dimension has multiple values
`includeExcludeSetting`	object	Shows settings specified for dimension retrieval. This includes the following: `caseSensitive`, `match`, `type`, `rules` and `enabled`. These settings are described in the following rows.
`caseSensitive`	boolean	Whether the dimension is queried as case sensitive. This is contained in the `includeExcludeSetting` response object.
`match`	string	The logical operator specified: `and`, or `or` (both type `enum`). This is contained in the `includeExcludeSetting` response object.
`type`	string	The type specified: `string`, `numeric` or `date` (all type `enum`). This is contained in the `includeExcludeSetting` response object.
`rules`	array of objects	Contains the rules specified for the query: This includes `string` and `value` (both type `string`). This is contained in the `includeExcludeSetting` response object.
`enabled`	boolean	Whether the query specifies that the dimension is enabled. This is contained in the `includeExcludeSetting` response object.
`fieldDefinition`	array of objects	Shows field definitions for `func`, `id`, `field`, `label`, `branches`, `oberon-storage-type`, `oberon-table`, `oberon-field`, `oberon-storage-id`, `case-sensitive`, and `mapped-type`. These definitions are described in the following rows.
`func`	string	The function of the field, including options: `raw_field`, `match` or `floor` (all type `enum`). This is contained in the `fieldDefinition` response object.
`id`	string	The ID of the field. This is contained in the `fieldDefinition` response object.
`field`	string	The field associated with the `fieldDefinition`. This is contained in the `fieldDefinition` response object.
`label`	string	The label. This is contained in the `fieldDefinition` response object.
`branches`	array of objects	Shows branches for `pred` and `map-to`. This is contained in the `fieldDefinition` response object. For the complete data model on `pred` objects and parameters, see the CJA Dimensions API reference.
`oberon-storage-type`	string	The type used in oberon storage. This is contained in the `fieldDefinition` response object.
`oberon-table`	string	The table used in oberon. This is contained in the `fieldDefinition` response object.
`oberon-field`	string	The field in oberon. This is contained in the `fieldDefinition` response object.
`oberon-storage-id`	string	The ID associated with oberon storage. This is contained in the `fieldDefinition` response object.
`case-sensitive`	boolean	Whether the `fieldDefinition` is case-sensitive. This is contained in the `fieldDefinition` response object.
`mapped-type`	string	The type used for mapping. This is contained in the `fieldDefinition` response object.
`bucketingSetting`	object	The setting used for bucketing, including options `bucketSetting` and `enabled`. For the complete data model on these settings, see the CJA Dimensions API reference.
`noValueOptionsSetting`	object	The options setting used for dimensions with no value, including `option` and `value`
`defaultDimensionSort`	boolean	Whether sorting of dimensions is set for default
`persistenceSetting`	object	The settings for persistence, including `enabled`, `allocationModel`, and `lookback`. For the complete data model on these settings, see the CJA Dimensions API reference.
`isDeleted`	boolean	Whether the dimension is deleted

Retrieve a single dimension

You can retrieve details of a single dimension if you know the dimension ID. You can find the dimension ID by using the multiple dimensions endpoint.

Use this endpoint to retrieve a single dimension.

GET https://cja.adobe.io/data/dataviews/{DATAVIEW_ID}/dimensions/{dimensionId}