📋 eNPS

📖 Descrição

Retorna o mapa de calor de NPS / eNPS (Net Promoter Score) para a dimensão informada, agrupado pelo filtro. Cada célula representa o score NPS do grupo.

Path Parameters adicionais

Parâmetro	Tipo	Obrigatório	Valores aceitos
`dimension`	string	Sim	`default`, `company`, `team`, `leadership`, `product`

Quando dimension = default, o cálculo utiliza o eNPS (colaborador); nas demais dimensões, o NPS da dimensão correspondente.

🔗 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

Score NPS = round((promotores − detratores) * 100 / total); promotores 9–10, neutros 7–8, detratores 0–6

Grupos sem respostas suficientes retornam N/A (anonimização)

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

🎯 Casos de Uso

Analisar o NPS/eNPS por grupo e por dimensã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": {
                "enps": 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#

Path Parameters adicionais#

🔗 Documentação Relacionada#

⚙️ Regras de Negócio#

🎯 Casos de Uso#