GET /v1/analytics/dashboard — Analytics

This endpoint returns the same data shown in the dashboard (KPIs and daily series), already scoped to the API key’s number.

Endpoint

GET https://pilotstatus.com.br/v1/analytics/dashboard

Query parameters

string

default:"30d"

Reporting window. One of 7d, 30d (default), or 90d.

string

Optional IANA timezone, e.g. America/Sao_Paulo. timezone is accepted as an alias of tz.

Example

curl "https://pilotstatus.com.br/v1/analytics/dashboard?tz=America/Sao_Paulo" \
  -H "x-api-key: ps_your_key_here"

curl "https://pilotstatus.com.br/v1/analytics/dashboard?tz=America/Sao_Paulo" \
  -H "x-api-key-id: ck_xxx"

{
  "totalSent": 120,
  "totalFailed": 3,
  "sentPercentChange": 0,
  "failedPercentChange": 0,
  "failureRate": 2.44,
  "dailyMessages": [
    { "date": "2026-02-24", "count": 10 },
    { "date": "2026-02-25", "count": 40 }
  ],
  "statusDistribution": {
    "queued": 10.0,
    "sent": 80.0,
    "failed": 2.5,
    "read": 7.5
  }
}

Common errors

401 — missing/invalid API key header (x-api-key/x-api-key-id).
403 — a tenant-scoped key was used on this number-scoped endpoint (code: "TENANT_SCOPE_NOT_ALLOWED").

Overview

Messaging

Templates

Numbers

Conversations & Data

Webhooks

Voice Calls

API Layer

Account & Billing

Branding & Embedding

GET /v1/analytics/dashboard — Analytics

Endpoint

Query parameters

Example

Common errors

​Endpoint

​Query parameters

​Example

​Common errors

Endpoint

Query parameters

Example

Common errors