Prévia do público da pesquisa
POST/api/surveys/audience-preview
- Auth
- Requires a token
- API key:
- surveys:write
- X-CommunityId
X-CommunityIdSend 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. O público de uma pesquisa é **quem tem acesso ao espaço dela** (as regras de visibilidade do espaço: público, membros, plano ou privado com grupos, produtos e planos). Conta quem o espaço `spaceId` (ou o da pesquisa `surveyId`) alcança hoje e traz até 10 nomes, sem e-mail. Acima de `maxRecipients` (50.000) a pesquisa não abre.
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
spaceIdoptional | string (uuid) | Um espaço de pesquisas da comunidade. |
surveyIdoptional | string (uuid) | Ou a pesquisa: vale o espaço dela. |
Responses
| Status | Description |
|---|---|
200 | Contagem e amostra. |
400 | Requisição inválida — falha de validação. |
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 | Sem `spaceId` nem `surveyId`, ou espaço que não é de pesquisas da comunidade. |
500 | Erro interno do servidor. |
curl example
curl -X POST "https://api.memberfy.net/api/surveys/audience-preview" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'