Skip to main content

​
Dashboards API

The Dashboards API enables you to create, manage, and configure interactive dashboards for visualizing emissions data. Dashboards are linked to projects and contain responsive grid layouts with configurable widgets.
New API (v2): These endpoints use the latest dashboard architecture backed by PostgreSQL. Use /v2/dashboard for new integrations.

​
Key Features

  • Project-Linked Dashboards: Each dashboard belongs to a project and inherits its organization context
  • Responsive Layouts: Grid layouts adapt across breakpoints (lg, md, sm, xs, xxs)
  • Configurable Widgets: Add widgets for emissions, waste, water, logistics, and custom KPI visualizations
  • Organization Hierarchy: Child organizations can view parent dashboards (read-only)

​
Authentication

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

​
Available Endpoints

List Dashboards

List all dashboards for your organization

Get Dashboard

Retrieve a dashboard with widgets and layouts

Create Dashboard

Create a new dashboard for a project

Update Dashboard

Modify dashboard widgets and layouts

Delete Dashboard

Remove a dashboard

Projects API

Manage projects linked to dashboards

Emissions API

View aggregated emissions summaries

MCP Tools

Access dashboards from AI assistants via MCP