Create a report instance and get the results or status
POST {{baseUrl}}/api/v2/reports/:reportId/instances
Get the normalized JSON structure results supporting cross-tab of a newly created report instance. This in-memory report instance can be used by other requests.
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 specify the report ID in the path of the request. You use the offset and limit query parameters in the request to determine the report data displayed on the page. In the body parameter of the request, you specify the data to be included in the report instance, such as attributes, metrics, view filter, metric limits, and sorting criteria.
Body
PARAM
| Key | Datatype | Required | Description |
offset
|
number | Starting point within the collection of returned results. Used to control paging behavior. | |
limit
|
number | Maximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit. | |
standardDateFormat
|
boolean | Standard date format in ISO8601 | |
standardRawDateFormat
|
boolean | Standard raw date format in ISO8601 | |
executionStage
|
string | The execution stage the report is executed to. Available values: resolve_prompts, execute_data. | |
fields
|
null | Field selector. This allows client to exclude unneeded information from response model. It can be either empty, or a combination of following exclusion rules separated by comma: '-data.metricValues.raw' / '-data.metricValues.formatted' / '-data.metricValues.extras'. |
HEADERS
| Key | Datatype | Curl curl -X POST 'baseUrl/api/v2/reports/:reportId/instances?offset=0&limit=-1&standardDateFormat=true&standardRawDateFormat=true&executionStage=execute_data&fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Prefer: respond-async' -H 'Content-Type: application/json' ENDPOINTS |