Create a report instance filter using requestedObjects
POST {{baseUrl}}/api/reports/:reportId/instances?offset=0&limit=1000
Get the results 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 pathof 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, thresholds 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. | |
fields
|
string | 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 | |
Content-Type
|
string | Curl curl -X POST 'baseUrl/api/reports/:reportId/instances?offset=0&limit=1000?offset=0&limit=1000&fields=sed minim' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Content-Type: application/json' -d '{"requestedObjects":{"attributes":[{"id":"rd_attribute","name":"Region"}],"metrics":[{"id":"rd_metric","name":"Revenue"}]}}' ENDPOINTS |