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 the SQL view of cube by cube ID

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    \"sqlStatement\": \"select\\tdistinct a11.PBTNAME AS PBTNAME\\nfrom\\tpublic.pmt_inventory\\ta11\\n\\tjoin\\tpublic.lu_quarter\\ta12\\n\\t  on \\t(a11.quarter_id = a12.quarter_id)\\nwhere\\ta12.year_id in (2016)\\n\\n[BEGIN PARTITION SQL, all 3 branches are shown and only one will be executed]\\n[1st BRANCH]\\ncreate table ZZPO00 (\\n\\tmonth_id\\tINTEGER, \\n\\titem_id\\tSMALLINT, \\n\\tcall_ctr_id\\tSMALLINT, \\n\\tWJXBFS1\\tDOUBLE PRECISION)\\n\\n\\n[2nd BRANCH]\\ncreate table ZZPO00 (\\n\\tmonth_id\\tINTEGER, \\n\\titem_id\\tSMALLINT, \\n\\tcall_ctr_id\\tSMALLINT, \\n\\tWJXBFS1\\tDOUBLE PRECISION)\\n\\n\\ninsert into ZZPO00 \\nselect\\ta11.month_id AS month_id,\\n\\ta11.item_id AS item_id,\\n\\ta12.call_ctr_id AS call_ctr_id,\\n\\ta11.eoh_qty AS WJXBFS1\\nfrom\\tpublic.{|Partition_Base_Table|}\\ta11\\n\\tcross join\\tpublic.lu_call_ctr\\ta12\\n\\tjoin\\tpublic.lu_month\\ta13\\n\\t  on \\t(a11.month_id = a13.month_id)\\nwhere\\ta13.year_id in (2016)\\n\\n[3rd BRANCH]\\ncreate table ZZPO00 (\\n\\tmonth_id\\tINTEGER, \\n\\titem_id\\tSMALLINT, \\n\\tcall_ctr_id\\tSMALLINT, \\n\\tWJXBFS1\\tDOUBLE PRECISION)\\n\\n\\ninsert into ZZPO00 \\nselect\\ta11.month_id AS month_id,\\n\\ta11.item_id AS item_id,\\n\\ta12.call_ctr_id AS call_ctr_id,\\n\\ta11.eoh_qty AS WJXBFS1\\nfrom\\tpublic.{|Partition_Base_Table|}\\ta11\\n\\tcross join\\tpublic.lu_call_ctr\\ta12\\n\\tjoin\\tpublic.lu_month\\ta13\\n\\t  on \\t(a11.month_id = a13.month_id)\\nwhere\\ta13.year_id in (2016)\\n\\n[END PARTITION SQL]\\n\\ncreate table ZZSP01 (\\n\\tmonth_id\\tINTEGER, \\n\\titem_id\\tSMALLINT, \\n\\tcall_ctr_id\\tSMALLINT, \\n\\tWJXBFS1\\tDOUBLE PRECISION)\\n\\n\\ninsert into ZZSP01 \\nselect\\ta11.month_id AS month_id,\\n\\ta11.item_id AS item_id,\\n\\ta12.call_ctr_id AS call_ctr_id,\\n\\ta11.units_received AS WJXBFS1\\nfrom\\tpublic.inventory_orders\\ta11\\n\\tcross join\\tpublic.lu_call_ctr\\ta12\\n\\tjoin\\tpublic.lu_month\\ta13\\n\\t  on \\t(a11.month_id = a13.month_id)\\nwhere\\ta13.year_id in (2016)\\n\\ncreate table ZZSP02 (\\n\\tmonth_id\\tINTEGER, \\n\\titem_id\\tSMALLINT, \\n\\tcall_ctr_id\\tSMALLINT, \\n\\tWJXBFS1\\tDOUBLE PRECISION, \\n\\tWJXBFS2\\tDOUBLE PRECISION, \\n\\tWJXBFS3\\tDOUBLE PRECISION, \\n\\tWJXBFS4\\tDOUBLE PRECISION, \\n\\tRevenue\\tDOUBLE PRECISION, \\n\\tWJXBFS5\\tDOUBLE PRECISION, \\n\\tWJXBFS6\\tINTEGER, \\n\\tWJXBFS7\\tINTEGER)\\n\\n\\ninsert into ZZSP02 \\nselect\\ta13.month_id AS month_id,\\n\\ta11.item_id AS item_id,\\n\\ta12.call_ctr_id AS call_ctr_id,\\n\\tavg(a11.unit_cost) AS WJXBFS1,\\n\\tavg(a11.unit_price) AS WJXBFS2,\\n\\tavg((a11.unit_price - a11.unit_cost)) AS WJXBFS3,\\n\\tsum(a11.qty_sold) AS WJXBFS4,\\n\\tsum((a11.qty_sold * (a11.unit_price - a11.discount))) AS Revenue,\\n\\tsum((a11.qty_sold * ((a11.unit_price - a11.discount) - a11.unit_cost))) AS WJXBFS5,\\n\\tcount(distinct a11.order_id) AS WJXBFS6,\\n\\tcount(distinct a11.customer_id) AS WJXBFS7\\nfrom\\tpublic.order_detail\\ta11\\n\\tjoin\\tpublic.lu_employee\\ta12\\n\\t  on \\t(a11.emp_id = a12.emp_id)\\n\\tjoin\\tpublic.lu_day\\ta13\\n\\t  on \\t(a11.order_date = a13.day_date)\\nwhere\\ta13.year_id in (2016)\\ngroup by\\ta13.month_id,\\n\\ta11.item_id,\\n\\ta12.call_ctr_id\\n\\ncreate table ZZMD03 (\\n\\tmonth_id\\tINTEGER, \\n\\titem_id\\tSMALLINT, \\n\\tcall_ctr_id\\tSMALLINT, \\n\\tWJXBFS1\\tDOUBLE PRECISION, \\n\\tWJXBFS2\\tDOUBLE PRECISION, \\n\\tWJXBFS3\\tDOUBLE PRECISION, \\n\\tWJXBFS4\\tDOUBLE PRECISION, \\n\\tWJXBFS5\\tDOUBLE PRECISION, \\n\\tWJXBFS6\\tDOUBLE PRECISION, \\n\\tRevenue\\tDOUBLE PRECISION, \\n\\tWJXBFS7\\tDOUBLE PRECISION)\\n\\n\\ninsert into ZZMD03 \\nselect\\tpa11.month_id AS month_id,\\n\\tpa11.item_id AS item_id,\\n\\tpa11.call_ctr_id AS call_ctr_id,\\n\\tpa11.WJXBFS1 AS WJXBFS1,\\n\\tpa12.WJXBFS1 AS WJXBFS2,\\n\\tpa13.WJXBFS1 AS WJXBFS3,\\n\\tpa13.WJXBFS2 AS WJXBFS4,\\n\\tpa13.WJXBFS3 AS WJXBFS5,\\n\\tpa13.WJXBFS4 AS WJXBFS6,\\n\\tpa13.Revenue AS Revenue,\\n\\tpa13.WJXBFS5 AS WJXBFS7\\nfrom\\tZZPO00\\tpa11\\n\\tjoin\\tZZSP01\\tpa12\\n\\t  on \\t(pa11.call_ctr_id = pa12.call_ctr_id and \\n\\tpa11.item_id = pa12.item_id and \\n\\tpa11.month_id = pa12.month_id)\\n\\tjoin\\tZZSP02\\tpa13\\n\\t  on \\t(pa11.call_ctr_id = pa13.call_ctr_id and \\n\\tpa11.item_id = pa13.item_id and \\n\\tpa11.month_id = pa13.month_id)\\n\\nselect\\ta15.category_id AS category_id,\\n\\ta111.category_desc AS category_desc0,\\n\\ta14.subcat_id AS subcat_id,\\n\\ta15.subcat_desc AS subcat_desc0,\\n\\tpa11.item_id AS item_id,\\n\\ta14.item_name AS item_name0,\\n\\ta14.item_upc AS item_upc,\\n\\ta14.brand_id AS brand_id,\\n\\ta18.brand_desc AS brand_desc,\\n\\ta14.supplier_id AS supplier_id,\\n\\ta110.supplier_name AS supplier_name,\\n\\ta16.region_id AS region_id,\\n\\ta19.region_name AS region_name0,\\n\\tpa11.call_ctr_id AS call_ctr_id,\\n\\ta16.center_name AS center_name,\\n\\ta17.year_id AS year_id,\\n\\tpa11.month_id AS month_id,\\n\\ta17.month_desc AS month_desc0,\\n\\tpa11.WJXBFS1 AS WJXBFS1,\\n\\tpa11.WJXBFS2 AS WJXBFS2,\\n\\tpa13.WJXBFS6 AS WJXBFS3,\\n\\tpa11.WJXBFS3 AS WJXBFS4,\\n\\tpa11.WJXBFS4 AS WJXBFS5,\\n\\tpa11.WJXBFS5 AS WJXBFS6,\\n\\tpa11.WJXBFS6 AS WJXBFS7,\\n\\tpa13.WJXBFS7 AS WJXBFS8,\\n\\tpa11.Revenue AS Revenue,\\n\\tpa11.WJXBFS7 AS WJXBFS9\\nfrom\\tZZMD03\\tpa11\\n\\tjoin\\tZZSP02\\tpa13\\n\\t  on \\t(pa11.call_ctr_id = pa13.call_ctr_id and \\n\\tpa11.item_id = pa13.item_id and \\n\\tpa11.month_id = pa13.month_id)\\n\\tjoin\\tpublic.lu_item\\ta14\\n\\t  on \\t(pa11.item_id = a14.item_id)\\n\\tjoin\\tpublic.lu_subcateg\\ta15\\n\\t  on \\t(a14.subcat_id = a15.subcat_id)\\n\\tjoin\\tpublic.lu_call_ctr\\ta16\\n\\t  on \\t(pa11.call_ctr_id = a16.call_ctr_id)\\n\\tjoin\\tpublic.lu_month\\ta17\\n\\t  on \\t(pa11.month_id = a17.month_id)\\n\\tjoin\\tpublic.lu_brand\\ta18\\n\\t  on \\t(a14.brand_id = a18.brand_id)\\n\\tjoin\\tpublic.lu_region\\ta19\\n\\t  on \\t(a16.region_id = a19.region_id)\\n\\tjoin\\tpublic.lu_supplier\\ta110\\n\\t  on \\t(a14.supplier_id = a110.supplier_id)\\n\\tjoin\\tpublic.lu_category\\ta111\\n\\t  on \\t(a15.category_id = a111.category_id)\\nwhere\\ta17.year_id in (2016)\\n\\ndrop table ZZPO00\\n\\ndrop table ZZSP01\\n\\ndrop table ZZSP02\\n\\ndrop table ZZMD03\\n\\n[Analytical engine calculation steps:\\n]\\n\"\n}"

200 OK

Get the SQL view of cube by cube ID Cubes 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 the SQL view of cube by cube ID Cubes MicroStrategy REST API | MicroStrategy REST API Workspace | API documentation

Cubes

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

Cubes 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
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.

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