Konzept: Peakon-API
Verwenden Sie die Peakon-API, um Engagement-Daten von Peakon abzurufen. Authentifizieren Sie sich mit einem Zugriffs-Token und senden 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 ein geheimer und für Ihre Anwendung eindeutiger Wert. Stellen Sie eine POST-Anforderung über den Endpunkt /v1/auth/application, um Ihr Zugriffs-Token gegen ein Autorisierungs-Token auszutauschen.
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 kann. Beachten Sie, dass Ratenlimits pro Anwendung angewendet werden, auch wenn eine Anwendung mehr als ein Autorisierungs-Token haben kann.
Nach der Authentifizierung mit einem Zugriffs-Token zum Abrufen einer JWT können Sie damit GET-Anforderungen an Endpunkte stellen, um auf Engagement-Scores und andere wichtige Metriken zuzugreifen. Besuch Schritte: Benutzerdefinierte Apps mit REST-API erstellen finden Sie weitere Informationen zur Einrichtung.
Filtern
Zusätzlich zu den kontextabhängigen Routings werden für viele Routings durch den Filterabfrageparameter zusätzliche Filter unterstützt. Wenn eine Route das Filtern unterstützt, wird sie als Abfrageparameter in der Routing-Spezifikation unten aufgeführt. Filter werden basierend auf ihrem logischen Modell organisiert. Um nach dem Fragenfaktor zu filtern, stellen Sie dem Filter „" 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-Filterwerte.
JSON-Format
Alle Objekte werden mit der JSON-API gerendert, einer Methode von zur Modellierung eines Objektdiagramms mit JSON.
Routing
Einige Anforderungen können auf ein beliebiges Segment des Unternehmens beschränkt werden. Möglicherweise möchten Sie die Engagement-Daten für alle direkt unterstellten Mitarbeiter eines bestimmten Managers oder den eNPS einer bestimmten Abteilung analysieren.
Beispiel: Die Segment-ID für die Vertriebsabteilung ist 149. Die Engagement-Übersicht für diese Abteilung kann durch folgende Anforderung abgerufen werden:
GET v1/engagement/context/149/overview
Um die Segment-ID abzurufen, verwenden Sie den Kontextumsteller, um den Kontext vom Unternehmen in das Segment selbst zu ändern. Der Kontextwähler 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 angezeigt
segment/
Parameter. Weitere Informationen zum Kontextwechsel finden Sie unter Konzept: Dashboard-Kontexte.Satzlimitierung
Peakon ist ein Multimandantenservice. Es gibt Satzlimits, um zu verhindern, dass einzelne Kunden unverhältnismäßig viele Ressourcen verbrauchen. Jede registrierte Bewerbung unterliegt standardmäßig den folgenden Satzbeschränkungen:
- Bis zu 5.000 Anträge pro Stunde.
- Bis zu 12 Minuten Verarbeitungszeit pro 5 Minuten Arbeitszeit.
Wenn Ihre Anwendung einen der beiden Grenzwerte überschreitet, gibt die API eine zurück
429 Too Many Requests
Antwort Die Standardsatzlimits werden regelmäßig geprüft und aktualisiert.