Data analytics API
REST API - Access to the underlying data from Data Analytics or the widgets via API
For each widget in Data Analytics, the underlying data can be queried via a provided REST API. Integration into third-party applications is quick and easy.
API call
As soon as you configure a widget, you will find the API Call item in the side menu. This option is available for every widget.
Execute the call accordingly and test it directly in the dialog box, including the response format, by clicking _Try it out!
The dialog box that appears contains detailed information about what the API call looks like for this widget's data. Copy the code provided and use it as required.
This access token is temporary. For permanent integration in third-party applications, you need a permanent token. Please contact our Support.
Authentication
We strictly adhere to the OAuth flow documented by Microsoft. There are several Client Libraries that you can use.
Example of a request
Bicycle counting
Below you can see a widget in Data Analytics that is used for bicycle counting. The corresponding widget type (Traffic Counting) has been selected, the data is aggregated per tag, broken down by object class and direction and filtered by bicycles.
API request
The API call shows the corresponding GET request for this data as shown below:
https://example.com/cubejs-api/v1/load?query=
{
"measures":[
"CrossingEvents.count"
],
"dimensions":[
"CrossingEvents.classification",
"CrossingEvents.direction"
],
"segments":[],
"filters":[
{
"member":"CrossingEvents.streamId",
"operator":"equals",
"values":[
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
]
},
{
"member":"CrossingEvents.classification",
"operator":"contains",
"values":[
"bicycle"
]
},
{
"member":"CrossingEvents.lineId",
"operator":"equals",
"values":[
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
]
}
],
"timeDimensions":[
{
"dimension":"CrossingEvents.timestamp",
"granularity":"day",
"dateRange":"This week"
}
],
"order":{}
}API-Response:
{
"queryType": "regularQuery",
"results": [
{
"query": {...},
"data": [
{
"CrossingEvents.classification": "bicycle",
"CrossingEvents.direction": "in",
"CrossingEvents.timestamp.day": "2021-11-02T00:00:00.000",
"CrossingEvents.timestamp": "2021-11-02T00:00:00.000",
"CrossingEvents.count": "235"
},
{
"CrossingEvents.classification": "bicycle",
"CrossingEvents.direction": "out",
"CrossingEvents.timestamp.day": "2021-11-02T00:00:00.000",
"CrossingEvents.timestamp": "2021-11-02T00:00:00.000",
"CrossingEvents.count": "234"
},
{
"CrossingEvents.classification": "bicycle",
"CrossingEvents.direction": "in",
"CrossingEvents.timestamp.day": "2021-11-03T00:00:00.000",
"CrossingEvents.timestamp": "2021-11-03T00:00:00.000",
"CrossingEvents.count": "203"
},
{
"CrossingEvents.classification": "bicycle",
"CrossingEvents.direction": "out",
"CrossingEvents.timestamp.day": "2021-11-03T00:00:00.000",
"CrossingEvents.timestamp": "2021-11-03T00:00:00.000",
"CrossingEvents.count": "249"
}
],
"annotation": {...}
}
],
"pivotQuery": {...}
}Extended documentation
Last updated