Skip to content

Exportaciones

Endpoints para exportación de informes consolidados.

Exportar Informe Consolidado

GET /api/exports

Genera un informe consolidado con clientes, respuestas y cupones de los últimos 90 días.

Datos incluidos:

  • Total de respuestas por empresa
  • Clasificación NPS (Promotores, Neutros, Detractores)
  • Cupones creados y utilizados
  • NPS por criterio (Atención, Ambiente, etc.)

Casos de uso:

  • Generar informes gerenciales
  • Alimentar dashboards externos
  • Análisis consolidado de desempeño

Ejemplo de Solicitud

bash
curl -X GET "https://api-b2s.experienciab2s.com/api/exports" \
     -H "Authorization: Bearer SU_TOKEN"

Respuesta Exitosa (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": "Atención", "nps": 100 },
      { "name": "Ambiente", "nps": 75 },
      { "name": "Tiempo de espera", "nps": 95 }
    ]
  }
]

Estructura de la Respuesta

CampoTipoDescripción
totalintegerTotal de respuestas en el período
clientsintegerNúmero de clientes únicos
promoterintegerCantidad de promotores (NPS 9-10)
detractorintegerCantidad de detractores (NPS 0-6)
neutralintegerCantidad de neutros (NPS 7-8)
companystringNombre de la empresa
ufstringEstado de la empresa
npsintegerScore NPS calculado
couponsCreatedintegerCantidad de cupones creados
couponsUsedintegerCantidad de cupones utilizados
criteriaarrayNPS por criterio evaluado

Estructura del Criterio

CampoTipoDescripción
namestringNombre del criterio
npsintegerScore NPS del criterio

Códigos de Respuesta

CódigoDescripción
200Informe generado exitosamente
401Token ausente o inválido
403Token inválido o usuario no autorizado
404Token de integración no encontrado

Integration Documentation