📋 Participação

📖 Descrição

Retorna o mapa de calor de participação da pesquisa, agrupado pelo filtro informado. Cada célula representa o percentual de respondentes que responderam à pesquisa dentro de cada 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

Participação calculada por grupo como round(respondentes * 100 / total)

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)

Recortes adicionais podem ser aplicados via query params

🎯 Casos de Uso

Acompanhar a taxa de participação por departamento, cargo, unidade, etc.

Identificar grupos com baixa participação para reforço de comunicação

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": "string",
            "keys": {
                "participation": 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
            }
        ]
    }
}

🟠400Erro Padrão

🟠401Não Autenticado

🟠403Não Autorizado

🟠404Não Encontrado

🟠422Entidade Improcessável

📖 Descrição#

🔗 Documentação Relacionada#

⚙️ Regras de Negócio#