MicroStrategy REST API

MicroStrategy REST API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from MicroStrategy SDK.

MicroStrategy REST API | MicroStrategy REST API Workspace | API documentation

X-MSTR-AuthToken

X-MSTR-ProjectID

Get available pageBy elements of the report.

Starting point within the collection of returned results. Used to control paging behavior.

offset

Maximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit.

limit

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.

fields

"{\n    \"pageBy\": [\n        {\n            \"name\": \"Category\",\n            \"id\": \"8D679D3711D3E4981000E787EC6DE8A4\",\n            \"type\": \"attribute\",\n            \"forms\": [\n                {\n                    \"id\": \"CCFBE2A5EADB4F50941FB879CCF1721C\",\n                    \"name\": \"DESC\",\n                    \"dataType\": \"varChar\",\n                    \"baseFormCategory\": \"DESC\",\n                    \"baseFormType\": \"text\"\n                }\n            ],\n            \"elements\": [\n                {\n                    \"formValues\": [\n                        \"Books\"\n                    ],\n                    \"id\": \"h1;8D679D3711D3E4981000E787EC6DE8A4\"\n                },\n                {\n                    \"formValues\": [\n                        \"Electronics\"\n                    ],\n                    \"id\": \"h2;8D679D3711D3E4981000E787EC6DE8A4\"\n                },\n                {\n                    \"formValues\": [\n                        \"Movies\"\n                    ],\n                    \"id\": \"h3;8D679D3711D3E4981000E787EC6DE8A4\"\n                },\n                {\n                    \"formValues\": [\n                        \"Music\"\n                    ],\n                    \"id\": \"h4;8D679D3711D3E4981000E787EC6DE8A4\"\n                }\n            ]\n        }\n    ],\n    \"validPageByElements\": {\n        \"paging\": {\n            \"total\": 4,\n            \"current\": 4,\n            \"offset\": 0,\n            \"limit\": 1000\n        },\n        \"items\": [\n            [\n                0\n            ],\n            [\n                1\n            ],\n            [\n                2\n            ],\n            [\n                3\n            ]\n        ]\n    }\n}"

200 OK

Get available pageBy elements of the report. Reports MicroStrategy REST API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from MicroStrategy SDK.

Get available pageBy elements of the report. Reports MicroStrategy REST API | MicroStrategy REST API Workspace | API documentation

Reports

Reports MicroStrategy REST API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from MicroStrategy SDK.

Reports MicroStrategy REST API | MicroStrategy REST API Workspace | API documentation

This workspace contains two collections. To use the collections, you need to select an environment.

<ol>
<li>MicroStrategy REST API: Use it as API Documentation. It contains examples and built-in scripts to saved the context information after some requests, such as authToken, userId.</li>
<li>MicroStrategy REST API Workflows: It contains workflow examples. You can pick a folder and run all the requests.</li>
</ol>

The workspace contains a demo environment file. You can make a copy and change it to your environment.

Log your questions and feedback on <a href="https://github.com/MicroStrategy/rest-api-playground">https://github.com/MicroStrategy/rest-api-playground</a>

Contributions are welcome!

Github

Twitter

Developer Website

MicroStrategy REST API projects on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from MicroStrategy SDK.

Key	Datatype	Required	Description
X-MSTR-AuthToken	string		(Required) Authorization token
X-MSTR-ProjectID	string		(Required) Project ID