📋 Dimensões

📖 Descrição

Retorna o mapa de calor de favorabilidade das dimensões gerais da pesquisa, agrupado pelo filtro informado. Cada célula representa o percentual de favorabilidade daquela dimensão dentro do grupo.

🔗 Documentação Relacionada

Autenticação

Rate Limiting

Formato de Resposta

⚙️ Regras de Negócio

Escopo por empresa autenticada; use o header Resource-Id para escopar uma subempresa

O parâmetro filter é obrigatório e define os grupos (linhas) do heatmap

Favorabilidade calculada como round(favoráveis * 100 / respostas válidas); respostas 1,2 são favoráveis, 1–5 válidas

Grupos abaixo do mínimo de respondentes retornam N/A (anonimização)

Paginação sobre os grupos (padrão 50 por página, 1–200)

🎯 Casos de Uso

Visão consolidada de favorabilidade das dimensões por grupo

Comparação de percepção entre áreas da empresa

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Sucesso

application/json

Bodyapplication/json

Exemplo

{
    "data": [
        {
            "group": "Tecnologia",
            "keys": {
                "my_manager": 77,
                "my_organization": 73,
                "my_team": 77,
                "my_work": 72
            }
        },
        {
            "group": "Comercial",
            "keys": {
                "my_manager": 77,
                "my_organization": 73,
                "my_team": 77,
                "my_work": 72
            }
        }
    ],
    "links": {
        "first": "https://api.winx.ai/v1/{campaign}/magic/heatmap?filter=Department&page=1",
        "last": "https://api.winx.ai/v1/{campaign}/magic/heatmap?filter=Department&page=4",
        "prev": null,
        "next": "https://api.winx.ai/v1/{campaign}/magic/heatmap?filter=Department&page=2"
    },
    "meta": {
        "current_page": 1,
        "per_page": 50,
        "total": 200,
        "last_page": 4,
        "index": "engagement_dimension",
        "keys": [
            {
                "key": "my_manager",
                "label": "Meu gestor",
                "overall": 77
            },
            {
                "key": "my_organization",
                "label": "Minha organização",
                "overall": 73
            },
            {
                "key": "my_team",
                "label": "Minha equipe",
                "overall": 77
            },
            {
                "key": "my_work",
                "label": "Meu trabalho",
                "overall": 72
            }
        ]
    }
}

🟠400Erro padrão

🟠401Não Autenticado

🟠403Não Autorizado

🟠404Não Encontrado

🟠422Entidade Improcessável

📖 Descrição#

🔗 Documentação Relacionada#

⚙️ Regras de Negócio#