- Created by Lubomir Micko, last modified by Ayumi Yasuda on Apr 07, 2023
You have Slovak selected as language but this page has not been translated yet. Translate the page or view the content in the default space language below.
Display default/api/reports/views/:id/table/json
This method returns table in JSON format.
Resource Information
Resource URL | https://service.belladati.com/api/reports/views/:id/table/json |
HTTP Method |
|
Request Parameters
Parameters | Detail | Example | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ID of the table. This ID is part of the | 123 | ||||||||||||||
| (Optional) Filter applied to the table, with following structure:
| { "drilldown": { "L_COUNTRY_OR_AREA": { "op": "EQ", "value": "Slovakia" }, "L_TYPE": { "op": "IN", "values": [ "Type 1", "Type 2", "Type 3" ] }, "L_DATE": { "op": "NOT_NULL" }, "L_PRODUCT":{ "op":"COUNT", "countOp":"LTE", "value":"816" } } } Example of a between filter: {"drilldown":[{"L_ID":{"op":"GT","value":"10"}},{"L_ID":{"op":"LT","value":"20"}}]} | ||||||||||||||
combineFilters | If any static filter is present, filter set in this request will combine with static filter set in view | true | ||||||||||||||
drilldownConfig | (Optional) Replaces the table drill-down with custom configuration. Both horizontal and vertical drill-down configurations can be replaced. Each configuration is an array with the following elements:
| { "horizontal":[ { "dataSetDrilldownAttribute":"L_PRODUCT_TYPE", "hideDataSetCustomMembers": false, "limit": "ALL" }, { "dataSetDrilldownAttribute":"L_PRODUCT", "dataSetDrilldownAttributeSubset": "TdPgywXkmB", "hideDataSetCustomMembers": true, "limit": 1000 } ], "vertical":[ { "dataSetDrilldownAttribute":"L_DATE", "dataSetDrilldownAttributeSubset":"0EE39yrVHY", "hideDataSetCustomMembers": false } ] } | ||||||||||||||
subsetValueId | If defined, response will return value for selected member of the subset. In case, this parameter is combined with expand = true, all child of the selected member will be loaded. | subsetValueId=F2Qx2LrYRX | ||||||||||||||
expand | Will expand all available drill-downs. Available values: true / false | expand=true |
Response Structure
{ "rowsCount" : ..., "name" : ..., "header" : [ ], "body" : [ ] }
JSON response contains elements with following definition:
Name | Description |
---|---|
rowsCount | Total number of rows including headers and data |
name | Table view name |
header | Array containing header elements |
body | Array containing data elements |
Sample request/response
Using curl
:
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/reports/views/1234/table/json
The JSON format response:
{ "rowsCount" : 5, "name" : "My Table Name", "header" : [ [ { "value" : "", "type" : "header" } ], [ { "value" : "", "type" : "header" } ] ], "body" : [ [ { "value" : "Value", "type" : "header" }, { "style" : " color:rgb(77, 77, 77) !important ; background-color:rgb(237, 237, 237); ", "value" : "1,033,054,533,155" } ], [ { "value" : "Value Footnotes", "type" : "header" }, { "style" : " color:rgb(77, 77, 77) !important ; background-color:rgb(237, 237, 237); ", "value" : "1" } ], [ { "value" : "B", "type" : "header" }, { "style" : " color:rgb(77, 77, 77) !important ; background-color:rgb(237, 237, 237); ", "value" : "5" } ] ] }
Next steps
- No labels