Fluxo de integração - API de consulta de Scores - Pesquisa Parcialmente Anônima e Identificada
Esta API disponibiliza o consumo dos scores de pesquisas parcialmente anônimas e identificadas, previamente processados dos instrumentos de acordo com os filtros inseridos na requisição.
ATENÇÃO
Para utilizar esta API, o admin da conta deverá preencher o formulário no site https://suporte.gupy.io/s/suporte/ solicitando o token da API do mapa de calor.
Parâmetros da requisição
| Nome do campo | Descrição | Obrigatório/regra de negócio |
|---|---|---|
| instrument | UID do instrumento | Obrigatório. |
| start_date | Data de início do filtro | Obrigatório. |
| end_date | Data final do filtro | Obrigatório. |
ATENÇÃO
O
uid_instrumentpode ser obtido através da requisição para obter todos os instrumentos
Exemplo de requisição:
curl --location 'https://www.pulses.com.br/api/engage/v1/heatmap?segment=leaders&instrument=c0c0302e-d142-11e8-8052-42010a9e003a&pagination=0' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Cookie: PHPSESSID=deajbemtgam3m5o9p3g4k449uh'
curl --location 'https://www.pulses.com.br/api/engage/v1/instruments/{uid_instrument}/answers/?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data ''
Exemplo de response:
Esta chamada retorna um objeto com a seguinte estrutura:
Lembrando que cada instrumento terá um retorno com estrutura diferente, visto que cada instrumento tem a sua estrutura de questões e cálculo.
{
"instrument": {
"uid_instrument": "uid do instrumento - string",
"id_instrument": 0,
"answers": [
{
"id_answer": 0,
"id_factor": 0,
"id_dimension": 0,
"id_question": 0,
"answer_details": {
"year_week": 0,
"created_at": "YYYY-MM-DD HH:MM:SS.000000",
"deleted_at": null,
"status_int": 1,
"updated_at": "YYYY-MM-DD HH:MM:SS.000000",
"resposta_num": 0
},
"score": 5,
"respondent": {
"id_person": 0,
"attributes": {
"cpf": "012.345.678-99",
"sex": "string",
"name": "NOME DO COLABORADOR",
"email": "[email protected]",
"groups": [ "Listagem de todos os grupos que o colaborador faz parte"
{
"name": "nome do grupo",
"id_group": 0,
"deleted_at": null
}
],
"leaders": [
{
"cpf": "012.345.678-99",
"name": "NOME DO LÍDER",
"email": "[email protected]",
"id_person": 0,
"deleted_at": "YYYY-MM-DD HH:MM:SS.000000",
"internal_number": "String"
}
],
"position": "String",
"scholarity": "String",
"unit_business": "String",
"unit_geography": "String",
"internal_number": "String",
"custom_attributes": [
{
"id_attribute": 0,
"external_name": "nome_do_atributo",
"id_option": null,
"name_option": null
}
]
}
}
}
]
}
}
Updated about 1 month ago