Skip to content

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

CampoTipoDescrição
totalintegerTotal de respostas no período
clientsintegerNúmero de clientes únicos
promoterintegerQuantidade de promotores (NPS 9-10)
detractorintegerQuantidade de detratores (NPS 0-6)
neutralintegerQuantidade de neutros (NPS 7-8)
companystringNome da empresa
ufstringEstado da empresa
npsintegerScore NPS calculado
couponsCreatedintegerQuantidade de cupons criados
couponsUsedintegerQuantidade de cupons utilizados
criteriaarrayNPS por critério avaliado

Estrutura do Critério

CampoTipoDescrição
namestringNome do critério
npsintegerScore NPS do critério

Códigos de Resposta

CódigoDescrição
200Relatório gerado com sucesso
401Token ausente ou inválido
403Token inválido ou usuário não autorizado
404Token de integração não encontrado

Integration Documentation