Exporta o mapa de calor (CSV)
GET/api/surveys/{id}/heatmap/export
- 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. O que o mapa mostra com os mesmos `dimension` e `roundId`: uma linha por recorte (rótulo, respostas e o valor de cada coluna) e o total. Anônima: 422 `heatmapAnonymousUnavailable`.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
idobbligatorio | path | string (uuid) | |
dimensionfacoltativo | query | group | tag | company | |
roundIdfacoltativo | query | string (uuid) |
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 | O CSV (UTF-8 com BOM). |
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 | As mesmas do mapa. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X GET "https://api.memberfy.net/api/surveys/<id>/heatmap/export" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"