📋 Dimensões de Engajamento

🧪 Servidor de Sandbox

https://scenic-tokyo-3bje4ahyb4rd.on-vapor.com/api

GET

/v1/{campaing_id}/engagement_dimension/heatmap

📖 Descrição

Retorna o mapa de calor de favorabilidade das dimensões de engajamento, agrupado pelo filtro demográfico informado.

🔗 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)

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

Analisar as dimensões de engajamento por grupo

Priorizar planos de ação por dimensão e área

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros de Caminho

Parâmetros de Consulta

Parâmetros Header

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://scenic-tokyo-3bje4ahyb4rd.on-vapor.com/api/v1//engagement_dimension/heatmap?filter=Diretoria&page=1&per_page=50' \
--header 'Resource-Id: 9c73a4aa-8094-4241-ad05-658436f471fe' \
--header 'Authorization: Bearer <token>'

Respostas

🟢200Sucesso

application/json

Bodyapplication/json

Exemplo

{
    "data": [
        {
            "group": "string",
            "keys": {
                "my_manager": 0,
                "my_organization": 0,
                "my_team": 0,
                "my_work": 0
            }
        }
    ],
    "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
    },
    "meta": {
        "current_page": 0,
        "per_page": 0,
        "total": 0,
        "last_page": 0,
        "index": "string",
        "keys": [
            {
                "key": "string",
                "label": "string",
                "overall": 0
            }
        ]
    }
}