6. Data API
The Data API mainly handles everything related retrieving and deleting historical data of the system.
Key features:
- Retrieving Device Activity Logging (DAL) data
- Retrieving images captured by cameras
- Retrieving utility (e.g. electric consumption) data
- Retrieving Insight reports (enhanced data)
- Managing report subscriptions (send via e-mail)
- Uploading log files to the Device Management Portal
Details to all Data API endpoints & entities can be found in the Data API Reference.
Data Domain Model
| Entity | Description |
|---|---|
| TrackData | The TrackData entity describes all attributes and properties in context with a device activity (DAL). |
| DeviceSurvey | The DeviceSurvey entity describes all attributes and properties in context with a device survey (DAL). |
| Image | The Image entity describes all attributes and properties in context with an image. |
| ReportData | The ReportData entity describes all attributes and properties in context with reporting data. |
| UtilityEntity | A data entry inside the ReportData entity. |
| ReportSubscription | The ReportSubscription entity describes all attributes and properties in context with e-mail subscriptions for reports. |
| Insight | The Insight entity describes all attributes and properties in context with insight reports. |