Skip to end of banner
Go to start of banner

Introduction to Custom Reports

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Overview

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

image-20241206-155338.png

Key Features

  1. Flexible Data Integration: Connect to APIs beyond the existing Dashboard Hub ecosystem. Use REST API calls to fetch data from external systems like open APIs or internal services.

  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.

  3. Advanced Security: Authenticate securely using methods like Basic Authentication, Bearer Tokens, or API Keys, ensuring reliable data access while maintaining best practices.

  4. Powerful Data Contexts: Combine data from multiple endpoints into a unified context that you can query, filter, and visualize within the gadget using JSONata.

  5. Reusable Designs: Save and export gadgets as JSON files, called cartridges, to share designs or collaborate on new visualizations.

What is a REST API-based report?

REST API-based reports retrieve data directly from external systems using REST APIs. They allow users to define API endpoints, parameters, and filters to fetch 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 tools like http://monday.com , Jira, or other platforms, enabling centralized analysis and tracking.

Example Use Cases

  • Simple Reports: Configure a gadget to fetch public API data, 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.

Custom Reports empower you to break data silos, creating dashboards that integrate information from any source with full control over presentation and functionality.

  • No labels