Fluxo de integração - API de consulta de Scores (Mapa de Calor)
Esta API disponibiliza o consumo dos scores previamente processados dos instrumentos de acordo com os filtros inseridos na requisição. Estes scores podem ser verificados também via interface, no mapa de calor.
Acesse o endpoint Consumo dos scores previamente processados (mapa de calor) para consultar os sscores previamente processados, no mesmo modelo do mapa de calor.
ATENÇÃO
Os indicadores do mapa de calor são atualizados em média a cada 3 dias, caso existam novas respostas para o instrumento.
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. |
| pagination | paginação, se inicia na pagination = 0 | Não obrigatório. |
| segment | Segmento a ser filtrado. O segmento a ser informado é um entre as opções a seguir: groups, leaders, position, scholarity, birthday, sex, hiring_date, unit_business, unit_geography | Obrigatório. |
Valores válidos para o parâmetro segment
| Nome do campo | Descrição |
|---|---|
| birthday | Data de nascimento |
| groups | Grupos |
| hiring_date | Data de contratação |
| leaders | Liderança |
| position | Cargo |
| scholarity | Escolaridade |
| sex | Sexo |
| unit_business | Unidade de negócio |
| unit_geography | Unidade geográfica |
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'
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.
Retorno do Instrumento Pulses
{
"code": 1,
"message": "success",
"values": {
"id_score_cron": 0, //id do processamento. Identificador interno da plataforma
"scores": [
{
"title": "Toda empresa", //Nome do segmento. O primeiro sempre será "Toda empresa"
"ordering": 0,
"id_item": null, //id do segmento. Identificador interno da plataforma
"parent_id": 0, //parent_id do segmento. Hierarquia acima do segmento. Identificado da plataforma
"employees": null,
"answer_rate_general": 64.1, //Taxa de adesão geral
"answer_rate_week": null, //Taxa de adesão da semana
"answer_rate_period": null, //Taxa de adesão do período
"answer_rate_days15": 64, //Taxa de adesão dos últimos 15 dias
"answer_rate_days30": 65.7, //Taxa de adesão dos últimos 30 dias
"answer_rate_months3": 68, //Taxa de adesão dos últimos 3 meses
"answer_rate_months6": 68.5, //Taxa de adesão dos últimos 6 meses
"answer_rate_months12": 67.5, //Taxa de adesão dos últimos 12 meses
"respondents": 1234, //Número de respondentes únicos
"score": 8.6, //Score
"score_general": 8.6, //Score geral
"score_general_color": "#33820B", //Cor do score
"score_general_respondents": 12564, //Total de respondentes únicos para o score geral
"questions": [
{
"color": "#33820B",
"score": 8.9, //Score da Questão
"id_group": 24, //Id do Fator
"id_question": 18, //Id da Questão
"id_parent_group": 13, //Id da Dimensão
"respondents": 1234 //Total de respondentes únicos
}
],
"start_date": "YYYY-MM-DD", //Data de início do score da semana
"end_date": "YYYY-MM-DD", //Data de fim do score da semana
"updated_at": "YYYY-MM-DD HH:MM:SS", //Data da última atualização do score do mapa de calor
"color": "#33820B", //Cor referente ao score do mapa de calor
"groups": [
{
"color": "#33820B",
"score": 9,
"id_parent_group": 12,
"respondents": 1234
}
],
"type": "company"
},
{
"title": "SEGMENTO 1",
"ordering": 0,
"id_item": 18403677969,
"parent_id": 44232,
"employees": null,
"answer_rate_general": 91.3,
"answer_rate_week": null,
"answer_rate_period": null,
"answer_rate_days15": 100,
"answer_rate_days30": 87.5,
"answer_rate_months3": 85.7,
"answer_rate_months6": 83.3,
"answer_rate_months12": 87.4,
"respondents": 5,
"score": 7.9,
"score_general": 7.9,
"score_general_color": "#A8CE6A",
"score_general_respondents": 5,
"questions": [
{
"color": "#A8CE6A",
"score": 7.8,
"id_group": 83,
"id_question": 2259,
"id_parent_group": 4,
"respondents": 4
}
],
"start_date": "YYYY-MM-DD",
"end_date": "YYYY-MM-DD",
"updated_at": "YYYY-MM-DD HH:MM:SS",
"color": "#A8CE6A",
"groups": [
{
"color": "#33820B",
"score": 8.9,
"id_parent_group": 12,
"respondents": 4
}
]
}
],
"categorized": false,
"updated_at": "YYYY-MM-DD HH:MM:SS",
"pages": 5
}
}
Retorno do Instrumento NPS
{
"code": 1,
"message": "success",
"values": {
"id_score_cron": 0,
"scores": [
{
"title": "Toda empresa",
"ordering": 0,
"id_item": null,
"parent_id": 0,
"employees": null,
"answer_rate_general": 62.4,
"answer_rate_week": 53.2,
"answer_rate_period": 53.2,
"answer_rate_days15": null,
"answer_rate_days30": 61.3,
"answer_rate_months3": 65.9,
"answer_rate_months6": 65.7,
"answer_rate_months12": 63.4,
"respondents": null,
"score": "N/I",
"score_general": "N/I",
"score_general_color": "#ddd",
"score_general_respondents": 0,
"questions": [],
"start_date": "YYYY-MM-DD",
"end_date": "YYYY-MM-DD",
"updated_at": "YYYY-MM-DD HH:MM:SS",
"type": "company"
},
{
"title": "SEGMENTO 1",
"ordering": 0,
"id_item": 44467,
"parent_id": 63619,
"employees": null,
"answer_rate_general": 71.8,
"answer_rate_week": 86.4,
"answer_rate_period": 86.4,
"answer_rate_days15": null,
"answer_rate_days30": 82.5,
"answer_rate_months3": 87.3,
"answer_rate_months6": 89.2,
"answer_rate_months12": 81.7,
"respondents": null,
"score": "N/I",
"score_general": "N/I",
"score_general_color": "#ddd",
"score_general_respondents": 0,
"questions": [],
"start_date": "YYYY-MM-DD",
"end_date": "YYYY-MM-DD",
"updated_at": "YYYY-MM-DD HH:MM:SS"
}
],
"categorized": true,
"updated_at": "YYYY-MM-DD HH:MM:SS",
"pages": 5,
"categories": [
{
"label": "Detratores",
"value": "category_0",
"highlighted": 0
},
{
"label": "Passivos",
"value": "category_1",
"highlighted": 0
},
{
"label": "Promotores",
"value": "category_2",
"highlighted": 1
}
]
}
}
Retorno do Instrumento Engajamento
{
"code": 1,
"message": "success",
"values": {
"id_score_cron": 0,
"scores": [
{
"title": "Toda empresa",
"ordering": 0,
"id_item": null,
"parent_id": 0,
"employees": null,
"answer_rate_general": 64.1,
"answer_rate_week": 60.3,
"answer_rate_period": 60.3,
"answer_rate_days15": null,
"answer_rate_days30": 65.7,
"answer_rate_months3": 67.7,
"answer_rate_months6": 68.2,
"answer_rate_months12": 67.4,
"respondents": 11061,
"score": 89,
"score_general": 89,
"score_general_color": "#33820B",
"score_general_respondents": 11061,
"questions": [
{
"color": "#33820B",
"score": 5.3,
"id_group": null,
"id_question": 740,
"id_parent_group": null,
"respondents": 10916
}
],
"start_date": "YYYY-MM-DD",
"end_date": "YYYY-MM-DD",
"updated_at": "YYYY-MM-DD HH:MM:SS",
"color": "#33820B",
"categories": [
{
"color": "#AE1616",
"label": "Desengajados",
"value": "category_0",
"highlighted": 0,
"respondents": 227,
"percent": 2.05
}
],
"value_0": 2.05,
"color_0": "#AE1616",
"title_0": "Desengajados",
"value_1": 9.19,
"color_1": "#B0821D",
"title_1": "Neutros",
"value_2": 17.91,
"color_2": "#33820B",
"title_2": "Engajados",
"value_3": 70.84,
"color_3": "#1E4E06",
"title_3": "Altamente Engajados",
"label": "89%",
"type": "company"
},
{
"title": "SEGMENTO 1",
"ordering": 0,
"id_item": 43383,
"parent_id": 43382,
"employees": null,
"answer_rate_general": 35.3,
"answer_rate_week": 46.2,
"answer_rate_period": 46.2,
"answer_rate_days15": 46.2,
"answer_rate_days30": 40,
"answer_rate_months3": 32.9,
"answer_rate_months6": 30.8,
"answer_rate_months12": 27.7,
"respondents": 4,
"score": 100,
"score_general": 100,
"score_general_color": "#33820B",
"score_general_respondents": 4,
"questions": [
{
"color": "#A8CE6A",
"score": 5,
"id_group": null,
"id_question": 740,
"id_parent_group": null,
"respondents": 7
}
],
"start_date": "YYYY-MM-DD",
"end_date": "YYYY-MM-DD",
"updated_at": "YYYY-MM-DD HH:MM:SS",
"color": "#33820B",
"categories": [
{
"color": "#AE1616",
"label": "Desengajados",
"value": "category_0",
"highlighted": 0,
"respondents": 0,
"percent": 0
}
],
"value_0": 0,
"color_0": "#AE1616",
"title_0": "Desengajados",
"value_1": 0,
"color_1": "#B0821D",
"title_1": "Neutros",
"value_2": 25,
"color_2": "#33820B",
"title_2": "Engajados",
"value_3": 75,
"color_3": "#1E4E06",
"title_3": "Altamente Engajados",
"label": "100%"
}
],
"categorized": true,
"updated_at": "YYYY-MM-DD HH:MM:SS",
"pages": 5,
"categories": [
{
"label": "Desengajados",
"value": "category_0",
"highlighted": 0
},
{
"label": "Neutros",
"value": "category_1",
"highlighted": 0
},
{
"label": "Engajados",
"value": "category_2",
"highlighted": 0
},
{
"label": "Altamente Engajados",
"value": "category_3",
"highlighted": 1
}
]
}
}
Retorno do Instrumento e-NPS
{
"code": 1,
"message": "success",
"values": {
"id_score_cron": 0,
"scores": [
{
"title": "Toda empresa",
"ordering": 0,
"id_item": null,
"parent_id": 0,
"employees": null,
"answer_rate_general": 64.1,
"answer_rate_week": null,
"answer_rate_period": null,
"answer_rate_days15": 65.4,
"answer_rate_days30": 66.3,
"answer_rate_months3": 68.3,
"answer_rate_months6": 68.6,
"answer_rate_months12": 67.5,
"respondents": 1234,
"score": 54,
"score_general": 54,
"score_general_color": "#33820B",
"score_general_respondents": 1234,
"questions": [
{
"color": "#33820B",
"score": 8.9,
"id_group": null,
"id_question": 2408,
"id_parent_group": null,
"respondents": 1234
}
],
"start_date": "YYYY-MM-DD",
"end_date": "YYYY-MM-DD",
"updated_at": "YYYY-MM-DD HH:MM:SS",
"color": "#33820B",
"categories": [
{
"color": "#AE1616",
"label": "Detratores",
"value": "category_0",
"highlighted": 0,
"respondents": 1234,
"percent": 10.83
},
{
"color": "#B0821D",
"label": "Passivos",
"value": "category_1",
"highlighted": 0,
"respondents": 1234,
"percent": 24
},
{
"color": "#33820B",
"label": "Promotores",
"value": "category_2",
"highlighted": 1,
"respondents": 1234,
"percent": 65.17
}
],
"value_0": 10.83,
"color_0": "#AE1616",
"title_0": "Detratores",
"value_1": 24,
"color_1": "#B0821D",
"title_1": "Passivos",
"value_2": 65.17,
"color_2": "#33820B",
"title_2": "Promotores",
"label": 54,
"type": "company"
},
{
"title": "SEGMENTO 1",
"ordering": 0,
"id_item": 43383,
"parent_id": 43382,
"employees": null,
"answer_rate_general": 35.3,
"answer_rate_week": null,
"answer_rate_period": null,
"answer_rate_days15": 46.2,
"answer_rate_days30": 40,
"answer_rate_months3": 34.2,
"answer_rate_months6": 30.8,
"answer_rate_months12": 28,
"respondents": 7,
"score": 43,
"score_general": 43,
"score_general_color": "#33820B",
"score_general_respondents": 7,
"questions": [
{
"color": "#A8CE6A",
"score": 8.3,
"id_group": null,
"id_question": 2408,
"id_parent_group": null,
"respondents": 7
}
],
"start_date": "YYYY-MM-DD",
"end_date": "YYYY-MM-DD",
"updated_at": "YYYY-MM-DD HH:MM:SS",
"color": "#33820B",
"categories": [
{
"color": "#AE1616",
"label": "Detratores",
"value": "category_0",
"highlighted": 0,
"respondents": 1,
"percent": 14.29
},
{
"color": "#B0821D",
"label": "Passivos",
"value": "category_1",
"highlighted": 0,
"respondents": 2,
"percent": 28.57
},
{
"color": "#33820B",
"label": "Promotores",
"value": "category_2",
"highlighted": 1,
"respondents": 4,
"percent": 57.14
}
],
"value_0": 14.29,
"color_0": "#AE1616",
"title_0": "Detratores",
"value_1": 28.57,
"color_1": "#B0821D",
"title_1": "Passivos",
"value_2": 57.14,
"color_2": "#33820B",
"title_2": "Promotores",
"label": 43
}
],
"categorized": true,
"updated_at": "YYYY-MM-DD HH:MM:SS",
"pages": 5,
"categories": [
{
"label": "Detratores",
"value": "category_0",
"highlighted": 0
},
{
"label": "Passivos",
"value": "category_1",
"highlighted": 0
},
{
"label": "Promotores",
"value": "category_2",
"highlighted": 1
}
]
}
}
Parâmetros do JSON da resposta da requisição
Ao final de toda a listagem das sugestões enviadas no período selecionado, será apresentado as seguintes informações:
"total": 4,
"paging": {
"page": "1",
"itensPerPage": 5000,
"previous": "",
"next": ""
Por padrão, a limitação é de 5000 sugestões por página, e caso a conta possua mais de 5000 sugestões a API irá retornar as informações de paginação, contendo a URL para a próxima página.
Utilizando nosso exemplo, considerando uma conta que possui apenas 4 comentários, iremos alterar o limite de comentários por página para 2.
Updated about 1 month ago