Introduction to Custom Reports

Overview

The Custom Reports gadget is a powerful feature in Dashboard Hub that lets you integrate data from any product with a REST API into your dashboards. Unlike traditional gadgets tied to predefined datasources, Custom Reports removes these limitations, allowing you to create highly tailored reports by fetching data from virtually any external API.

Open

What is a REST API-based report?

REST API-based reports retrieve data directly from external systems using REST APIs. These reports let you define API endpoints, parameters, and filters to retrieve specific data. This data is then transformed into visual reports, such as charts or tables, within the dashboard. REST API-based reports are ideal for integrating data from products like monday.com, Jira, Bitbucket, 7pace GitHub, GitLab, Zendesk, custom CRM or ERP systems, or other platforms, enabling centralized analysis and reporting.

Key features

1. Flexible data integration: Connect to APIs beyond the existing integrations provided by Dashboard Hub. Retrieve data from external systems, such as open APIs or private services, using REST API calls.

2. Customizable gadgets: Define every detail of the gadget's user interface with a descriptor file in JSON5 format. This includes layout, colors, and data presentation (text, tables, charts).

3. Advanced security: Authenticate securely using methods such as Basic Authentication, Bearer Tokens, or API Keys, ensuring reliable and secure data access while maintaining best practices.

4. Powerful data contexts: Combine data from multiple endpoints into a unified context. Query, filter, and visualize this data within the gadget using JSONata.

5. Reusable reports: Save and export reports as JSON files, to share designs, integrations, or collaborate on custom new visualizations.

Example use cases

• Simple reports: Display data from public APIs, such as weather or news updates, and display it on your dashboard.

• Advanced reports: Connect to authenticated APIs and create reports with combined data from multiple endpoints, using variables and filters for granular insights.

Use Custom Reports to break data silos, creating dashboards that integrate information from any source with full control over presentation and functionality. See the Custom report example to learn more.

See also

• Custom Reports templates

• Configure a REST API datasource for Custom Reports

• Query and Transform your Data with JSONata

• Nodes as building blocks for Custom Reports