> ## 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.

# Dashboard de analytics

> Retorna métricas agregadas de envio do número vinculado (séries para gráficos). Aceita period (7d|30d|90d, padrão 30d) e timezone (ou tz, padrão UTC). 409 se a key não estiver vinculada a um número. Requer key escopada a número.

**Requer uma chave com escopo de número.**



## OpenAPI

````yaml openapi.pt.json GET /v1/analytics/dashboard
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `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: Dashboard de analytics
      description: >-
        Retorna métricas agregadas de envio do número vinculado (séries para
        gráficos). Aceita period (7d|30d|90d, padrão 30d) e timezone (ou tz,
        padrão UTC). 409 se a key não estiver vinculada a um número. Requer key
        escopada a número.


        **Requer uma chave com escopo de número.**
      operationId: get_analytics_dashboard
      parameters:
        - name: period
          in: query
          required: false
          description: Janela de tempo (padrão 30d).
          schema:
            type: string
            description: ("7d" | "30d" | "90d")
          example: 30d
        - name: timezone
          in: query
          required: false
          description: 'Fuso horário (alias: tz; padrão 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: Payload ou parâmetros inválidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Chave com escopo de tenant usada em endpoint com escopo de número
          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: Limite de taxa excedido
          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: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````