Get a report within a report instance
GET {{baseUrl}}/api/model/reports/:reportId?showExpressionAs=tokens&showFilterTokens=true&showAdvancedProperties=true
Request Params
| Key | Datatype | Required | Description |
|---|
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. | | | |
| Available values : tokens, tree | | | |
showFilterTokens | boolean | | An optional boolean flag controlling whether tokens will be displayed along with the filter's predicate tree and descriptive text. By default 'false' is used. |
showAdvancedProperties | boolean | | An optional boolean flag controlling whether to retrieve the values of the advanced properties. By default 'false' is used. |
| Key | Datatype | Required | Description |
|---|
X-MSTR-AuthToken | string | | (Required) Authorization Token |
X-MSTR-MS-Instance | string | | (Required) Instance ID |