MicroStrategy REST API API Documentation
Get query details of all grid/graph on a document/dossier instance.
GET {{baseUrl}}/api/documents/:id/instances/:instanceId/queryDetails
Get query details of all grid/graph on a document/dossier instance.
Body
PARAM
| Key | Datatype | Required | Description |
fields
|
null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token | |
X-MSTR-ProjectID
|
string | (Required) Project ID |
RESPONSES
status OK
| {
"layouts": [
{
"key": "K36",
"name": "Layout 1",
"gridGraphs": [
{
"key": "W47",
"rawName": "Revenue Prediction and Trends",
"name": "",
"queryDetails": "\n********* Visualization Summary Start **********\nTime Spent: 0.005 sec(s)\nQuery Execution Start Time: 3/10/2022 9:58:57 PM\nQuery Execution End Time: 3/10/2022 9:58:57 PM\n\nNote: The total 'Time Spent' above may be greater than the summation of the individual step execution times below.\nThere are preparation tasks for each step that are not individually measured.\n********* Visualization Summary End **********\n\n\n\n************ Individual Step Start ************\nNumber of Rows Returned: 8\nTime Spent: 0.000 sec(s)\nQuery Execution Start Time: 3/10/2022 9:58:57 PM\nQuery Execution End Time: 3/10/2022 9:58:57 PM\n\nselect\t[Region]@[region_id],\n\t[Region]@[region_name],\n\t[Revenue Target],\n\t[Target Comments],\n\t[% Year Growth],\n\t[Revenue January],\n\t[Revenue December]\nfrom\tRevenue Prediction and Trends\n************ Individual Step End ************\n\n\n",
"sql": "select\t[Region]@[region_id],\n\t[Region]@[region_name],\n\t[Revenue Target],\n\t[Target Comments],\n\t[% Year Growth],\n\t[Revenue January],\n\t[Revenue December]\nfrom\tRevenue Prediction and Trends\n\n"
},
{
"key": "W61",
"rawName": "Chart - Revenue vs. Target by Region",
"name": "",
"queryDetails": "\n********* Visualization Summary Start **********\nTime Spent: 0.004 sec(s)\nQuery Execu Curl curl -X GET 'baseUrl/api/documents/:id/instances/:instanceId/queryDetails?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' ENDPOINTS |