Logo
MicroStrategy REST API API Documentation

Get the definition and data result of a grid/graph visualization

GET {{baseUrl}}/api/v2/dossiers/:dossierId/instances/:instanceId/chapters/:chapterKey/visualizations/:visualizationKey

 

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.
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' for a normal grid visualization, and '-data.metricValues.columnSets.raw' / '-data.metricValues.columnSets.formatted' / '-data.metricValues.columnSets.extras' for a compound grid visualization.



HEADERS

Key Datatype Required Description 
X-MSTR-AuthToken
string (Required) Authorization token
Curl
curl -X GET 'baseUrl/api/v2/dossiers/:dossierId/instances/:instanceId/chapters/:chapterKey/visualizations/:visualizationKey?offset=0&limit=-1&standardDateFormat=true&standardRawDateFormat=true&fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId'

ENDPOINTS