Skip to main content

Reports & Dashboards API

The Reports API provides endpoints for building and managing custom dashboards, calculating widget data, and generating report templates. Create interactive visualizations of emissions data with configurable metrics, periods, and aggregation across organizations and facilities.
New API: These endpoints are part of the new API architecture.

Key Features

  • Custom Dashboards: Create and configure dashboards per project with responsive grid layouts
  • Widget Templates: Quick-start with predefined templates for carbon footprint, waste, water, and logistics visualizations
  • Dynamic Calculations: Calculate widget data with flexible metrics, filters, and period configurations
  • Dashboard Comments: Collaborate by adding comments to individual widgets
  • Report Builder: Upload and manage report models with presigned URL support
  • Multi-language: Widget templates available in English, Spanish, Portuguese, Catalan, German, and Italian

Authentication

All endpoints require authentication using an API key included in the x-api-key header.

Headers

All requests must include:
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa
string
required
Your API key for authenticationExample: sk_live_1234567890abcdef

Data Model

Dashboard Object

A dashboard contains a responsive grid layout and a collection of widgets:

Widget Configuration

Widgets are calculated using a flexible metric/filter/period configuration:

Dashboard Comment Object

Dashboard Attributes

Layout Item Attributes

Widget Templates

Create widgets instantly from predefined templates:

Error Handling

Common HTTP Status Codes

Common Use Cases

Create a dashboard with a template widget

Calculate custom widget data

Add a comment to a widget

Emissions API

View aggregated emissions summaries

Projects API

Manage projects linked to dashboards

Facilities API

Manage facilities referenced in widgets

Automation Guide

Automate report generation pipelines