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 in the 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.
Submit a background request for generating complex or long‑running reports without blocking the client.
Integrate asynchronous workflows that rely on report generation jobs running in the background.
Retrieve a previously generated report using its specific parameters or identifier, enabling customers to access reports at any time.
Support portals or dashboards where users can download reports generated earlier by background processes.
Provide flexibility between synchronous and asynchronous report generation depending on complexity, urgency, or performance needs.
Resources
Key features
This API enables users to:
- Retrieves a report synchronously based on specific input parameters. The request triggers the generation of the report and immediately returns the resulting file once ready.
- Submits a background job to generate a report asynchronously. The client does not wait for completion and can retrieve the result later once processing is finished.
- Fetches a previously generated report using defined input parameters or identifiers. Does not trigger new generation—returns an existing report already produced by the system.
- Provides metadata for a specific report, including required and optional input parameters. Helps clients understand how to correctly request or generate that report.
- Returns the full list of reports available to the customer, including each report’s name and description, enabling discovery and selection of reporting options.