Information on the API for retrieving specific data from the Control Center
You can easily retrieve all settings and information available in the Control Center via an API. Below you will find the Swagger documentation. Here is an example: BMA Control Center
In general, we stick to the OAuth 2.0 Client Credentials Flow (Microsoft) documented here.
Make sure to include your Tenant ID as a header in the authentication flow.
To get the first part of the URL for your specific API documentation or Swagger UI, you can either contact our Support or retrieve it from the source code of your Control Center.
In our example, the URL is:
call the Swagger UI
the API call gives you information about the device status as follows
the different statuses of the devices are defined as follows in the API documentation
you can also retrieve the status of the individual streams. The API provides the following results
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 . Integration into third-party applications is quick and easy.
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.
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:
API-Response:
This access token is temporary. For permanent integration in third-party applications, you need a permanent token. Please contact our .
We strictly adhere to the OAuth flow documented by Microsoft. There are several that you can use.
The REST API is based on _Cube.js_. You can find more information and details about this and how it works in general in this .
