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
Key | Datatype | Required | Description |
---|---|---|---|
pageSize | number | The maximum number of results per page. | |
prevPageToken | string | The page token of the previous set of records to retrieve, represented as unique 36 characters(uuid). | |
nextPageToken | string | The page token of the next set of records to retrieve, represented as unique 36 characters(uuid). | |
filter | string | Specifies 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
Key | Datatype | Required | Description |
---|---|---|---|
appkey | string | ||
Accept | string |
RESPONSES
status: OK
{"columnHeaders":[{"name":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"records":[["\u003cstring\u003e","\u003cstring\u003e"],["\u003cstring\u003e","\u003cstring\u003e"]],"pagination":{"pageSize":"\u003cinteger\u003e","prevPageToken":"\u003cstring\u003e","nextPageToken":"\u003cstring\u003e"},"links":{"prev":"\u003cstring\u003e","next":"\u003cstring\u003e"}}