Skip to content

Dashboards API

Query dashboard data and configure report settings programmatically.

Who this is for

Developer Admin

Endpoints

Method Path Description
GET /v1/dashboards List available dashboards
GET /v1/dashboards/{id} Get dashboard data
GET /v1/dashboards/{id}/widgets Get widget configurations
POST /v1/dashboards/{id}/export Export dashboard

Get dashboard data

GET /v1/dashboards/exec_rollup?period=quarter&date=2026-Q2

Dashboard types:

ID Type Description
exec_rollup Executive Portfolio-level KPIs and trends
portfolio_health Portfolio Initiative health, risk flags
team_status Team Project status, milestones
individual_work Individual My initiatives, tasks, approvals

Query parameters:

Parameter Type Default Description
period string month week, month, quarter, year
date string current Period identifier (e.g., 2026-Q2)
filters object Additional filters

Export dashboard

POST /v1/dashboards/exec_rollup/export
Content-Type: application/json

{
  "format": "pdf",
  "include_charts": true,
  "recipients": ["exec@example.com"]
}

Permissions

Action Required Permission
List analytics:read
Get data analytics:read
Export analytics:read

Limits

Limit Dashboard queries: 30 per minute.

Limit Export size: 50 MB maximum.