Satisfação

Depois de cada evento o Festero pode enviar uma pesquisa de satisfação ao cliente. Estas rotas devolvem as pesquisas (nota, comentário e respostas) e o resumo do NPS. Servem para BI, para acompanhar detratores e para reaproveitar depoimentos.

Escopo exigido: feedback:read. Sem ele, as rotas respondem scope_missing.

O comentário e as respostas de texto livre saem, com telefone, e-mail e documento trocados por [oculto]. Nunca saem o telefone do cliente nem o link da pesquisa.

Testar na referência interativa

Pesquisas

GET /v1/feedback/surveys

Lista as pesquisas, da alteração mais antiga para a mais recente. Paginação por cursor.

Parâmetro	Tipo	Descrição
status	texto	scheduled, sent, remindersent, responded, expired ou failed. Falha de entrega (envio recusado pelo provedor) conta em failed, como na tela.
npsCategory	texto	promoter, passive ou detractor.
eventId	GUID	Só as pesquisas deste evento.
respondedFrom, respondedTo	data yyyy-MM-dd	Período da resposta (inclusive).
updatedSince, limit, cursor		Como nas demais listas.

Campo	Descrição
event, eventDate	Evento pesquisado (id e título) e a data dele, como estavam no envio.
client	Cliente pesquisado (id e nome, como estavam no envio).
status, hasDeliveryError	Situação e se o envio falhou ou foi recusado.
npsScore, npsCategory	Nota de 0 a 10 e a categoria. Nulos até o cliente responder.
comment, allowTestimonial	Comentário e se o cliente autorizou usá-lo como depoimento.
answers	Respostas: questionText, questionType (stars, yesno, multiplechoice ou freetext) e value.
sentAt, respondedAt	Instantes do envio e da resposta.

GET /v1/feedback/surveys/{id}

Devolve uma pesquisa com os mesmos campos. 404 se não existe ou é de outra empresa. Traz ETag.

Resumo do NPS

GET /v1/feedback/nps-summary

Os mesmos números do painel de Satisfação: npsScore (promotores menos detratores, em %), contagens e percentuais de promotores, neutros e detratores, totalSent, responseRate, a evolução mensal (monthlyTrend) e a média das perguntas de estrelas (questionAverages).

Parâmetro	Tipo	Descrição
periodDays	inteiro	Quantos dias para trás, de 1 a 3650 (padrão 90, como o painel). A janela é móvel, contada a partir de agora.