概念：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" }'
成功的身份驗證請求的回應主體將包含一個 JWT 授權令牌，可在所有後續 API 請求中使用。請注意，即使應用程式可以擁有多個授權令牌，速率限制也是按應用程式強制執行的。
使用存取權杖進行身份驗證以取得 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 Format
所有物件均使用 JSON API 呈現，這是一種使用 JSON 建模物件圖的方法。
路由
某些請求可以限制在公司的任意部分。您可能有興趣分析特定經理的所有直接下屬的參與度數據，或特定部門的 eNPS。
例如：銷售部門的細分 ID 為 149。可以透過以下請求取得該部門的參與概述：
GET v1/engagement/context/149/overview
若要取得細分 ID，請使用上下文切換器將上下文從公司變更為細分本身。上下文切換器位於頁面的左上角。搜尋片段的名稱並選擇它來存取它。片段 ID 出現在 URL 中的
segment/
範圍。有關上下文切換器的更多信息，請訪問 概念：儀表板上下文。速率限制
Peakon 是一項多租用戶服務。設定速率限制是為了防止個別客戶消耗過多的資源。每個註冊的應用程式預設受到以下速率限制：
- 每小時最多 5000 個請求。
- 每 5 分鐘的掛鐘時間最多需要 12 分鐘的處理時間。
如果您的應用程式超出任一限制，API 將傳回
429 Too Many Requests
回覆.預設速率限制會定期審查和更新。