Analytics Dimensions API

The Analytics 2.0 Dimensions API endpoints allow you to retrieve Dimensions programmatically through Adobe Developer.

The Dimensions endpoints use the same data and methods that are used when working with Dimensions in the UI. See Dimensions in the Analytics Components guide for more information. This guide describes the object members for the Dimension API except those used for retrieving attribution models. For more information, see the Dimension API attribution models guide.

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 the Adobe Analytics Reporting API. For more information, refer to Getting started with the Analytics API.

This guide includes instructions for using the following endpoints:

GET multiple dimensions: Returns a list of dimensions for a given report suite ID
GET a single dimension: Returns a dimension corresponding to a supplied ID for a given report suite

GET multiple dimensions

Use this endpoint to return a list of dimensions for a given report suite ID.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/dimensions?rsid={RSID}

You can find your global company ID by using the Discovery API.

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.

              data-slots=heading, code

            

              data-repeat=2

            

              data-languages=CURL,JSON

            

              Request
            

              curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/dimensions?rsid=examplersid&locale=en_US&segmentable=true&reportable=true&classifiable=true&expansion=categories" \
    -H "x-api-key: {CLIENT_ID}" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"

            

              Response
            

              [
  {
    "id": "variables/campaign",
    "title": "Tracking Code",
    "name": "Tracking Code",
    "type": "string",
    "category": "Traffic Sources",
    "categories": [],
    "support": [
      "dataWarehouse",
      "oberon"
    ],
    "pathable": false,
    "segmentable": true,
    "reportable": [
      "oberon"
    ],
    "supportsDataGovernance": true,
    "multiValued": false,
    "standardComponent": true
  },
  {
    "id": "variables/clickmaplink",
    "title": "Activity Map Link",
    "name": "Activity Map Link",
    "type": "string",
    "category": "ClickMap",
    "categories": [
      "Activity Map"
    ],
    "support": [
      "oberon",
      "dataWarehouse"
    ],
    "pathable": false,
    "segmentable": true,
    "reportable": [
      "oberon"
    ],
    "supportsDataGovernance": true,
    "dataGroup": "clickmap",
    "multiValued": false
  },
]

            

Request example details

The above example requests the following details:

The GET dimensions list for the examplersid report suite.
Specifies the response language in locale as US English with the value en_US.
The values for the segmentable, reportable, and classifiable parameters.
Information for expansion parameter categories.

Request parameters

The GET dimensions endpoint includes the following request query parameters:

Parameter

Req/Opt

Type

Description

rsid

required

string

report suite ID

locale

optional

string

The specified language

segmentable

optional

boolean

Whether to include only dimensions that are valid within a segment

reportable

optional

boolean

Whether to include only dimensions that are valid within the report

classifiable

optional

boolean

Whether to include only classifiable dimensions

expansion

optional

array (string)

A comma-delimited list of additional metadata to items, including tags, allowedForReporting, attributionModel, categories, allocationType, expirationType, expirationCustomDays, dataType, bindingEvents, and merchandisingSyntax

Response example details

The JSON response example above shows the following details:

Information for two classifiable dimensions in the examplersid report suite, including campaign and clickmaplink.
The title and name values for each dimension.
Both dimensions have the same data type, set as string.
The dimensions differ in category. The category for campaign is Traffic Sources. The category for clickmaplink is ClickMap.
Both dimensions are reportable in oberon. Both are also segmentable.
The dimension campaign does not have any categories associated with it, but the clickmaplink dimension is associated with Activity Map.

Response parameters

The GET dimensions endpoint includes the following response parameters:

Parameter

Type

Description

id

string

Dimension ID

title

string

Dimension title

name

string

Dimension name

type

array of enums

Lists the data type of the dimension

category

string

Product category

categories

array (string)

Product categories. An extra metadata item in response to the expansion request parameter.

support

string

Support information

pathable

boolean

Whether the report/dimension is pathing enabled

parent

string

Parent dimension

extraTitleInfo

string

Additional title info

segmentable

boolean

Whether the dimension is segmentable

reportable

array (string)

Whether the dimension is reportable

description

string

Contents of dimension description field in report

allowedForReporting

boolean

Whether the dimension is set to be allowed for reporting. An extra metadata item in response to the expansion request parameter.

attributionModel

string

For a list of attribution models, see Attribution models and lookback windows. See the Dimension API attribution models guide for a complete description.

noneSettings

boolean

Whether "none" item report setting is set.

tags

object

An extra metadata item in response to the expansion request parameter. This can include the tag ID, tag name, tag description, and a list of components associated the tag.

Additional eVar configuration fields are described in eVar configuration expansions below.

eVar configuration expansions

The following response fields describe an eVar's allocation, expiration, and merchandising configuration. Each is requested through the expansion parameter and is populated only for eVar dimensions. For attribution model details, see the Dimension API attribution models guide.

Parameter

Type

Allowed values

Description

allocationType

string

most_recent_last, original_value_first, linear, linear_to_items, merchandising_first, merchandising_last

The configured allocation type for the eVar. Preserves distinctions that attributionModel.func collapses.

expirationType

string

visit, page_view, never, minute, hour, day, week, month, quarter, year, purchase, product_view, cart_open, cart_checkout, cart_add, cart_remove, cart_view, event

The configured expiration type for the eVar, determining how long the value persists.

expirationCustomDays

integer

—

Number of days in the expiration window. Meaningful when expirationType is day.

dataType

string

text, counter

The eVar storage type.

bindingEvents

array (string)

—

Metric IDs that trigger merchandising binding. Populated only for merchandising eVars configured with event triggers.

merchandisingSyntax

string

product, conversion_variable

Merchandising binding style. Populated only for merchandising eVars.

ecomAllocationType

string

first, last, merchandising

High-level allocation bucket. Returned automatically when attributionModel is requested; it does not have its own expansion flag.

These fields describe the eVar configuration and are distinct from the attributionModel object: allocationType differs from attributionModel.func, and expirationType differs from attributionModel.expiration. See the Dimension API attribution models guide for the attributionModel object.

The following example shows these fields for an eVar dimension:

{
  "id": "variables/evar1",
  "title": "Campaign Code",
  "name": "Campaign Code",
  "type": "string",
  "category": "Conversion",
  "dataType": "text",
  "allocationType": "linear",
  "ecomAllocationType": "last",
  "expirationType": "visit",
  "expirationCustomDays": null,
  "bindingEvents": [],
  "merchandisingSyntax": null,
  "attributionModel": {
    "func": "allocation-lastTouch_dim"
  }
}

GET a single dimension

Use this endpoint to retrieve information for a specified dimension in a report suite.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/dimensions/{DIMENSION_ID}?rsid={RSID}

Request and response examples

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

              data-slots=heading, code

            

              data-repeat=2

            

              data-languages=CURL,JSON

            

              Request
            

              curl -X GET "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/dimensions/clickmaplink?rsid=examplersid&locale=en_US&expansion=allowedForReporting" \
    -H "x-api-key: {CLIENT_ID}" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"

            

              Response
            

              {
  "id": "variables/clickmaplink",
  "title": "Activity Map Link",
  "name": "Activity Map Link",
  "type": "string",
  "category": "ClickMap",
  "support": [
    "oberon",
    "dataWarehouse"
  ],
  "pathable": false,
  "segmentable": true,
  "reportable": [
    "oberon"
  ],
  "supportsDataGovernance": true,
  "dataGroup": "clickmap",
  "allowedForReporting": true,
  "multiValued": false
}

            

Request example details

The above example requests the following details:

The dimensions information with the clickmaplink ID in the examplersid report suite.
Specifies the response language in locale as US English with the value en_US.
Information on whether the dimension is allowedForReporting.

Request parameters

The GET dimensions ID endpoint includes the following request query parameters:

Parameter

Req/Opt

Type

Description

id

required

string

Dimension ID (e.g. evar1)

rsid

required

string

Report suite ID

locale

optional

string

The specified language

expansion

optional

array (string)

Response example details

The above JSON response example shows the following clickmaplink dimension details for the examplersid report suite:

Standard response details for the dimension, including the information that it is reportable to the oberon tool.
The dimension is allowed for reporting as indicated by allowedForReporting: true.

Response parameters

The GET dimensions ID endpoint includes the same response parameters as the GET dimensions response parameters, as described above.

For more information on the Dimensions API endpoints, see the Adobe Analytics 2.0 API Reference.