Aller au contenu

Rodadas da pesquisa recorrente

GET/api/surveys/{id}/rounds

Auth
Jeton requis
Clé d’API:
surveys:read
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

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`.

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring (uuid)
pagefacultatifqueryinteger
limitfacultatifqueryinteger

En-têtes

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

Réponses

StatutDescription
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.

Exemple curl

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