Reports

A report is designed to provide a synthesized, insightful view of the data, making it an ideal support for decision-making and presentations. As standard exports, it can be both created on a one-off or recurring basis.

Reports vs. Exports

The export feature provides raw, unprocessed data in a structured format, making it suitable for external analysis or storage. In contrast, the report feature goes beyond raw data by applying transformations, aggregations, and visual enhancements such as charts and summaries.

Customizing report layout with JSON templates

To provide flexibility in report generation, you can pass a JSON template that defines the layout and structure of the report. This template enables precise control over how data is presented, leading to structured reports with text, tables, and visual elements such as charts. By using a JSON-based approach, reports can be dynamically configured and easily reused for consistent and meaningful data presentation.

Each JSON template consists of multiple elements, where each element represents a distinct section of the report. The key attributes of a template element are:

• type: Specifies the element type, which can be text, chart, or table.
• sources: Defines the parameters needed to retrieve the data that will populate the template element. Typically, a single source is used, but for charts with multiple plots, multiple source elements can be specified. Additionally, users can apply post-processing transformations to the retrieved data through the postProc parameter, allowing for advanced data manipulation before visualization.
• formats: Determines the formatting settings of the template element. For instance, a chart element may include attributes for chart type, colors, axis settings, and legends. If multiple source elements are provided, a corresponding formats entry must be specified for each source to ensure proper visualization.

For the complete API reference, please refer to the API documentation.