Exportações
Endpoints para exportação de relatórios consolidados.
Exportar Relatório Consolidado
GET /api/exports
Gera um relatório consolidado com clientes, respostas e cupons dos últimos 90 dias.
Dados incluídos:
- Total de respostas por empresa
- Classificação NPS (Promotores, Neutros, Detratores)
- Cupons criados e utilizados
- NPS por critério (Atendimento, Ambiente, etc.)
Casos de uso:
- Gerar relatórios gerenciais
- Alimentar dashboards externos
- Análise consolidada de performance
Exemplo de Requisição
bash
curl -X GET "https://api-b2s.experienciab2s.com/api/exports" \
-H "Authorization: Bearer SEU_TOKEN"Resposta de Sucesso (200)
json
[
{
"total": 80,
"clients": 0,
"promoter": 80,
"detractor": 0,
"neutral": 0,
"company": "Empresa 1",
"uf": "MG",
"nps": 100,
"couponsCreated": 0,
"couponsUsed": 0,
"criteria": [
{ "name": "Atendimento", "nps": 100 },
{ "name": "Ambiente", "nps": 75 },
{ "name": "Tempo de espera", "nps": 95 }
]
}
]Estrutura da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
total | integer | Total de respostas no período |
clients | integer | Número de clientes únicos |
promoter | integer | Quantidade de promotores (NPS 9-10) |
detractor | integer | Quantidade de detratores (NPS 0-6) |
neutral | integer | Quantidade de neutros (NPS 7-8) |
company | string | Nome da empresa |
uf | string | Estado da empresa |
nps | integer | Score NPS calculado |
couponsCreated | integer | Quantidade de cupons criados |
couponsUsed | integer | Quantidade de cupons utilizados |
criteria | array | NPS por critério avaliado |
Estrutura do Critério
| Campo | Tipo | Descrição |
|---|---|---|
name | string | Nome do critério |
nps | integer | Score NPS do critério |
Códigos de Resposta
| Código | Descrição |
|---|---|
| 200 | Relatório gerado com sucesso |
| 401 | Token ausente ou inválido |
| 403 | Token inválido ou usuário não autorizado |
| 404 | Token de integração não encontrado |
