MicroStrategy REST API API Documentation
Get the search index properties for a project
GET {{baseUrl}}/api/mstrServices/searchEngine/indices/:id
Get properties of the search index for a specific project. 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 in the request header. You retrieve the search index by specifying the project ID in the path of the request.
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 |
RESPONSES
status OK
| {
"projectName": "MicroStrategy Tutorial",
"projectId": "B7CA92F04B9FAE8D941C3E9B7E0CD754",
"status": "completed_on",
"percentComplete": 1,
"searchableItems": 5378,
"lastRealTimeUpdateTime": "2023-01-08T06:23:49.501+0000",
"lastIncrementalCrawlTime": "2023-01-08T06:23:30.914+0000"
} |
Curl
curl -X GET 'baseUrl/api/mstrServices/searchEngine/indices/:id?fields=' -H 'X-MSTR-AuthToken: authToken'
ENDPOINTS