Guias Práticos

Fluxo de integração - API de consulta de Scores com cruzamento de dados

Este endpoint permite o consumo de scores com o cruzamento de até três atributos por requisição, retornando informações de score geral, dimensão, fator e pergunta. Esse endpoint é aplicável para instrumentos estruturados, as perguntas no modelo NPS não trarão resultados.

Suggest Edits

Acesse o endpoint Consulta de score com cruzamento de dados para consultar os scores previamente processados, no mesmo modelo do mapa de calor.

❗️

ATENÇÃO

Para utilizar esta API, o admin da conta deverá enviar um e-mail para [email protected] solicitando o token da API do mapa de calor.

📘

ATENÇÃO

O uid_instrument pode ser obtido através da requisição para obter todos os instrumentos

Parâmetros da requisição

Nome do campoDescriçãoObrigatório/regra de negócio
instrumentUID do instrumentoObrigatório.
endDateData do último dia da semana a ser consultada (sábado)Obrigatório.
crossings (Array[string])Segmentos a serem cruzados = ['position', 'sex', 'scholarity', 'unit_business', 'unit_geography', 'hiring_date', 'birthday', 'group', 'leader']Obrigatório.
crossing_filters (inline_model, optional)Filtro de cruzamento para considerar somente os valores especificados na hora de cruzar os dados, o segmento filtrado precisará ser especificado no campo 'crossings'Não obrigatório.
segments (inline_model_0, optional)Filtro de segmentos para considerar somente colaboradores que se encaixam nos atributos passadosNão obrigatório.

Filters

ChaveSignificado
positionCargo
sexSexo
scholarityGrau de Escolaridade
groupGrupos
leaderLíder
birthdayData de Nascimento
hiring_dateData de Contratação
unit_businessUnidade de Negócio
unit_geographyUnidade Geográfica

Exemplo de requisição:

curl --location 'https://www.pulses.com.br/app/engage/ws/web/score/crossing/export' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data '{
  "instrument": "uid-do-instrumento",
  "endDate": "YYYY-MM-DD",
  "crossings": ["segment"]
}'

Exemplo de response:

inline_model {
position (Array[string], optional): Filtro por cargo ,
sex (Array[string], optional): Filtro por sexo ,
scholarity (Array[string], optional): Filtro por escolaridade ,
unit_business (Array[string], optional): Filtro por unidade de negócio ,
unit_geography (Array[string], optional): Filtro por unidade geográfica ,
group (Array[integer], optional): Filtro por grupo ,
leader (Array[integer], optional): Filtro por líder ,
hiring_date (Array[string], optional): Filtro por tempo de casa = ['Não informado', '0 a 1 mês', '1 a 2 meses', '2 a 3 meses', '3 a 6 meses', '6 meses a 1 ano', '1 a 2 anos', '2 a 3 anos', '3 a 5 anos', '5 a 10 anos', 'Mais de 10 anos'],
birthday (Array[string], optional): Filtro por idade = ['Não informado', '0 a 19 anos', '20 a 29 anos', '30 a 39 anos', '40 a 49 anos', '50 a 59 anos', '60 anos ou mais']
}
inline_model_0 {
position (Inline Model 1, optional): Filtro de colaboradores por cargo ,
sex (Inline Model 2, optional): Filtro de colaboradores por sexo ,
scholarity (Inline Model 3, optional): Filtro de colaboradores por escolaridade ,
unit_business (Inline Model 4, optional): Filtro de colaboradores por unidade de negócio ,
unit_geography (Inline Model 5, optional): Filtro de colaboradores por unidade geográfica ,
hiring_date (Inline Model 6, optional): Filtro de colaboradores por tempo de casa ,
birthday (Inline Model 7, optional): Filtro de colaboradores por idade ,
groups (Inline Model 8, optional): Filtro de colaboradores por grupo ,
leaders (Inline Model 9, optional): Filtro de colaboradores por líder
}
Inline Model 1 {
values (Array[string], optional)
}
Inline Model 2 {
values (Array[string], optional)
}
Inline Model 3 {
values (Array[string], optional)
}
Inline Model 4 {
values (Array[string], optional)
}
Inline Model 5 {
values (Array[string], optional)
}
Inline Model 6 {
values (Array[Inline Model 10], optional) = ['{none: true}', '{end: 1}', '{start: 12, end: 24}', '{start: 6, end: 12}', '{start: 3, end: 6}', '{start: 2, end: 3}', '{start: 1, end: 2}', '{start: 24, end: 36}', '{start: 36, end: 60}', '{start: 60, end: 120}', '{start: 120}']
}
Inline Model 7 {
values (Array[Inline Model 11], optional) = ['{none: true}', '{end: 240}', '{start: 240, end: 360}', '{start: 360, end: 480}', '{start: 480, end: 600}', '{start: 600, end: 720}', '{start: 720}']
}
Inline Model 8 {
values (Array[integer], optional)
}
Inline Model 9 {
values (Array[integer], optional)
}
Inline Model 10 {
none (boolean, optional): Indica se o tempo de casa não está informado ,
start (integer, optional): Mínimo de tempo de casa em meses ,
end (integer, optional): Máximo de tempo de casa em meses
}
Inline Model 11 {
none (boolean, optional): Indica se a idade não está informada ,
start (integer, optional): Mínimo de idade em meses ,
end (integer, optional): Máximo de idade em meses
}

Updated 5 months ago