MicroStrategy REST API API Documentation
Get the results of a report instance
GET {{baseUrl}}/api/v2/reports/:reportId/instances/:instanceId
Get the results of a previously created report instance, using the in-memory report instance created by a POST /reports/{reportId}/instances request.
You obtain the authorization token needed to execute the request using POST /auth/login; you obtain the project ID using GET /projects. You pass the authorization token and the project ID in the request header. You specify the report ID and report instance ID in the path of the request. You use the offset and limit query parameters in the requestto determine the report data displayed on the page.
Body
PARAM
| Key | Datatype | Required | Description |
offset
|
number | Maximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit. | |
limit
|
number | Maximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit. | |
standardDateFormat
|
boolean | Standard date format in ISO8601 | |
standardRawDateFormat
|
boolean | Standard raw date format in ISO8601 | |
fields
|
null | Field selector. This allows client to exclude unneeded information from response model. It can be either empty, or a combination of following exclusion rules separated by comma: '-data.metricValues.raw' / '-data.metricValues.formatted' / '-data.metricValues.extras'. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token
Curl curl -X GET 'baseUrl/api/v2/reports/:reportId/instances/:instanceId?offset=0&limit=-1&standardDateFormat=true&standardRawDateFormat=true&fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Prefer: respond-async' ENDPOINTS |