Skip to main content

Visão Geral

A API de relatórios do SAC fornece endpoints completos para análise de dados, métricas de performance, tendências e distribuição de tickets. Todos os endpoints de relatórios utilizam cache KV com TTL de 2 horas para otimização de performance.

Características

  • Cache inteligente: Respostas cacheadas por 2 horas no Cloudflare KV
  • Filtros avançados: Data, categoria, issue, status, newsletter, agente
  • Agrupamento temporal: Por hora, dia, semana, mês ou ano
  • Métricas de cache: Headers indicam hit/miss e tempo de expiração

Headers de Cache

Todas as respostas incluem informações sobre o cache:
X-Cache: HIT | MISS
X-Cache-Age: 300s
X-Cache-Expires-In: 7200s

Endpoints Disponíveis

EndpointMétodoDescrição
/relatorios/dashboardGETDashboard geral com métricas principais
/relatorios/detalhadoPOSTRelatório completo com todos os filtros
/relatorios/agentesGETPerformance dos agentes
/relatorios/issuesGETTendências de issues
/relatorios/cohortsGETAnálise de cohorts
/relatorios/distribuicaoGETDistribuição por hora/dia/newsletter
/relatorios/resumoGETResumo rápido (últimos 30 dias)
/relatorios/comparativoGETComparativo entre períodos
/relatorios/serie-temporalGETSérie temporal de tickets
/relatorios/resolucaoGETMétricas de resolução
/relatorios/filtrosGETFiltros disponíveis

Filtros Comuns

A maioria dos endpoints aceita os seguintes filtros:
ParâmetroTipoDescrição
data_iniciostringData de início (YYYY-MM-DD)
data_fimstringData de fim (YYYY-MM-DD)
mainstringCategoria principal
issuestringIssue específico
statusstringStatus do ticket
newsletterstringNewsletter relacionada
agentestringEmail do agente
agrupar_porstringAgrupamento: hora, dia, semana, mes, ano

Categorias Principais

CategoriaDescrição
Programa de indicação e prêmiosDúvidas e problemas com o sistema de indicações
Streak (pontuação diária)Issues relacionados ao sistema de streaks
Problemas de recebimento das edições e cadastroProblemas com entrega de newsletters

Cache e Performance

Configuração

  • TTL: 2 horas (7200 segundos)
  • Storage: Cloudflare KV
  • Timeout: 100ms para operações de cache

Invalidação Automática

O cache é invalidado quando:
  • Um novo ticket é criado
  • O status de um ticket é alterado
  • Um ticket é deletado
  • Uma mensagem é adicionada

Autenticação

Todos os endpoints requerem autenticação via JWT:
Authorization: Bearer {token}