Skip to main content
A GPS API V2 expõe os mesmos indicadores da plataforma em JSON estável, pronto para BI, data warehouse, dashboards internos e o conector MCP. É uma API somente leitura. Os dados vêm dos resultados processados de um ciclo (a “fotografia” cultural). Para interpretar scores e faixas, use o GPS de Cultura.
Autenticação: Authorization: Bearer bvt_… (token de API V2 com gps:read). Veja APIs BOOM.

Base e ciclos

Antes de consultar um widget, liste os ciclos da empresa (único endpoint Core liberado para o token bvt_):
Resposta (campos principais):
Use cycleId, startDate e endDate como from / to nas consultas V2.

Filtros comuns

Presentes em todos os endpoints como query string (@ModelAttribute).
uuid
required
Empresa dona do ciclo. Deve coincidir com a empresa do token.
date
required
Início do recorte (YYYY-MM-DD). Em geral, a data de início do ciclo.
date
required
Fim do recorte (YYYY-MM-DD). Em geral, a data de término do ciclo.
Filtros de cluster (todos opcionais; repetir a chave ou enviar lista). Cada valor é o UUID do cluster: Exemplo:

Envelope de resposta

Scores do Index e dos módulos estão na escala 0–1000. Percentuais (gap, convergência, engajamento) vêm como número decimal. Detalhes das faixas: Index de Cultura.

Chaves canônicas

moduleKey

Aliases legados ainda aceitos: inteligencia_emocional, fluidez_organizacional, realizacao, gente, valores_solidos, transparencia_e_confianca, inovacao, foco_no_cliente, adaptabilidade.

indicatorKey (Cultura vs Resultados)

receita · ltv · turnover · produtividade_por_colaborador · retrabalho_qualidade · brand_trust · lead_time_de_projetos_e_inovacao

type (clusters)

hierarquia · departamento · alocacao · diretoria · unidade · white_label_a · white_label_b · white_label_c · white_label_d · white_label_e
Endpoints de score por cluster aplicam anonimato: grupos com amostra insuficiente são omitidos.

Catálogo de endpoints

Todos os paths abaixo são relativos a https://api.deumboom.com. Método: GET. Parâmetros de path entre {chaves}.

Index de Cultura

Exemplo — score global:
Exemplo — liderança vs liderados:

Engajamento

Leitura das zonas: Engajamento.

Gap da Liderança

Índice de Valor (Value Index)

Cultura vs Resultados

indicatorKey inválido → 400 com "indicatorKey is invalid, verify!".

Módulos

Defensores e ofensores

Comparativo de ciclos

Query obrigatória: cycleA, cycleB, além de companyId, from, to.

Evolução e listas de ciclos

Endpoints de evolução aceitam cycleIds repetido ou separado por vírgula:

Permissões e isolamento


Perguntas frequentes

A V1 serve a plataforma interna (payloads de gráfico brutos). A V2 é o contrato estável para integrações: envelope único, chaves canônicas e recortes por cluster.
O ciclo ainda não tem resultado processado para aquele widget, o recorte from/to está fora do período, ou o filtro de cluster zerou a amostra (incluindo a regra de anonimato).
Não. A V2 é somente leitura. O processamento do ciclo acontece na plataforma.
O conector MCP (mcp-gps-v2) encapsula este catálogo em ferramentas (gps_v2_query, gps_list_cycles). A API HTTP documentada aqui é a mesma fonte.