概念: Peakon API
Peakon API を使用して、Peakon からエンゲージメント データを取得します。アクセス トークンで認証してから、エンドポイントに GET リクエストを送信し、エンゲージメント スコアおよび主要なメトリックにアクセスします。
認証
カスタム アプリケーションが作成されると、生成されたアクセス トークンが表示されます。このトークンは秘密であり、アプリケーション固有のものです。/v1/auth/Application エンドポイントを使用して POST リクエストを実行し、アクセス トークンを認証トークンと交換します。
curl --location --request POST 'https://SUDBOMAIN.peakon.com/api/v1/auth/application' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "Add your token here" }'
成功した認証リクエストのレスポンス本文には、後続のすべての API リクエストで使用される JWT 認証トークンが含まれます。1 つのアプリケーションに複数の認証トークンがある場合でも、料率制限はアプリケーションごとに適用されます。
アクセス トークンで認証して JWT を取得した後、それを使用してエンドポイントに GET リクエストを送信し、エンゲージメント スコアおよびその他の主要なメトリックにアクセスできます。訪問 ステップ: REST API を使用したカスタム アプリの構築 を設定する方法については、を参照してください。
フィルタリング
コンテキスト依存のルートに加えて、フィルタ クエリー パラメータを介して追加のフィルタリングが多くのルーティングでサポートされます。経路がフィルタリングをサポートしている場合、それは下のルーティング仕様でクエリー パラメータとしてリストされます。フィルタは、論理モデルに基づいて編成されます。質問のドライバーでフィルタリングするには、フィルタの前に次のようにします。
question
。例:GET /v1/engagement/drivers?filter[question.driver]=autonomy
フィールドのマッチングでは、多くの演算子がサポートされています。例: オートコンプリートおよび報酬ドライバーのスコアのみを取得する場合は、次のフィルタを指定できます。
GET /v1/engagement/drivers?filter[question.driver]=autonomy,reward$in
サポートされているフィルタリング演算子のリストについては、以下を参照してください。 参考: Peakon API のフィルタ値。
JSON 形式
すべてのオブジェクトは、JSON API を使用して表示されます。これは、JSON を使用してオブジェクト グラフをモデリングするための方法です。
ルーティング
一部のリクエストは、会社の任意のセグメントに制限できます。特定のマネージャのすべての直属部下、または特定の部門の eNPS の分析に興味があるかもしれません。
例: "販売部門" のセグメント ID は「149」です。この部門のエンゲージメント概要は、次のリクエストによって取得できます:
GET v1/engagement/context/149/overview
セグメント ID を取得するには、コンテキスト切替スイッチを使用して、コンテキストを会社からセグメント自体に変更します。コンテキスト切替スイッチは、ページの左上隅に配置されています。セグメントの名前を検索し、選択してアクセスします。セグメント ID は、URL で以下のように表示されます。
segment/
パラメータ。コンテキスト切替の詳細については、次を参照してください: 概念: ダッシュボード コンテキスト。レート制限
Peakon はマルチテナント サービスです。個々の顧客が不必要な量のリソースを使用するのを防ぐために、レート制限が設定されています。登録された各アプリケーションには、デフォルトで以下のレート制限の対象となります。
- 1 時間あたり最大 5,000 件のリクエスト。
- ウォール クロック時間 5 分ごとに最大 12 分の処理時間。
アプリケーションがいずれかの制限を超えた場合、API はいずれかの制限を超えた場合、以下を返します。
429 Too Many Requests
回答。デフォルトの限度率は定期的にレビューされ、更新されます。