Saltar al contenido

Exporta o mapa de calor (CSV)

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

Auth
Requiere token
Clave de API:
surveys:read
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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

Parámetros

NombreDóndeTipoDescripción
idobligatoriopathstring (uuid)
dimensionopcionalquerygroup | tag | company
roundIdopcionalquerystring (uuid)

Headers

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

Respuestas

CódigoDescripción
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.

Ejemplo con curl

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