Mapa de calor

GET/api/surveys/{id}/heatmap

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. Uma linha por grupo principal (`dimension=group`, padrão), por tag (`tag`) ou por empresa (`company`), uma dimensão por vez; uma coluna por pergunta NPS e de escala, e o total. Cada célula traz o valor (NPS: `score`; escala: média), a faixa de cor `band` de 1 (pior) a 5 (melhor), quantas respostas a compõem e, em pesquisa recorrente, `delta` contra a rodada anterior. Só respostas de membros (visitante não tem grupo). Em tag e empresa, quem tem mais de uma conta em cada linha (`note`). **Pesquisa recorrente:** `roundId` escolhe a rodada (padrão: a última aberta); `id` pode ser a recorrente ou uma rodada. Sem rodada aberta ainda, `locked: true` e nenhuma linha. **Identificada:** usa o retrato de quem respondeu na hora da resposta; sem mínimo. **Anônima:** ainda não tem mapa de calor (422 `heatmapAnonymousUnavailable`, na pesquisa, na recorrente ou numa rodada): ele chega numa fase seguinte, só para rodadas encerradas e com o grupo de cada destinatário congelado na abertura. `minimumPerCell` vem nulo.

Parámetros

Nombre	Dónde	Tipo	Descripción
`id`obligatorio	path	`string (uuid)`
`dimension`opcional	query	`group \| tag \| company`
`roundId`opcional	query	`string (uuid)`	Recorrente: a rodada do mapa.

Headers

Nombre	Tipo	Descripción
`X-CommunityId`opcional	`string (uuid)`	ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Respuestas

Código	Descripción
`200`	O mapa.
`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`	Pesquisa ou rodada (`roundNotFound`) não encontrada.
`422`	Dimensão inválida, pesquisa anônima (`heatmapAnonymousUnavailable`) ou sem pergunta NPS ou de escala.
`500`	Erro interno do servidor.

Ejemplo con curl

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