Logo
MicroStrategy REST API API Documentation

Get information for specific cubes

GET {{baseUrl}}/api/cubes?id={{cubeId}}

Get information for specific cubes in a specific project. The cubes can be either OLAP cubes or Direct Data Access (DDA)/MDX cubes. This request returns the cube name, ID, size, status, path, last modification date, and owner name and ID. You obtain the authorization token needed to execute the request using POST /auth/login; you obtain the project ID using GET /projects. You pass the authorization token and the project ID in the request header. You pass the IDs of the cubes that you want to get information about as the value of a query parameter; the value is an array of cube IDs.

 

Body PARAM

Key Datatype Required Description 
id
string (Required) Cube Object IDs
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

{ "cubesInfos": [ { "cubeName": "Scanned Item Cube", "cubeId": "0A9EBE87468B751C3663818889B10D73", "ownerId": "54F3D26011D2896560009A8E67019608", "path": "\\MicroStrategy Tutorial\\Public Objects\\Reports\\MicroStrategy Platform Capabilities\\MicroStrategy Mobile\\iPhone\\Component Objects\\Scanned Item\\Scanned Item Cube", "modificationTime": "2022-02-28 21:26:46", "lastU
Curl
curl -X GET 'baseUrl/api/cubes?id=cubeId?id=cubeId&fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId'

ENDPOINTS