Qodex.ai

Get the results of a report instance

GET {{baseUrl}}/api/v2/reports/:reportId/instances/:instanceId

Get the results of a previously created report instance, using the in-memory report instance created by a POST /reports/{reportId}/instances request. 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 and report instance ID in the path of the request. You use the offset and limit query parameters in the requestto determine the report data displayed on the page.

Request Params

KeyDatatypeRequiredDescription
offsetnumberMaximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit.
limitnumberMaximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit.
standardDateFormatbooleanStandard date format in ISO8601
standardRawDateFormatbooleanStandard raw date format in ISO8601
fieldsnullField selector. This allows client to exclude unneeded information from response model. It can be either empty, or a combination of following exclusion rules separated by comma: '-data.metricValues.raw' / '-data.metricValues.formatted' / '-data.metricValues.extras'.

HEADERS

KeyDatatypeRequiredDescription
X-MSTR-AuthTokenstring(Required) Authorization token
X-MSTR-ProjectIDstring(Required) Project ID
PreferstringPrefer--allow client to set preferences. Currently, respond-async allows client to execute in async mode

RESPONSES

status: OK

{"name":"Monthly Sales vs LM \u0026 LY (1:1 transformations)","id":"020E95484AE99C908F11A9ADCA0AFFB0","instanceId":"D9CB2A926844286FA61DFAB42B9FA6A3","status":1,"definition":{"grid":{"crossTab":false,"metricsPosition":{"axis":"columns","index":0},"rows":[{"name":"Quarter","id":"8D679D4A11D3E4981000E787EC6DE8A4","type":"attribute","forms":[{"id":"CCFBE2A5EADB4F50941FB879CCF1721C","name":"DESC","dataType":"varChar","baseFormCategory":"DESC","baseFormType":"text"}],"elements":[{"formValues":["2016 Q1"],"id":"h20161;8D679D4A11D3E4981000E787EC6DE8A4"},{"formValues":["2016 Q2"],"id":"h20162;8D679D4A11D3E4981000E787EC6DE8A4"},{"formValues":["2016 Q3"],"id":"h20163;8D679D4A11D3E4981000E787EC6DE8A4"},{"formValues":["2016 Q4"],"id":"h20164;8D679D4A11D3E4981000E787EC6DE8A4"}]},{"name":"Month","id":"8D679D4411D3E4981000E787EC6DE8A4","type":"attribute","forms":[{"id":"CCFBE2A5EADB4F50941FB879CCF1721C","name":"DESC","dataType":"varChar","baseFormCategory":"DESC","baseFormType":"text"}],"elements":[{"formValues":["Jan 2016"],"id":"h201601;8D679D4411D3E4981000E787EC6DE8A4"},{"formValues":["Feb 2016"],"id":"h201602;8D679D4411D3E4981000E787EC6DE8A4"},{"formValues":["Mar 2016"],"id":"h201603;8D679D4411D3E4981000E787EC6DE8A4"},{"formValues":["Apr 2016"],"id":"h201604;8D679D4411D3E4981000E787EC6DE8A4"},{"formValues":["May 2016"],"id":"h201605;8D679D4411D3E4981000E787EC6DE8A4"},{"formValues":["Jun 2016"],"id":"h201606;8D679D4411D3E4981000E787EC6DE8A4"},{"formValues":["Jul 2016"],"id":"h201607;8D679D4411D3E4981000E787EC6DE8A4"},{"formValues":["Aug 2016"],"id":"h201608;8D679D4411D3E4981000E787EC6DE8A4"},{"formValues":["Sep 2016"],"id":"h201609;8D679D4411D3E4981000E787EC6DE8A4"},{"formValues":["Oct 2016"],"id":"h201610;8D679D4411D3E4981000E787EC6DE8A4"},{"formValues":["Nov 2016"],"id":"h201611;8D679D4411D3E4981000E787EC6DE8A4"},{"formValues":["Dec 2016"],"id":"h201612;8D679D4411D3E4981000E787EC6DE8A4"}]}],"columns":[{"name":"Metrics","id":"00000000000000000000000000000000","type":"templateMetrics","elements":[{"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}}]}],"pageBy":[{"name":"Category","id":"8D679D3711D3E4981000E787EC6DE8A4","type":"attribute","forms":[{"id":"CCFBE2A5EADB4F50941FB879CCF1721C","name":"DESC","dataType":"varChar","baseFormCategory":"DESC","baseFormType":"text"}],"elements":[{"formValues":["Books"],"id":"h1;8D679D3711D3E4981000E787EC6DE8A4"},{"formValues":["Electronics"],"id":"h2;8D679D3711D3E4981000E787EC6DE8A4"},{"formValues":["Movies"],"id":"h3;8D679D3711D3E4981000E787EC6DE8A4"},{"formValues":["Music"],"id":"h4;8D679D3711D3E4981000E787EC6DE8A4"}]}],"subtotals":{"defined":false,"visible":true},"sorting":{"rows":[],"columns":[],"pageBy":[]},"thresholds":[]}},"data":{"currentPageBy":[0],"paging":{"total":12,"current":12,"offset":0,"limit":1000},"headers":{"rows":[[0,0],[0,1],[0,2],[1,3],[1,4],[1,5],[2,6],[2,7],[2,8],[3,9],[3,10],[3,11]],"columns":[[0,1,2,3,4]]},"metricValues":{"raw":[[77866,80602.9500000006,-0.0339559532,58185,0.3382486895],[75226,77866,-0.0339043999,63239,0.1895507519],[85204,75226,0.1326403105,67411,0.2639480204],[85174.1999999989,85204,-0.0003497488,64017.6,0.3304809927],[92501.8999999987,85174.1999999989,0.0860319205,67418.7999999997,0.3720490427],[88470,92501.8999999987,-0.0435872128,72064,0.2276587478],[86596.0000000002,88470,-0.0211823217,75499.4000000003,0.1469760025],[93610.9999999995,86596.0000000002,0.0810083607,76428.8999999998,0.2248115569],[93727.4999999995,93610.9999999995,0.0012445119,79870.6999999998,0.1734904039],[107422,93727.4999999995,0.146109733,81610,0.316284769],[118542.850000002,107422,0.1035248832,81859.1500000006,0.4481319437],[117354.850000003,118542.850000002,-0.0100216926,80602.9500000006,0.4559622197]],"formatted":[["$77,866","$80,603","\u003cSPAN STYLE=\"COLOR: #f00\" \u003e(3.40%)\u003c/SPAN\u003e","$58,185","33.82%"],["$75,226","$77,866","\u003cSPAN STYLE=\"COLOR: #f00\" \u003e(3.39%)\u003c/SPAN\u003e","$63,239","18.96%"],["$85,204","$75,226","13.26%","$67,411","26.39%"],["$85,174","$85,204","\u003cSPAN STYLE=\"COLOR: #f00\" \u003e(0.03%)\u003c/SPAN\u003e","$64,018","33.05%"],["$92,502","$85,174","8.60%","$67,419","37.20%"],["$88,470","$92,502","\u003cSPAN STYLE=\"COLOR: #f00\" \u003e(4.36%)\u003c/SPAN\u003e","$72,064","22.77%"],["$86,596","$88,470","\u003cSPAN STYLE=\"COLOR: #f00\" \u003e(2.12%)\u003c/SPAN\u003e","$75,499","14.70%"],["$93,611","$86,596","8.10%","$76,429","22.48%"],["$93,727","$93,611","0.12%","$79,871","17.35%"],["$107,422","$93,727","14.61%","$81,610","31.63%"],["$118,543","$107,422","10.35%","$81,859","44.81%"],["$117,355","$118,543","\u003cSPAN STYLE=\"COLOR: #f00\" \u003e(1.00%)\u003c/SPAN\u003e","$80,603","45.60%"]],"extras":[[{},{},{},{},{}],[{},{},{},{},{}],[{},{},{},{},{}],[{},{},{},{},{}],[{},{},{},{},{}],[{},{},{},{},{}],[{},{},{},{},{}],[{},{},{},{},{}],[{},{},{},{},{}],[{},{},{},{},{}],[{},{},{},{},{}],[{},{},{},{},{}]]}}}