Pular para o conteúdo

Rodadas da pesquisa recorrente

GET/api/surveys/{id}/rounds

Auth
Exige token
Chave de API:
surveys:read
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

Owner e admin. As rodadas, da mais nova para a mais antiga, cada uma com destinatários, respostas, taxa de resposta e o valor de cada pergunta NPS (`score`) e de escala (média). O resultado completo de uma rodada é o `GET /api/surveys/{roundId}/results`. `id` pode ser a recorrente ou uma das rodadas. **Anônima:** conta só os blocos publicados, e a rodada com menos de 3 respostas publicadas vem `locked: true`, sem número (`responseCount`, `responseRate` e `value` nulos). Pesquisa avulsa: 422 `recurrenceNotSet`.

Parâmetros

NomeOndeTipoDescrição
idobrigatóriopathstring (uuid)
pageopcionalqueryinteger
limitopcionalqueryinteger

Headers

NomeTipoDescrição
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Respostas

CódigoDescrição
200As rodadas.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
422A pesquisa não se repete.
500Erro interno do servidor.

Exemplo com curl

curl -X GET "https://api.memberfy.net/api/surveys/<id>/rounds" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"