Logo
MicroStrategy REST API API Documentation

Get available page-by elements of the report.

GET {{baseUrl}}/api/v2/reports/:reportId/instances/:instanceId/pageBy/elements?offset=0&limit=1000

Get the valid pageBy elements combinations of the report. These combinations could be used to jump to a specific page of the report.

 

Body PARAM

Key Datatype Required Description 
offset
number Starting point within the collection of returned results. Used to control paging behavior.
limit
number Maximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit.
fields
string Comma separated top-level field whitelist. This allows client to selectively retrieve part of the response model. If specified, extra filtering will be applied, and for top-level object (if root model is an array, each array element), only the listed fields will be kept in the response. e.g. "id,elements" means to keep only the "id" field and the whole "elements" array field, omitting all other fields of top-level response model.



HEADERS

Key Datatype Required Description 
X-MSTR-AuthToken
string (Required) Authorization token
X-MSTR-ProjectID
string (Required) Project ID




RESPONSES

status

Curl
curl -X GET 'baseUrl/api/v2/reports/:reportId/instances/:instanceId/pageBy/elements?offset=0&limit=1000?offset=0&limit=1000&fields=<string>' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId'

ENDPOINTS