Skip to content

Resultado consolidado

GET/api/surveys/{id}/results

Auth
Requires a token
API key:
surveys:read
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Owner e admin. Por seção e pergunta: escolhas com contagem e %, escala e NPS com média e distribuição (NPS com promotores, neutros, detratores e `score`), textos embaralhados (até 1.000 por pergunta, sem data). Topo: destinatários, respostas de membros e de visitantes, taxa sobre os destinatários, as respostas por dia (`activity`) e o NPS de cada pergunta `nps`. Um filtro por vez: `groupId`, `tag`, `companyId` ou `origin`; `filters` lista os que valem. **Anônima:** só o filtro `origin` (`groupId`, `tag` e `companyId` dão 422, e `filters.groups`, `tags` e `companies` vêm vazios). O resultado é publicado em blocos de 3 respostas da mesma origem, a cada hora cheia (nada é publicado na hora em que alguém responde), escolhidas ao acaso: números, textos e `responses` refletem só os blocos completos, para que comparar duas leituras não revele uma resposta. Na origem membro, só fecham bloco respostas de quem não é da equipe (owner, admin, moderador, financeiro) e era destinatário na abertura; as demais saem só junto com pelo menos 3 dessas. Com menos de 3 publicadas, `locked: true` e nenhum número nem texto; o filtro `origin` só vale quando o recorte e o complemento têm 3 ou mais (senão, 422 e ele não aparece em `filters`).

Parameters

NameInTypeDescription
idrequiredpathstring (uuid)
groupIdoptionalquerystring (uuid)
tagoptionalquerystring
companyIdoptionalquerystring (uuid)
originoptionalqueryMEMBER | VISITOR

Headers

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

Responses

StatusDescription
200O resultado.
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.
422Mais de um filtro, valor de origem inválido, filtro por grupo, tag ou empresa numa anônima, ou recorte pequeno demais numa anônima.
500Erro interno do servidor.

curl example

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