/api/dataSets/:id/data
Loads dataset data.
Resource Information
Resource URL | |
---|---|
HTTP Method |
|
Request Parameters
Parameters | Detail | Example |
---|---|---|
id | ID of the data set to fetch. You can find the ID in the response to /api/dataSets . | 123 |
| (Optional) If set, the result only contains data sets that contain the filter text in name. | Sales |
| (Optional) Specifies the page offset if pagination is necessary. | 2 |
| (Optional) Specifies the number of entries on each page if pagination is necessary. | 15 |
Response Structure
{ "dataSet" : { ... }, "data" : [ { "UID" : 123456, "L_ATTRIBUTE" : "value", "M_INDICATOR" : 11.99 }, { "UID" : 123457, "L_ATTRIBUTE" : "value2", "M_INDICATOR" : 22.08 } ] }
JSON response contains 2 elements dataSet that contains detailed information about data set (see GET Data Set Detail) and data which contains array of data rows in following strcuture:
Name | Description |
---|---|
UID | Unique ID of data row. |
L_* | Attribute values contained in the data row. |
M_* | Indicator values contained in the data row. |
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/dataSet/123/data
The JSON format response:
{ "dataSet" : { "id" : 123, "name" : "My test data set", "localization" : { "de" : "Deutsch Name" }, "description" : "This is a sample data set.", "owner" : "John Smith", "lastChange" : "Tue, 22 May 2012 17:16:31 GMT", "attributes" : [ { "id" : "123.FO8j1HfdDz", "name" : "City", "code" : "L_CITY", "type" : "String" } ], "indicators" : [ { "id" : "123.8RnLDOwZnY", "name" : "Count", "type" : "DATA_INDICATOR", "code" : "M_COUNT" }, { "id" : "123.Jiq7Cuyai1", "name" : "Calculated indicator", "type" : "FORMULA_INDICATOR", "formula" : "M_COUNT * 1000" }, { "id" : "123.MrrmQgYyyo", "name" : "Indicator group", "type" : "INDICATOR_GROUP" } ], "reports" : [ { "id" : 7497, "name" : "My Report", "description" : "This is a sample report.", "owner" : "John Smith", "lastChange" : "Mon, 16 Apr 2012 10:17:26 GMT" } ] }, "data" : [ { "UID" : 123456, "L_ATTRIBUTE" : "value", "M_INDICATOR" : 11.99 }, { "UID" : 123457, "L_ATTRIBUTE" : "value2", "M_INDICATOR" : 22.08 } ] }
Overview
Content Tools