Zum Inhalt springen

Exporta o mapa de calor (CSV)

GET/api/surveys/{id}/heatmap/export

Auth
Token erforderlich
API-Schlüssel:
surveys:read
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

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

Parameter

NameOrtTypBeschreibung
idPflichtpathstring (uuid)
dimensionoptionalquerygroup | tag | company
roundIdoptionalquerystring (uuid)

Header

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

Antworten

StatusBeschreibung
200O CSV (UTF-8 com BOM).
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.
422As mesmas do mapa.
500Erro interno do servidor.

curl-Beispiel

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