Skip to main content

GET NPS das Avaliações

NPS Score das avaliações. Retorna promotores/neutros/detratores e o NPS Score das avaliações. Use period=today|week|month para cache, ou startDate+endDate (YYYY-MM-DD) para range customizado (query direta).

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Sem permissão específica

Não exige @CheckPermissions — basta estar autenticado.


Endpoint​

GET https://api-dev.imagemais.com.br/api/dashboard/nps-score

Parâmetros de Query​

NomeTipoObrigatórioValores válidosDescrição
periodstring❌—Período do indicador: today, week ou month (padrão: today)
startDatestring❌—Data inicial (YYYY-MM-DD)
endDatestring❌—Data final (YYYY-MM-DD)

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/dashboard/nps-score' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"data": {
"promoters": 0,
"neutrals": 0,
"detractors": 0,
"total": 0,
"score": 0
}
}

503 Serviço indisponível​

{
"message": "Dados temporariamente indisponíveis",
"error": "Service Unavailable",
"statusCode": 503
}