Mapa de calor

GET/api/surveys/{id}/heatmap

Auth: Requires a token
API key:: surveys:read
X-CommunityId: X-CommunityId Send 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. 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.

Parameters

Name	In	Type	Description
`id`required	path	`string (uuid)`
`dimension`optional	query	`group \| tag \| company`
`roundId`optional	query	`string (uuid)`	Recorrente: a rodada do mapa.

Headers

Name	Type	Description
`X-CommunityId`optional	`string (uuid)`	ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Responses

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

curl example

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