Logo
MicroStrategy REST API API Documentation

Replace datasource and either remove or replace attributes and metrics on report instance.

PUT {{baseUrl}}/api/reports/:reportId/instances/:instanceId/dataset

Replace datasource and either remove or replace attributes and metrics on report instance. 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.

 

Body PARAM

Key Datatype Required Description 
clearAlias
boolean Clear the alias. Default value is false
clearFormat
boolean Clear the formats. Default value is false
clearFilterSelection
boolean Clear the filter selections. Default value is true.
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
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
Curl
curl -X PUT 'baseUrl/api/reports/:reportId/instances/:instanceId/dataset?clearAlias=true&clearFormat=true&clearFilterSelection=true&offset=0&limit=-1&fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Content-Type: application/json' -d '{"source":{"sourceId":"6137E0964C68D84F107816AA694C2209","targetId":"6137E0964C68D84F107816AA694C2209"}}'

ENDPOINTS