PDF herunterladen
Konzept: Peakon-API
Verwenden Sie die Peakon-API, um Engagement-Daten aus Peakon abzurufen. Authentifizieren Sie sich mit einem Zugriffs-Token und stellen Sie dann GET-Anforderungen an Endpunkte, um auf Engagement-Scores und wichtige Metriken zuzugreifen.
Authentifizierung
Sobald eine benutzerdefinierte Anwendung erstellt wurde, wird Ihnen ein generiertes Zugriffs-Token angezeigt. Dieses Token ist geheim und gilt nur für Ihre Anwendung. Stellen Sie eine POST-Anforderung über den Endpunkt /v1/auth/application, um Ihr Zugriffs-Token gegen ein Autorisierungs-Token zu ersetzen.
curl --location --request POST 'https://SUDBOMAIN.peakon.com/api/v1/auth/application' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "Add your token here" }'
Der Antworttext einer erfolgreichen Authentifizierungsanforderung enthält ein JWT-Autorisierungs-Token, das in allen nachfolgenden API-Anforderungen verwendet werden soll. Beachten Sie, dass Ratenlimits pro Anwendung erzwungen werden, auch wenn eine Anwendung mehr als ein Autorisierungs-Token haben kann.
Nachdem Sie sich mit einem Zugriffs-Token authentifiziert haben, um ein JWT zu erhalten, können Sie dieses verwenden, um GET-Anforderungen an Endpunkte zu richten, um auf Engagement-Scores und andere wichtige Metriken zuzugreifen. Besuchen Sie Schritte: Benutzerdefinierte Apps mit REST-API erstellen finden Sie weitere Informationen zur Einrichtung.
Filtern
Zusätzlich zu kontextbezogenen Routen wird für viele Routen eine zusätzliche Filterung durch den Filterabfrage-Parameter unterstützt. Wenn eine Route das Filtern unterstützt, wird sie unten als Abfrageparameter in der Routenspezifikation aufgeführt. Filter werden basierend auf ihrem logischen Modell organisiert. Um nach dem Fragentreiber zu filtern, stellen Sie dem Filter Folgendes voran
question
. Beispiel:GET /v1/engagement/drivers?filter[question.driver]=autonomy
Für den Abgleich von Feldern wird eine Reihe von Operatoren unterstützt. Beispiel: Um Scores nur für die Autonomie- und Vergütungsfaktoren zu erhalten, können Sie den folgenden Filter bereitstellen:
GET /v1/engagement/drivers?filter[question.driver]=autonomy,reward$in
Eine Liste der unterstützten Filteroperatoren finden Sie unter Referenz: Peakon-API-Werte filtern.
JSON-Format
Alle Objekte werden mit der JSON-API gerendert, einer Methode zur Modellierung eines Objektdiagramms mit JSON.
Routing
Einige Anträge können auf ein beliebiges Segment des Unternehmens beschränkt werden. Es könnte Sie interessieren, die Engagement-Daten für alle direkt unterstellten Mitarbeiter eines bestimmten Managers oder den eNPS einer bestimmten Abteilung zu analysieren.
Beispiel: Die Segment-ID für die Verkaufsabteilung lautet 149. Die Engagement-Übersicht für diese Abteilung kann durch folgende Anforderung abgerufen werden:
GET v1/engagement/context/149/overview
Um die Segment-ID zu erhalten, ändern Sie den Kontext mithilfe des Kontextwechslers vom Unternehmen in das Segment selbst. Der Kontextwechsel befindet sich in der oberen linken Ecke der Seite. Suchen Sie nach dem Namen des Segments und wählen Sie es aus, um darauf zuzugreifen. Die Segment-ID wird in der URL nach dem angezeigt
segment/
-Parameter. Weitere Informationen zum Kontextwechsler finden Sie unter Konzept: Dashboard-Kontexte.Satzlimitierung
Peakon ist ein mandantenübergreifender Service. Es gibt Satzlimits, um zu verhindern, dass einzelne Kunden unverhältnismäßig viele Ressourcen verbrauchen. Jede registrierte Anwendung unterliegt standardmäßig den folgenden Satzlimits:
- Bis zu 5.000 Anforderungen pro Stunde.
- Bis zu 12 Minuten Verarbeitungszeit pro 5 Minuten Arbeitszeit.
Wenn Ihre Anwendung einen der beiden Grenzwerte überschreitet, gibt die API Folgendes zurück:
429 Too Many Requests
-Antwort. Die Standardsatzlimits werden regelmäßig überprüft und aktualisiert.