Documentation Index
Fetch the complete documentation index at: https://docs.thenewscc.com.br/llms.txt
Use this file to discover all available pages before exploring further.
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
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
| Endpoint | Método | Descrição |
|---|
| /relatorios/dashboard | GET | Dashboard geral com métricas principais |
| /relatorios/detalhado | POST | Relatório completo com todos os filtros |
| /relatorios/agentes | GET | Performance dos agentes |
| /relatorios/issues | GET | Tendências de issues |
| /relatorios/cohorts | GET | Análise de cohorts |
| /relatorios/distribuicao | GET | Distribuição por hora/dia/newsletter |
| /relatorios/resumo | GET | Resumo rápido (últimos 30 dias) |
| /relatorios/comparativo | GET | Comparativo entre períodos |
| /relatorios/serie-temporal | GET | Série temporal de tickets |
| /relatorios/resolucao | GET | Métricas de resolução |
| /relatorios/filtros | GET | Filtros disponíveis |
Filtros Comuns
A maioria dos endpoints aceita os seguintes filtros:
| Parâmetro | Tipo | Descrição |
|---|
data_inicio | string | Data de início (YYYY-MM-DD) |
data_fim | string | Data de fim (YYYY-MM-DD) |
main | string | Categoria principal |
issue | string | Issue específico |
status | string | Status do ticket |
newsletter | string | Newsletter relacionada |
agente | string | Email do agente |
agrupar_por | string | Agrupamento: hora, dia, semana, mes, ano |
Categorias Principais
| Categoria | Descrição |
|---|
Programa de indicação e prêmios | Dú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 cadastro | Problemas com entrega de newsletters |
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}
