Rodadas da pesquisa recorrente
GET/api/surveys/{id}/rounds
- Auth
- Richiede un token
- Chiave API:
- surveys:read
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
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`.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
idobbligatorio | path | string (uuid) | |
pagefacoltativo | query | integer | |
limitfacoltativo | query | integer |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Risposte
| Codice | Descrizione |
|---|---|
200 | As rodadas. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
422 | A pesquisa não se repete. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X GET "https://api.memberfy.net/api/surveys/<id>/rounds" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"