/api/reports/views/:id/table/indicators
This method returns table indicators.
Resource Information
Resource URL | https://service.belladati.com/api/reports/views/:id/table/indicators |
HTTP Method |
|
Request Parameters
Parameters | Detail | Example |
---|---|---|
| ID of the table. This ID is part of the | 123 |
Response Structure
{ "indicators" : [ { ... }, { ... } ] }
JSON response contains array of indicators. Each contains multiple objects with following definition:
Name | Description |
---|---|
showAsRank | Boolean value defining if the indicators should be displayed as rank |
dateAggregationType | Default date aggregation of this indicator (e.g. Sum) |
name | Name of the indicator |
dataSetIndicator | Code of the indicator (M_INDICATOR) |
type | Type of the indicator (dataSetIndicator, formulaIndicator) |
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/indicators
The JSON format response:
{ "indicators": [ { "showAsRank": false, "dateAggregationType": "Sum", "name": "Margin", "dataSetIndicator": "M_MARGIN", "id": "AVn6TNRofe", "type": "dataSetIndicator" }, { "name": "New indicator", "formula": "if (M_MARGIN==443038){\r\n return 'test'\r\n}", "id": "7as7FSMLAb", "type": "formulaIndicator" }, { "name": "New indicator (2)", "formula": "M_MARGIN*-1", "id": "CZZTlJdNU5", "type": "formulaIndicator" } ] }
Next steps
Overview
Content Tools