Get the definition and data result of a grid/graph visualization
GET {{baseUrl}}/api/v2/dossiers/:dossierId/instances/:instanceId/chapters/:chapterKey/visualizations/:visualizationKey?offset=0&limit=1000
Get the definition and data result of a grid/graph visualization in a specific dossier in a specific project. A dossier and a document have the same base object; a dossier is simply a different view of the document. You obtain the authorization token needed to execute the request using POST /auth/login and the project ID using GET /project; you pass the authorization token and the project ID in the request header. You identify the dossier, the dossier instance, the dossier chapter, and the dossier visualization in the path of the request, by specifying the IDs of the dossier and dossier instance and the keys of the chapter and visualization. You are using the document/dossier ID that was generated by another API. You obtain the dossier instance ID using POST /dossiers/{dossierId}/instances. You obtain the dossier chapter key and the dossier visualization key using GET /dossiers/{dossierId}/definition. It is important to note that concurrent behavior on one dossier instance ID is not currently supported; instead, you can create multi-instance IDs to perform concurrent behavior.
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
|
string | Standard date format in ISO8601 | |
standardRawDateFormat
|
string | Standard raw date format in ISO8601 | |
fields
|
string | 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 |
Curl curl -X GET 'baseUrl/api/v2/dossiers/:dossierId/instances/:instanceId/chapters/:chapterKey/visualizations/:visualizationKey?offset=0&limit=1000?offset=0&limit=1000&standardDateFormat=<boolean>&standardRawDateFormat=<boolean>&fields=<string>' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' ENDPOINTS |