Get the status of a report instance
GET {{baseUrl}}/api/reports/:reportId/instances/:instanceId/status
Get the status of a report instance; see EnumDSSXMLStatus for values. It returns the header X-MSTR-IStatus with the status message, and Retry-After with the suggested retry time in seconds if it is a status that requires polling. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token and the project ID in the request header. You specify the report ID and the report instance ID in the path of the request; you get the report instance ID using POST /report/{id}/instances.
Request Params
| 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
{"id":"020E95484AE99C908F11A9ADCA0AFFB0","status":1,"instanceId":"D9CB2A926844286FA61DFAB42B9FA6A3"}