Métricas e visão geral da operação fiscal em tempo real.

Dashboard

O dashboard fornece uma visão consolidada da operação fiscal, incluindo estatísticas de documentos, empresas, webhooks e erros mais comuns. Ideal para monitoramento operacional e tomada de decisão.

Visão geral

O endpoint principal retorna um resumo completo do período atual (mês corrente), incluindo totais, taxas de sucesso e distribuição por tipo de documento.

GET https://fiscal.contora.com.br/api/v1/dashboard

{
  "ok": true,
  "data": {
    "period": "2026-07",
    "documents": {
      "total": 1250,
      "authorized": 1180,
      "rejected": 45,
      "pending": 25,
      "processing": 12,
      "by_type": {
        "nfe": 800,
        "nfce": 350,
        "cte": 100
      },
      "by_environment": {
        "producao": 1000,
        "homologacao": 250
      },
      "authorization_rate": 94.40
    },
    "companies": {
      "total": 15,
      "with_certificate": 12,
      "without_certificate": 3,
      "by_tax_regime": {
        "simples": 8,
        "presumido": 5,
        "mei": 2
      },
      "by_state": {
        "MG": 10,
        "SP": 3,
        "RJ": 2
      }
    },
    "webhooks": {
      "total": 450,
      "delivered": 430,
      "failed": 15,
      "pending": 5,
      "delivery_rate": 95.56
    },
    "top_errors": [
      {
        "code": "539",
        "message": "Duplicidade de NF-e",
        "count": 12
      },
      {
        "code": "254",
        "message": "CNPJ do destinatário inválido",
        "count": 8
      }
    ],
    "recent_activity": [
      {
        "id": "uuid-do-documento",
        "document_type": "nfe",
        "company": "Empresa Exemplo",
        "status": "authorized",
        "access_key": "00000000000000000000000000000000000000000000",
        "created_at": "2026-07-11T10:30:00-03:00"
      }
    ]
  }
}

Endpoints disponíveis

Série temporal de documentos

Para análises de tendência, use o endpoint de documentos com o parâmetro period. Os dados são agrupados por dia e incluem totais, autorizados e rejeitados.

GET https://fiscal.contora.com.br/api/v1/dashboard/documents?period=30d

{
  "ok": true,
  "data": {
    "period": "30d",
    "days": 30,
    "data": [
      {
        "date": "2026-07-01",
        "total": 45,
        "authorized": 42,
        "rejected": 3
      },
      {
        "date": "2026-07-02",
        "total": 52,
        "authorized": 50,
        "rejected": 2
      }
    ]
  }
}

Top erros SEFAZ

Identifique rapidamente os erros mais frequentes para priorizar correções e melhorar a taxa de autorização.

GET https://fiscal.contora.com.br/api/v1/dashboard/errors?limit=10

{
  "ok": true,
  "data": [
    {
      "code": "539",
      "message": "Duplicidade de NF-e",
      "count": 12
    },
    {
      "code": "254",
      "message": "CNPJ do destinatário inválido",
      "count": 8
    },
    {
      "code": "237",
      "message": "Código numérico inválido",
      "count": 5
    }
  ]
}

Filtros por empresa

Se o token estiver vinculado a um usuário, os dados são filtrados automaticamente pelas empresas daquele usuário. Para tokens de integração, todos os dados são retornados.

Uso recomendado

• Use /dashboard para telas de overview e monitoramento operacional.
• Use /dashboard/documents?period=30d para gráficos de tendência.
• Use /dashboard/errors para identificar problemas recorrentes.
• Combine com webhooks para alertas em tempo real de falhas.
• Os dados são calculados em tempo real - considere cache para dashboards com alto tráfego.