Reference

`dashboard`

Base path: /api/v1/dashboard

The dashboard module is the read-only metrics layer. It exposes aggregated views over campaigns, agent runs, leads, deliverability, and credit usage so you can build internal dashboards, weekly reports, or anomaly alerts without recomputing the underlying state. Resources include campaign metrics, agent cost summaries, lead pipeline counts, deliverability rates, and connector health rollups. Schemas live in app/modules/dashboard/schemas.py.

What you can do with the dashboard API

Fetch campaign-level send, open, click, reply, and meeting-booked metrics
Pull agent runtime cost grouped by agent slug and date
Get lead pipeline counts by stage, score band, or segment
Read deliverability rollups (bounce, complaint, inbox-placement proxies)
Spot connector health regressions before they affect a campaign

Common operations

Get a single campaign’s full metric envelope
List recent runs for an agent with their cost and latency
Pull lead pipeline counts for a date range
Fetch this month’s credit usage against the plan cap
Get a workspace-wide rollup for an executive view

Authentication & scoping

Workspace-scoped via API key in the Authorization: Bearer tnx_... header. Read-only by design; mutations happen in the originating module (marketing, agents, crm).

Pagination & filtering

Time-series endpoints accept from, to, and granularity (hour, day, week). List endpoints use the standard cursor pagination. See Pagination.

What you can do with the dashboard API for internal reporting

Most teams use it for three things: a Monday morning email with last week’s pipeline movement, an in-Slack alert when a campaign deliverability dips, and a CSV export of agent cost for monthly finance reconciliation.

MCP equivalents

MCP prompt

get_dashboard_summary({ window: "last_7d" })