Sign in

v1

latestSwagger 2.02026-07-175658186.8 KB
Dimensions

Retrieve a dimension by ID

get/{globalCompanyId}/dimensions/{id}

Path parameters

globalCompanyIdstring required

The Global Company ID for the Adobe Analytics organization

idstring required

The dimension ID. For example a valid id is a value like 'evar1'

Query parameters

rsidstring required

The report suite ID.

localestring

The locale to use for returning system named dimensions.

expansionstring[]

Add extra metadata to items (comma-delimited list)

Headers

Authorizationstring required

The access token copied from your AA API client integration, prefixed with "Bearer ".

x-api-keystring required

The API key copied from your AA API client integration. For more information on how to obtain this value, see Getting started with the Analytics API.

Response

successful operation

idstring
titlestring
namestring
type'STRING' | 'INT' | 'DECIMAL' | 'CURRENCY' | 'PERCENT' | 'TIME' | 'ENUM' | 'ORDERED_ENUM'
categorystring
categoriesstring[]
supportstring[]
pathableboolean
parentstring
extraTitleInfostring
segmentableboolean
reportablestring[]
descriptionstring
allowedForReportingboolean
attributionModelobject
allocationType'most_recent_last' | 'original_value_first' | 'linear' | 'linear_to_items' | 'merchandising_first' | 'merchandising_last'

The configured allocation type for the eVar. Preserves distinctions collapsed by attributionModel.func.

expirationType'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 across hits.

expirationCustomDaysinteger

Number of days in the expiration window. Semantically meaningful when expirationType is 'day'.

dataType'text' | 'counter'

The eVar storage type.

bindingEventsstring[]

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

merchandisingSyntax'product' | 'conversion_variable'

Merchandising binding style. Populated only for merchandising eVars.

ecomAllocationType'first' | 'last' | 'merchandising'

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

Example response

{
  "allocationType": "linear",
  "expirationType": "visit",
  "expirationCustomDays": 30,
  "dataType": "text",
  "bindingEvents": [
    "event1",
    "event2"
  ],
  "merchandisingSyntax": "conversion_variable",
  "ecomAllocationType": "last"
}