Fluxo de Integração - API de Consumo dos Scores Agregados
Essa rota visa oferecer uma alternativa ao endpoint de respostas individuais, sendo compatível com instrumentos confidenciais, e com retorno já consolidado, pronto para uso em dashboards ou análises externas.
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 |
|---|---|---|
| uid_instrument | UID do instrumento | Obrigatório |
| endDate | Data final do período de consulta. Se não for informada, será considerada a data atual. O formato deve ser YYYY-MM-DD. | Não. |
| leaderHierarchyDepth | Define o nível de profundidade hierárquica de lideranças a ser considerado no cálculo do score. Os valores podem ser "direct" para considerar apenas liderados diretos ou "full" para considerar toda a hierarquia abaixo, em todos os níveis. Caso não seja informado, o valor default é "direct". | Não. |
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/score/{uid_instrument}' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'accept: application/json'
curl --request GET \
--url 'https://www.pulses.com.br/api/engage/v1/scores/{uid_instrument}?endDate=2025-01-02' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX' \
--header 'accept: application/json'
Exemplo de response:
Esta chamada retorna um objeto com a seguinte estrutura:
{
"instrument": {
"uid": "uid_instrument",
"name": string,
"laggingWeeks": number
},
"overallScore": number,
"lagging": [
{
"score": number,
"respondentCount": number,
"startDate": string,
"endDate": string,
"resportable": boolean,
"reason": string | null
}]
}
Updated 2 days ago