Conceito: API Peakon
Usar a API Peakon para recuperar dados de engajamento do Peakon. Autenticar com um token de acesso e fazer solicitações GET aos pontos de extremidade para acessar as pontuações de engajamento e as principais métricas.
Autenticação
Depois que um aplicativo personalizado é criado, você recebe um token de acesso gerado. Este token é secreto e exclusivo para seu aplicativo. Faça uma solicitação POST usando o ponto de extremidade /v1/auth/application para trocar seu token de acesso por um token de autorização.
curl --location --request POST 'https://SUDBOMAIN.peakon.com/api/v1/auth/application' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "Add your token here" }'
O corpo da resposta de uma solicitação de autenticação bem-sucedida conterá um token de autorização JWT a ser usado em todas as solicitações de API subsequentes. Observe que, mesmo que uma aplicação possa ter mais de um token de autorização, os limites de taxa são aplicados por aplicação.
Depois de se autenticar com um token de acesso para obter um JWT, você pode usá-lo para fazer solicitações GET aos pontos de extremidade para acessar pontuações de engajamento e outras métricas importantes. Visita Etapas: criar aplicativos personalizados com API REST para obter mais informações sobre como definir essa opção.
Filtragem
Além das rotas contextuais, a filtragem adicional tem suporte para muitas rotas por meio do parâmetro de consulta do filtro. Se uma rota oferecer suporte à filtragem, ela será listada como um parâmetro de consulta na especificação de rota abaixo. Os filtros são organizados com base em seu modelo lógico. Para filtrar pelo driver de pergunta, prefixe o filtro com
question
. Exemplo:GET /v1/engagement/drivers?filter[question.driver]=autonomy
Vários operadores têm suporte nos campos correspondentes. Exemplo: para obter pontuações apenas dos motivadores de autonomia e recompensa, você pode fornecer o seguinte filtro:
GET /v1/engagement/drivers?filter[question.driver]=autonomy,reward$in
Para obter uma lista dos operadores de filtro compatíveis, acesse: Referência: valores de filtragem da API Peakon.
Formato JSON
Todos os objetos são renderizados usando a API JSON, um método do para modelar um gráfico de objetos usando JSON.
Roteamento
Algumas solicitações podem ser restritas a um segmento arbitrário da empresa. Talvez você tenha interesse em analisar os dados de engajamento de todos os subordinados diretos de um determinado gestor ou o eNPS de um determinado departamento.
Exemplo: a ID do segmento do departamento de vendas é 149. A visão geral Engajamento para este departamento pode ser obtida por meio da seguinte solicitação:
GET v1/engagement/context/149/overview
Para obter a ID do segmento, use o seletor de contexto para alterar o contexto da Empresa para o próprio segmento. O seletor de contexto está localizado no canto superior esquerdo da página. Pesquise o nome do segmento e selecione-o para acessá-lo. A ID do segmento aparece no URL após o(a)
segment/
parâmetro Para obter mais informações sobre o comutador de contexto, visite Conceito: contextos do painel.Limite de taxa
Peakon é um serviço multilocatário. Os limites de taxa são usados para evitar que clientes individuais usem uma quantidade desproporcional de recursos. Cada inscrição registrada está, por padrão, sujeita aos seguintes limites de taxa:
- Até 5.000 solicitações por hora.
- Até 12 minutos de tempo de processamento para 5 minutos de marcação de ponto.
Se seu aplicativo ultrapassa um dos limites, a API retornará um
429 Too Many Requests
resposta Os limites de taxa por padrão são revisados e atualizados periodicamente.