Dimension API attribution models

The Analytics 2.0 Dimensions API supports an attributionModel expansion that returns the attribution model configuration for a given dimension. This includes the allocation model type, expiration settings, and context scope. You can request this expansion on both the GET multiple dimensions and GET single dimension endpoints.

The endpoints described in this guide are routed through analytics.adobe.io. To use them, you must first create a client with access to the Adobe Analytics Reporting API. For more information, see Getting started with the Analytics API.

• GET multiple dimensions with attribution model
• GET single dimension with attribution model
• Attribution model values

GET multiple dimensions with attribution model

Use this endpoint to retrieve all dimensions for a report suite, including attribution model data for dimensions that support it. Pass attributionModel as a value in the expansion query parameter to include attribution model data in the response. For more information on the dimensions endpoint, see the Dimensions API guide.

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

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&expansion=attributionModel" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

[
  {
    "id": "variables/evar1",
    "title": "Campaign",
    "name": "Campaign",
    "type": "STRING",
    "category": "Traffic Sources",
    "support": ["oberon", "dataWarehouse"],
    "pathable": false,
    "segmentable": true,
    "reportable": ["oberon"],
    "attributionModel": {
      "func": "allocation-lastTouch_dim",
      "context": "sessions",
      "expiration": {
        "func": "allocation-inactivity",
        "granularity": "day",
        "numPeriods": 30
      }
    }
  },
  {
    "id": "variables/evar2",
    "title": "Internal Search Term",
    "name": "Internal Search Term",
    "type": "STRING",
    "category": "Conversion",
    "support": ["oberon", "dataWarehouse"],
    "pathable": false,
    "segmentable": true,
    "reportable": ["oberon"],
    "attributionModel": {
      "func": "allocation-linear",
      "context": "visitors"
    }
  },
  {
    "id": "variables/prop1",
    "title": "Page Section",
    "name": "Page Section",
    "type": "STRING",
    "category": "Traffic Variables",
    "support": ["oberon"],
    "pathable": true,
    "segmentable": true,
    "reportable": ["oberon"]
  }
]

Request example details

The example requests all dimensions for the examplersid report suite with the attributionModel expansion included.

Response example details

The response returns an array of dimension objects. When the attributionModel expansion is requested, an attributionModel object is included for each dimension that has attribution configured. In this example:

• evar1 uses a Last Touch (allocation-lastTouch_dim) model scoped to sessions, with a 30-day inactivity expiration.
• evar2 uses a Linear (allocation-linear) model scoped to visitors. Models that use context instead of expiration do not include an expiration object.
• prop1 is a traffic variable that does not support attribution. It is returned without an attributionModel field.

Request parameters

Response parameters

The following table describes the attributionModel response object. For all other dimension response parameters, see the Dimensions API guide.

data-variant=info

data-slots=text

GET single dimension with attribution model

Use this endpoint to retrieve attribution model data for a specific dimension. Pass attributionModel as a value in the expansion query parameter to include attribution model data in the response. For more information on the dimensions endpoint, see the Dimensions API guide.

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

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/evar1?rsid=examplersid&expansion=attributionModel" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

{
  "id": "variables/evar1",
  "title": "Campaign",
  "name": "Campaign",
  "type": "STRING",
  "category": "Traffic Sources",
  "support": ["oberon", "dataWarehouse"],
  "pathable": false,
  "segmentable": true,
  "reportable": ["oberon"],
  "attributionModel": {
    "func": "allocation-lastTouch_dim",
    "context": "sessions",
    "expiration": {
      "func": "allocation-inactivity",
      "granularity": "day",
      "numPeriods": 30
    }
  }
}

Request example details

The example requests the evar1 dimension from the examplersid report suite with the attributionModel expansion included.

Response example details

The response returns the standard dimension object for evar1 with an attributionModel object included. In this example:

• The func value allocation-lastTouch_dim indicates a Last Touch model applied at the dimension level.
• The context value sessions scopes attribution to the visit level.
• The expiration object reflects a 30-day inactivity window.

Request parameters

Response parameters

The GET single dimension endpoint returns the same attributionModel object described in the GET multiple dimensions response parameters section above.

Attribution model values

The func field within the attributionModel object returns one of the following values. Each value corresponds to an allocation model configurable in the Analysis Workspace. For conceptual descriptions of each model, see Attribution models and lookback windows.

Dimension-level variants of a model are identified by a _dim suffix. These reflect the native persistence setting of the dimension itself and do not include a lookback window. Variants without the _dim suffix include a lookbackExpiration configuration.

Status codes

Each API request returns an HTTP status code that reflects the result, as follows: