Reports
Reports
The Reports API provides endpoints for retrieving and managing reporting data within the system.
Description
The Reports API provides a standardized interface for retrieving and managing reporting data generated within the system. It enables clients to retrieve report details, the actual report (in live or background) for a specific report.
Use Cases
The Reports API may be used by client applications wishing to:
Allow customers to view the full catalog of reports available to them on the IoT Platform.
Provide user interfaces or partner systems with metadata such as name and description for each available report.
Retrieve detailed information about a specific report, including required input parameters and configuration details.
Enable dynamic UI generation by fetching parameter definitions needed before generating a report.
Generate and retrieve a report synchronously when immediate results are needed.
Allow customers or systems to download on‑demand reports by supplying specific input parameters.
Resources
Key features
- Retrieve details of specific report.
- Retrieve list of all reports available to the customer on IoT Platform.
- Retrieve a report using specific input parameters.