> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pilotstatus.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Analytics dashboard

> Returns aggregated send metrics for the linked number (chart-ready series). Accepts period (7d|30d|90d, default 30d) and timezone (or tz, default UTC). 409 if the key is not linked to a number. Requires a number-scoped key.

**Requires a number-scoped key.**



## OpenAPI

````yaml openapi.json GET /v1/analytics/dashboard
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/analytics/dashboard:
    get:
      tags:
        - Analytics
      summary: Analytics dashboard
      description: >-
        Returns aggregated send metrics for the linked number (chart-ready
        series). Accepts period (7d|30d|90d, default 30d) and timezone (or tz,
        default UTC). 409 if the key is not linked to a number. Requires a
        number-scoped key.


        **Requires a number-scoped key.**
      operationId: get_analytics_dashboard
      parameters:
        - name: period
          in: query
          required: false
          description: Time window (default 30d).
          schema:
            type: string
            description: ("7d" | "30d" | "90d")
          example: 30d
        - name: timezone
          in: query
          required: false
          description: 'Timezone (alias: tz; default UTC).'
          schema:
            type: string
            description: (string (IANA tz))
          example: America/Sao_Paulo
      responses:
        '200':
          description: Dashboard
          content:
            application/json:
              example:
                period: 30d
                totals:
                  sent: 1280
                  delivered: 1240
                  read: 980
                  failed: 12
                series:
                  - date: '2026-06-19'
                    sent: 42
                    delivered: 41
                    read: 33
                    failed: 0
        '400':
          description: Invalid payload or parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Missing or invalid `x-api-key` / `x-api-key-id` header
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Tenant-scoped key used on a number-scoped endpoint
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Tenant-scoped keys cannot call number endpoints
                code: TENANT_SCOPE_NOT_ALLOWED
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````