Skip to main content
GET
Agency Overview Stats
One call for the whole agency: aggregate metrics, a row per workspace, line counts and subscription health.

Endpoint

  • Method: GET
  • Path: /api/agency/overview
  • Auth: Authorization: Bearer tucoagency_xxxxxxxxxxxxx (agency key)

Query parameters

Example request

Success response (200)

Reading it

  • metrics is the roll-up across every sub-workspace; perWorkspace is the same computation per workspace, so the rows sum to the totals.
  • statusCounts.attention counts workspaces in past_due, unpaid, incomplete, incomplete_expired or canceled — the ones whose billing needs you.
  • series.sent is a daily count for the last days calendar days including today, for a sparkline.
  • An agency with no workspaces yet returns zeros, never another agency’s numbers.

Error responses