Get visualization's filter information
GET {{baseUrl}}/api/v2/dossiers/:dossierId/instances/:dossierInstanceId/chapters/:chapterKey/visualizations/:visualizationKey
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
offset | null | Starting point within the collection of returned results. Used to control paging behavior. |
Default value : 0 |
| limit
| null | | Maximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit.
Default value : 1000 |
| standardDateFromat
| null | | Standard date format in ISO8601 |
| standardRawDateFormat
| null | | 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) | |
X-MSTR-ProjectID | string | (Required) | |
instanceId | string | ||
dossierId | string | ||
chapterKey | string | ||
visualizationKey | string |