Descargar PDF
Concepto: API de Peakon
Utilice la API de Peakon para recuperar datos de interacción de Peakon. Autenticarse con un token de acceso y, a continuación, realizar solicitudes GET a los puntos finales para acceder a puntuaciones de interacción y métricas clave.
Autenticación
Una vez que se crea una aplicación personalizada, se le presenta un token de acceso generado. Este token es un secreto y exclusivo para su aplicación. Realice una solicitud POST mediante el punto final /v1/auth/application para intercambiar su token de acceso por un token de autorización.
curl --location --request POST 'https://SUDBOMAIN.peakon.com/api/v1/auth/application' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "Add your token here" }'
El cuerpo de respuesta de una solicitud de autenticación correcta contendrá un token de autorización JWT que se utilizará en todas las solicitudes de API posteriores. Tenga en cuenta que, aunque una aplicación pueda tener más de un token de autorización, los límites de tasa se aplican por aplicación.
Después de autenticarse con un token de acceso para obtener un JWT, puede utilizarlo para realizar solicitudes GET a los puntos finales para acceder a puntuaciones de interacción y otras métricas clave. Visita Pasos: creación de apps personalizadas con API de REST para obtener más información sobre cómo configurarlo.
Filtrado
Además de las rutas contextuales, se admiten filtros adicionales para muchas rutas a través del parámetro de consulta de filtro. Si una ruta admite el filtrado, aparecerá como un parámetro de consulta en la especificación de ruta que aparece a continuación. Los filtros se organizan en función de su modelo lógico. Para filtrar por el generador de preguntas, anteponga al filtro el prefijo
question
. Ejemplo:GET /v1/engagement/drivers?filter[question.driver]=autonomy
Se admiten varios operadores para los campos coincidentes. Ejemplo: para obtener puntuaciones solo para los impulsores de autonomía y recompensa, puede proporcionar el siguiente filtro:
GET /v1/engagement/drivers?filter[question.driver]=autonomy,reward$in
Para obtener una lista de los operadores de filtrado admitidos, visite Referencia: valores de filtrado de API de Peakon.
Formato JSON
Todos los objetos se representan mediante la API de JSON, un método para modelar un gráfico de objetos mediante JSON.
Ruta
Algunas solicitudes se pueden restringir a un segmento arbitrario de la empresa. Puede que le interese analizar los datos de interacción de todas las dependencias directas de un gerente determinado o el eNPS de un departamento determinado.
Ejemplo: el ID de segmento del departamento de ventas es 149. El resumen de compromiso para este departamento se puede obtener mediante la siguiente solicitud:
GET v1/engagement/context/149/overview
Para obtener el ID de segmento, utilice el conmutador de contexto para cambiar el contexto de Empresa al propio segmento. El conmutador de contexto se encuentra en la esquina superior izquierda de la página. Busque el nombre del segmento y selecciónelo para acceder a él. El ID de segmento aparece en la URL después de
segment/
parámetro Para obtener más información sobre el conmutador de contexto, visite Concepto: contextos de tablero de control.Limitación de frecuencia
Peakon es un servicio multicliente. Los límites de tasa se aplican para evitar que los clientes individuales consuman una cantidad desproporcionada de recursos. Cada aplicación registrada está sujeta por defecto a los siguientes límites de frecuencia:
- Hasta 5000 solicitudes por hora.
- Hasta 12 minutos de tiempo de proceso por cada 5 minutos de tiempo de reloj de pared.
Si su aplicación supera cualquiera de los límites, la API devolverá un
429 Too Many Requests
respuesta Los límites de tasa por defecto se revisan y actualizan periódicamente.