Qodex.ai

Update report instance do manipulations like changing template, view filters, metric limits, thresholds and sorting on top of the instance. If includeThresholds parameter is set to true, the result will also contain thresholds information, else all thres

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

Do manipulations on top of the specified instance

Request Params

KeyDatatypeRequiredDescription
offsetnumberStarting point within the collection of returned results. Used to control paging behavior.
limitnumberMaximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit.
fieldsnullComma-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

KeyDatatypeRequiredDescription
X-MSTR-AuthTokenstring(Required) Authorization token
X-MSTR-ProjectIDstring(Required) Project ID
Content-Typestring

RESPONSES

status: OK

{"id":"020E95484AE99C908F11A9ADCA0AFFB0","name":"Monthly Sales vs LM \u0026 LY (1:1 transformations)","status":1,"instanceId":"D9CB2A926844286FA61DFAB42B9FA6A3","result":{"definition":{"availableObjects":{"metrics":[{"name":"Revenue","id":"4C05177011D3E877C000B3B2D86C964F","type":"Metric"},{"name":"Last Month's Revenue","id":"4C05198411D3E877C000B3B2D86C964F","type":"Metric"},{"name":"% Diff from LM - Revenue","id":"337B8C4E49A86BB63110F9B7F4398A1D","type":"Metric"},{"name":"Last Year's Revenue","id":"4C05199311D3E877C000B3B2D86C964F","type":"Metric"},{"name":"% Diff from TM LY - Revenue","id":"66FA3CBF46C5A719EA1A1F98B8C3D467","type":"Metric"}],"attributes":[{"name":"Quarter","id":"8D679D4A11D3E4981000E787EC6DE8A4","type":"Attribute","forms":[{"id":"CCFBE2A5EADB4F50941FB879CCF1721C","name":"DESC","dataType":"Char","baseFormCategory":"DESC","baseFormType":"Text"},{"id":"45C11FA478E745FEA08D781CEA190FE5","name":"ID","dataType":"Real","baseFormCategory":"ID","baseFormType":"Number"}]},{"name":"Month","id":"8D679D4411D3E4981000E787EC6DE8A4","type":"Attribute","forms":[{"id":"CCFBE2A5EADB4F50941FB879CCF1721C","name":"DESC","dataType":"Char","baseFormCategory":"DESC","baseFormType":"Text"},{"id":"45C11FA478E745FEA08D781CEA190FE5","name":"ID","dataType":"Real","baseFormCategory":"ID","baseFormType":"Number"}]}]},"metrics":[{"name":"Revenue","id":"4C05177011D3E877C000B3B2D86C964F","type":"Metric","min":75226,"max":1076885.35,"dataType":"Double","numberFormatting":{"category":1,"decimalPlaces":0,"thousandSeparator":true,"currencySymbol":"$","currencyPosition":0,"formatString":"\"$\"#,##0","negativeType":1}},{"name":"Last Month's Revenue","id":"4C05198411D3E877C000B3B2D86C964F","type":"Metric","min":75226,"max":1036196.9,"dataType":"Double","numberFormatting":{"category":1,"decimalPlaces":0,"thousandSeparator":true,"currencySymbol":"$","currencyPosition":0,"formatString":"\"$\"#,##0","negativeType":1}},{"name":"% Diff from LM - Revenue","id":"337B8C4E49A86BB63110F9B7F4398A1D","type":"Metric","min":-0.1075873804,"max":0.146109733,"dataType":"Double","numberFormatting":{"category":4,"decimalPlaces":2,"thousandSeparator":true,"currencySymbol":"$","currencyPosition":0,"formatString":"0.00%;[RED](0.00%)","negativeType":4}},{"name":"Last Year's Revenue","id":"4C05199311D3E877C000B3B2D86C964F","type":"Metric","min":58185,"max":764218.050000001,"dataType":"Double","numberFormatting":{"category":1,"decimalPlaces":0,"thousandSeparator":true,"currencySymbol":"$","currencyPosition":0,"formatString":"\"$\"#,##0","negativeType":1}},{"name":"% Diff from TM LY - Revenue","id":"66FA3CBF46C5A719EA1A1F98B8C3D467","type":"Metric","min":0.1469760025,"max":0.4559622197,"dataType":"Double","numberFormatting":{"category":4,"decimalPlaces":2,"thousandSeparator":true,"currencySymbol":"$","currencyPosition":0,"formatString":"0.00%;[RED](0.00%)","negativeType":4}}],"attributes":[{"name":"Quarter","id":"8D679D4A11D3E4981000E787EC6DE8A4","type":"Attribute","forms":[{"id":"CCFBE2A5EADB4F50941FB879CCF1721C","name":"DESC","dataType":"Char","baseFormCategory":"DESC","baseFormType":"Text"}]},{"name":"Month","id":"8D679D4411D3E4981000E787EC6DE8A4","type":"Attribute","forms":[{"id":"CCFBE2A5EADB4F50941FB879CCF1721C","name":"DESC","dataType":"Char","baseFormCategory":"DESC","baseFormType":"Text"}]}],"thresholds":[],"sorting":[]},"data":{"paging":{"total":12,"current":12,"offset":0,"limit":1000,"prev":null,"next":null},"root":{"isPartial":false,"children":[{"depth":0,"element":{"attributeIndex":0,"formValues":{"DESC":"2016 Q1"},"name":"2016 Q1","id":"h20161;8D679D4A11D3E4981000E787EC6DE8A4"},"isPartial":false,"children":[{"depth":1,"element":{"attributeIndex":1,"formValues":{"DESC":"Jan 2016"},"name":"Jan 2016","id":"h201601;8D679D4411D3E4981000E787EC6DE8A4"},"metrics":{"Revenue":{"rv":77866,"fv":"$77,866","mi":0},"Last Month's Revenue":{"rv":80602.9500000006,"fv":"$80,603","mi":1},"% Diff from LM - Revenue":{"rv":-0.0339559532,"fv":"\u003cSPAN STYLE=\"COLOR: #f00\" \u003e(3.40%)\u003c/SPAN\u003e","mi":2},"Last Year's Revenue":{"rv":58185,"fv":"$58,185","mi":3},"% Diff from TM LY - Revenue":{"rv":0.3382486895,"fv":"33.82%","mi":4}}},{"depth":1,"element":{"attributeIndex":1,"formValues":{"DESC":"Feb 2016"},"name":"Feb 2016","id":"h201602;8D679D4411D3E4981000E787EC6DE8A4"},"metrics":{"Revenue":{"rv":75226,"fv":"$75,226","mi":0},"Last Month's Revenue":{"rv":77866,"fv":"$77,866","mi":1},"% Diff from LM - Revenue":{"rv":-0.0339043999,"fv":"\u003cSPAN STYLE=\"COLOR: #f00\" \u003e(3.39%)\u003c/SPAN\u003e","mi":2},"Last Year's Revenue":{"rv":63239,"fv":"$63,239","mi":3},"% Diff from TM LY - Revenue":{"rv":0.1895507519,"fv":"18.96%","mi":4}}},{"depth":1,"element":{"attributeIndex":1,"formValues":{"DESC":"Mar 2016"},"name":"Mar 2016","id":"h201603;8D679D4411D3E4981000E787EC6DE8A4"},"metrics":{"Revenue":{"rv":85204,"fv":"$85,204","mi":0},"Last Month's Revenue":{"rv":75226,"fv":"$75,226","mi":1},"% Diff from LM - Revenue":{"rv":0.1326403105,"fv":"13.26%","mi":2},"Last Year's Revenue":{"rv":67411,"fv":"$67,411","mi":3},"% Diff from TM LY - Revenue":{"rv":0.2639480204,"fv":"26.39%","mi":4}}}]},{"depth":0,"element":{"attributeIndex":0,"formValues":{"DESC":"2016 Q2"},"name":"2016 Q2","id":"h20162;8D679D4A11D3E4981000E787EC6DE8A4"},"isPartial":false,"children":[{"depth":1,"element":{"attributeIndex":1,"formValues":{"DESC":"Apr 2016"},"name":"Apr 2016","id":"h201604;8D679D4411D3E4981000E787EC6DE8A4"},"metrics":{"Revenue":{"rv":85174.1999999989,"fv":"$85,174","mi":0},"Last Month's Revenue":{"rv":85204,"fv":"$85,204","mi":1},"% Diff from LM - Revenue":{"rv":-0.0003497488,"fv":"\u003cSPAN STYLE=\"COLOR: #f00\" \u003e(0.03%)\u003c/SPAN\u003e","mi":2},"Last Year's Revenue":{"rv":64017.6,"fv":"$64,018","mi":3},"% Diff from TM LY - Revenue":{"rv":0.3304809927,"fv":"33.05%","mi":4}}},{"depth":1,"element":{"attributeIndex":1,"formValues":{"DESC":"May 2016"},"name":"May 2016","id":"h201605;8D679D4411D3E4981000E787EC6DE8A4"},"metrics":{"Revenue":{"rv":92501.8999999987,"fv":"$92,502","mi":0},"Last Month's Revenue":{"rv":85174.1999999989,"fv":"$85,174","mi":1},"% Diff from LM - Revenue":{"rv":0.0860319205,"fv":"8.60%","mi":2},"Last Year's Revenue":{"rv":67418.7999999997,"fv":"$67,419","mi":3},"% Diff from TM LY - Revenue":{"rv":0.3720490427,"fv":"37.20%","mi":4}}},{"depth":1,"element":{"attributeIndex":1,"formValues":{"DESC":"Jun 2016"},"name":"Jun 2016","id":"h201606;8D679D4411D3E4981000E787EC6DE8A4"},"metrics":{"Revenue":{"rv":88470,"fv":"$88,470","mi":0},"Last Month's Revenue":{"rv":92501.8999999987,"fv":"$92,502","mi":1},"% Diff from LM - Revenue":{"rv":-0.0435872128,"fv":"\u003cSPAN STYLE=\"COLOR: #f00\" \u003e(4.36%)\u003c/SPAN\u003e","mi":2},"Last Year's Revenue":{"rv":72064,"fv":"$72,064","mi":3},"% Diff from TM LY - Revenue":{"rv":0.2276587478,"fv":"22.77%","mi":4}}}]},{"depth":0,"element":{"attributeIndex":0,"formValues":{"DESC":"2016 Q3"},"name":"2016 Q3","id":"h20163;8D679D4A11D3E4981000E787EC6DE8A4"},"isPartial":false,"children":[{"depth":1,"element":{"attributeIndex":1,"formValues":{"DESC":"Jul 2016"},"name":"Jul 2016","id":"h201607;8D679D4411D3E4981000E787EC6DE8A4"},"metrics":{"Revenue":{"rv":86596.0000000002,"fv":"$86,596","mi":0},"Last Month's Revenue":{"rv":88470,"fv":"$88,470","mi":1},"% Diff from LM - Revenue":{"rv":-0.0211823217,"fv":"\u003cSPAN STYLE=\"COLOR: #f00\" \u003e(2.12%)\u003c/SPAN\u003e","mi":2},"Last Year's Revenue":{"rv":75499.4000000003,"fv":"$75,499","mi":3},"% Diff from TM LY - Revenue":{"rv":0.1469760025,"fv":"14.70%","mi":4}}},{"depth":1,"element":{"attributeIndex":1,"formValues":{"DESC":"Aug 2016"},"name":"Aug 2016","id":"h201608;8D679D4411D3E4981000E787EC6DE8A4"},"metrics":{"Revenue":{"rv":93610.9999999995,"fv":"$93,611","mi":0},"Last Month's Revenue":{"rv":86596.0000000002,"fv":"$86,596","mi":1},"% Diff from LM - Revenue":{"rv":0.0810083607,"fv":"8.10%","mi":2},"Last Year's Revenue":{"rv":76428.8999999998,"fv":"$76,429","mi":3},"% Diff from TM LY - Revenue":{"rv":0.2248115569,"fv":"22.48%","mi":4}}},{"depth":1,"element":{"attributeIndex":1,"formValues":{"DESC":"Sep 2016"},"name":"Sep 2016","id":"h201609;8D679D4411D3E4981000E787EC6DE8A4"},"metrics":{"Revenue":{"rv":93727.4999999995,"fv":"$93,727","mi":0},"Last Month's Revenue":{"rv":93610.9999999995,"fv":"$93,611","mi":1},"% Diff from LM - Revenue":{"rv":0.0012445119,"fv":"0.12%","mi":2},"Last Year's Revenue":{"rv":79870.6999999998,"fv":"$79,871","mi":3},"% Diff from TM LY - Revenue":{"rv":0.1734904039,"fv":"17.35%","mi":4}}}]},{"depth":0,"element":{"attributeIndex":0,"formValues":{"DESC":"2016 Q4"},"name":"2016 Q4","id":"h20164;8D679D4A11D3E4981000E787EC6DE8A4"},"isPartial":false,"children":[{"depth":1,"element":{"attributeIndex":1,"formValues":{"DESC":"Oct 2016"},"name":"Oct 2016","id":"h201610;8D679D4411D3E4981000E787EC6DE8A4"},"metrics":{"Revenue":{"rv":107422,"fv":"$107,422","mi":0},"Last Month's Revenue":{"rv":93727.4999999995,"fv":"$93,727","mi":1},"% Diff from LM - Revenue":{"rv":0.146109733,"fv":"14.61%","mi":2},"Last Year's Revenue":{"rv":81610,"fv":"$81,610","mi":3},"% Diff from TM LY - Revenue":{"rv":0.316284769,"fv":"31.63%","mi":4}}},{"depth":1,"element":{"attributeIndex":1,"formValues":{"DESC":"Nov 2016"},"name":"Nov 2016","id":"h201611;8D679D4411D3E4981000E787EC6DE8A4"},"metrics":{"Revenue":{"rv":118542.850000002,"fv":"$118,543","mi":0},"Last Month's Revenue":{"rv":107422,"fv":"$107,422","mi":1},"% Diff from LM - Revenue":{"rv":0.1035248832,"fv":"10.35%","mi":2},"Last Year's Revenue":{"rv":81859.1500000006,"fv":"$81,859","mi":3},"% Diff from TM LY - Revenue":{"rv":0.4481319437,"fv":"44.81%","mi":4}}},{"depth":1,"element":{"attributeIndex":1,"formValues":{"DESC":"Dec 2016"},"name":"Dec 2016","id":"h201612;8D679D4411D3E4981000E787EC6DE8A4"},"metrics":{"Revenue":{"rv":117354.850000003,"fv":"$117,355","mi":0},"Last Month's Revenue":{"rv":118542.850000002,"fv":"$118,543","mi":1},"% Diff from LM - Revenue":{"rv":-0.0100216926,"fv":"\u003cSPAN STYLE=\"COLOR: #f00\" \u003e(1.00%)\u003c/SPAN\u003e","mi":2},"Last Year's Revenue":{"rv":80602.9500000006,"fv":"$80,603","mi":3},"% Diff from TM LY - Revenue":{"rv":0.4559622197,"fv":"45.60%","mi":4}}}]}]}}}}