Analytics Dimensions API

The Analytics 2.0 Dimensions API endpoints allow you to retrieve Dimensions programmatically through Adobe Developer. The 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.

For information dimension attribution models, 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 dimensions: 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

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}"

[
  {
    "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:

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:

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

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}"

{
  "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:

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.