Get Dimension

GET https://{{axpAPIDomain}}/api/analytics/historical/v1/accounts/:accountId/dimensions/:dimensionName?pageSize=20&prevPageToken=<string>&nextPageToken=<string>&filter=<string>

Gets the list of dimension data for a Dimension name.

Request Params

KeyDatatypeRequiredDescription
pageSizenumberThe maximum number of results per page.
prevPageTokenstringThe page token of the previous set of records to retrieve, represented as unique 36 characters(uuid).
nextPageTokenstringThe page token of the next set of records to retrieve, represented as unique 36 characters(uuid).
filterstringSpecifies details of a row filter. The allowed format:
  • Begins with the column name to be filtered, followed by a colon, then:
  • Either an exact string to match, or
  • A string expression including the * wildcard character |

HEADERS

KeyDatatypeRequiredDescription
appkeystring
Acceptstring

RESPONSES

status: OK

{&quot;columnHeaders&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;}],&quot;records&quot;:[[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]],&quot;pagination&quot;:{&quot;pageSize&quot;:&quot;\u003cinteger\u003e&quot;,&quot;prevPageToken&quot;:&quot;\u003cstring\u003e&quot;,&quot;nextPageToken&quot;:&quot;\u003cstring\u003e&quot;},&quot;links&quot;:{&quot;prev&quot;:&quot;\u003cstring\u003e&quot;,&quot;next&quot;:&quot;\u003cstring\u003e&quot;}}