Concetto: API Peakon
Utilizzare l'API Peakon per recuperare i dati sul coinvolgimento da Peakon. Eseguire l'autenticazione con un token di accesso, quindi effettuare richieste GET agli endpoint per accedere ai punteggi di coinvolgimento e alle metriche chiave.
Autenticazione
Una volta creata un'applicazione personalizzata, viene visualizzato un token di accesso generato. Questo token è segreto e univoco per l'applicazione. Effettuare una richiesta POST utilizzando l'endpoint /v1/auth/application per scambiare il token di accesso con un token di autorizzazione.
curl --location --request POST 'https://SUDBOMAIN.peakon.com/api/v1/auth/application' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "Add your token here" }'
Il corpo della risposta di una richiesta di autenticazione riuscita conterrà un token di autorizzazione JWT da utilizzare in tutte le richieste API successive. Si noti che anche se un'applicazione può avere più di un token di autorizzazione, i limiti di frequenza vengono applicati per ogni applicazione.
Dopo l'autenticazione con un token di accesso per ottenere un JWT, è possibile utilizzarlo per inoltrare richieste GET agli endpoint per accedere ai punteggi di coinvolgimento e ad altre metriche chiave. Visita Procedura: Creare app personalizzate con l'API REST per ulteriori informazioni su come configurarlo.
Filtri
Oltre ai percorsi contestuali, è supportato un filtro aggiuntivo per molti percorsi tramite il parametro di query del filtro. Se un percorso supporta il filtraggio, verrà elencato come parametro di query nella specifica del percorso seguente. I filtri sono organizzati in base al modello logico. Per filtrare in base al driver della domanda, anteporre al filtro
question
. Esempio:GET /v1/engagement/drivers?filter[question.driver]=autonomy
Sono supportati diversi operatori per i campi corrispondenti. Esempio: per ottenere i punteggi solo per i fattori trainanti dell'autonomia e della retribuzione, è possibile fornire il filtro seguente:
GET /v1/engagement/drivers?filter[question.driver]=autonomy,reward$in
Per un elenco degli operatori di filtro supportati, visitare il sito Web Riferimenti: Valori di filtro API Peakon.
Formato JSON
Il rendering di tutti gli oggetti viene eseguito utilizzando l'API JSON, un metodo per la modellazione di un grafico a oggetti utilizzando JSON.
Routing
Alcune richieste possono essere limitate a un segmento arbitrario dell'azienda. Potrebbe interessarti analizzare i dati di ingaggio per tutti i riporti diretti di un determinato manager o l'ENPS di un determinato reparto.
Esempio: l'ID segmento per il reparto vendite è 149. È possibile ottenere la panoramica del coinvolgimento per questo reparto tramite la richiesta seguente:
GET v1/engagement/context/149/overview
Per ottenere l'ID segmento, utilizzare il selettore di contesto per modificare il contesto dall'azienda al segmento stesso. Il selettore di contesto si trova nell'angolo in alto a sinistra della pagina. Cercare il nome del segmento e selezionarlo per accedervi. L'ID segmento viene visualizzato nell'URL dopo il
segment/
parametro Per ulteriori informazioni sul selettore di contesto, visitare Concetto: Contesti dei dashboard.Limitazione tariffa
Peakon è un servizio multi-tenant. Sono previsti limiti di tariffa per evitare che i singoli clienti utilizzino una quantità sproporzionata di risorse. Per impostazione predefinita, ogni candidatura registrata è soggetta ai seguenti limiti di frequenza:
- Fino a 5000 richieste all'ora.
- Fino a 12 minuti di elaborazione ogni 5 minuti di timbratura.
Se l'applicazione supera uno dei limiti, l'API restituirà a
429 Too Many Requests
risposta I limiti di frequenza predefiniti vengono periodicamente rivisti e aggiornati.