/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

GET

Request Parameters

Parameters

Detail

Example

id

ID of the table. This ID is part of the /api/reports/:id response.

123

Response Structure

{ 
  "indicators" : [
	{
		 ...
	},
	{
		...
	}
  ]
 
}

JSON response contains array of indicators. Each contains multiple objects with following definition:

NameDescription
showAsRankBoolean value defining if the indicators should be displayed as rank
dateAggregationTypeDefault date aggregation of this indicator (e.g. Sum)
nameName of the indicator
dataSetIndicatorCode of the indicator (M_INDICATOR)
typeType 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

  • No labels