MicroStrategy REST API API Documentation
Get the SQL view of datasets on a document/dossier instance
GET {{baseUrl}}/api/dossiers/:id/instances/:instanceId/datasets/sqlView
Get the collection of datasets and their SQL statement from 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
| {
"datasets": [
{
"name": "retail-sample-data.xls",
"id": "643DFEB79149B0FCA89A1D9534D2AD33",
"sqlStatement": "\n\n[Analytical engine calculation steps:\n\t1. Perform dynamic aggregation over <City, Item Category, Month>\n\t2. Calculate metric: <Profit> at original data level in the view\n\t3. Calculate metric: <Profit> at subtotal levels in the view\n\t4. Calculate subtotal: <ExtMin_Global> \n\t5. Calculate subtotal: <ExtMax_Global> \n\t6. Calculate subtotal: <ExtMin_S_Global> \n\t7. Calculate subtotal: <ExtMax_S_Global> \n\t8. Calculate subtotal: <ExtMin_S_Cell> \n\t9. Calculate subtotal: <ExtMax_S_Cell> \n\t10. Perform cross-tabbing\n]\n"
}
]
} |
Curl
curl -X GET 'baseUrl/api/dossiers/:id/instances/:instanceId/datasets/sqlView?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId'
ENDPOINTS