Skip to main content

Filter report and cube instances using requestedObjects

tip

You can try out this workflow at REST API Playground.

Learn more about MicroStrategy REST API Playground here.

When you create a MicroStrategy report or cube instance using the following REST API endpoints, you can use a parameter called requestedObjects in the body parameter of the request to specify the data that should be returned:

  • POST /api/cubes/{cubeId}/instances
  • POST /api/reports/{reportId}/instances

In the requestedObjects parameter, you specify the name and ID of each attribute and metric to include in the report or cube instance. If you use both a viewFilter and a requestedObjects parameter in the request, the view filter will be applied first. The requestedObjects definition will then be applied to the filtered results (a subset of the cube data), rather than to the cube data itself.

The following topics are designed to help you understand and use requestedObjects.