List Custom Dimensions

GET /base/custom-dimensions

Group: Base › Reporting Tags · Operation ID: listCustomDimensions

Returns the custom value dimensions this tenant has defined, the tenant-specific axes that extend reporting tags beyond the nine built-in dimensions. Each entry gives a dimension's identifier and display name. To list the values inside one dimension, use GET base/custom-dimensions/{customDimensionUuid}/values.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
pageSize query number no The number of dimensions per page, between 1 and 200. Defaults to 50. A value above 200 is treated as 200, not rejected.
cursor query string no The cursor from the previous response's pagination.nextCursor. Omit on the first request.

Response

200 Success

Under data (listCustomDimensionsOutput):

Field Type Required Description
items array of object yes The custom dimensions on this page, ordered by identifier. An empty array when the tenant has defined none.
items[].customDimensionUuid string yes The unique identifier for the custom value dimension. It is the customDimensionUuid on a 'custom' row from POST base/reporting-tags/resolve.
items[].name string yes The display name of the custom dimension.
pagination object yes The pagination cursor for this page.
pagination.nextCursor string no The cursor for the next page. Pass it as the cursor query parameter. Absent on the last page.
pagination.hasMore boolean yes True when more dimensions remain beyond this page.

Errors

Code Status
INVALID_CURSOR 400

Statuses