A API de NPS da OmniChat permite consultar os resultados das pesquisas de satisfação (NPS) realizadas com seus clientes. Esta documentação descreve o endpoint disponível, como autenticar e interpretar as respostas.
Endpoint
Método: GET
https://nps-survey-service.omni.chat/v1/surveys
Autenticação
Todas as requisições devem incluir o header de autorização com o token Bearer:
Authorization: Bearer <seu_token>
ℹ️ Para obter seu token de acesso, entre em contato com o suporte OmniChat ou acesse as configurações de API em sua conta.
Parâmetros de Consulta
A API aceita parâmetros opcionais de filtro por data, canal e identificador de loja. Consulte a documentação técnica completa em api-docs.omni.chat para ver a lista atualizada de parâmetros disponíveis.
Exemplos de Resposta
✅ Sucesso (200 OK)
{
"message": "success",
"results": {
"total": 100,
"passives": 25,
"promoters": 50,
"detractors": 25,
"surveys": [
{
"surveyId": "",
"retailerId": "retailer-1",
"channel": "WHATSAPP",
"name": "John Doe",
"phone": "+5511999999999",
"chatId": "chat-1",
"csrId": "csr-1",
"userId": "user-1",
"createdAt": "2026-01-02T14:45:54.978Z",
"score": 10,
"surveyComment": "",
"additionalInfo": { ... }
}
]
}
}
⚠️ Erro Interno (500 Internal Server Error)
{
"statusCode": 500,
"body": {
"i18nId": "FAILED_TO_QUERY_SURVEYS",
"message": "Internal server error"
}
}
💡 Dica: O campo score representa a nota de 0 a 10 dada pelo cliente. Use os campos promoters, passives e detractors para calcular o NPS consolidado da sua operação.