MicroStrategy REST API API Documentation
Read a report's definition through Modelling Service
GET {{baseUrl}}/api/model/reports/:reportId?showFilterTokens=true&showExpressionAs=tree&showAdvancedProperties=true
Get a report's definition through Modeling Service. The definition includes information
, sourceType
, dataSource
, grid
and perhaps advancedProperties
and timezone
if exist. An authorization token is required to execute the request and can be obtained using Authentication endpoints Set Prefer
to respond-async to execute this API asynchronously.
Body
PARAM
| Key | Datatype | Required | Description |
showFilterTokens
|
boolean | Specify whether "qualification" is returned in "tokens" format, along with "text" and "tree" formats. A filter's "qualification" is presented in the following formats: * "text": A human readable, but non-parsable text, describing a filter's qualification. * "tree": A tree data structure fully defining the filter's qualification. * "tokens": A list of parsed tokens that define a filter's qualification. Be aware that generating tokens requires additional time. If omitted or `false`, only "text" and "tree" formats are returned. If `true`, all "text", "tree" and "tokens" formats are returned. | |
showExpressionAs
|
string | This parameter specifies the format in which the expressions are returned in response. This parameter applies to the expressions in a fact or attribute and custom expressions used in a filter, prompt, security filter, custom group, etc. Expressions are presented in the following formats: * "text": A human readable, but non-parsable text, describing the expression. This is the default format that is always returned in the response. * "tree": A tree data structure fully defining the expression. This format can be used if you want to examine and modify the expression programmatically. * "tokens": A list of parsed tokens. This format can be used if you want to examine and modify the expression using the parser component. Note that generating tokens requires additional time. Tokens are a semi-structured representation of MicroStrategy expression text that includes object references. For example, let’s say a filter expression is "Revenue > Cost". When the filter expression is represented as tokens, the text is broken down into pieces (tokens) with information about what these pieces represent in the metadata: ("Revenue", Revenue_ID), (">", GreaterThan_ID), ("Cost", Cost_ID). If omitted, the expression is returned in "text" format. If `tree`, the expression is returned in "text" and "tree" formats. If `tokens`, the expression is returned in "text" and "tokens" formats. | |
showAdvancedProperties
|
boolean | Specify whether to retrieve the values of the advanced properties. The advanced properties are presented in the following groups: * "vldbProperties": A list of properties as determined by the common infrastructure. * "metricJoinTypes": A list of Metric Join Types, one for each metric that appears in the template. * "attributeJoinTypes": A list of Attribute Join Types, one for each attribute that appears in the template. * "drillOptions": A list of properties related to the report drilling setting. * "useDefaultEvaluationOrder": A property decide the evaluation ordering. * "promptOrdering": A list of prompts in the same resolve sequence when executing the report. If omitted or `false`, nothing will be returned for the advanced properties. If `true`, all applicable advanced properties are returned. |
HEADERS
| Key | Datatype | Required | Description |
|