Secure Code Warrior （獨立發行者）（預覽版）

此 Secure Code Warrior（https://securecodewarrior.com）連接器提供對學習平台的程式設計存取。 Secure Code Warrior 使安全編碼成為開發人員提高軟體安全技能的積極且引人入勝的體驗。透過我們的旗艦學習平台，我們引導每位編碼人員遵循他們自己喜歡的學習路徑，以便具備安全技能的開發人員成為我們互聯世界的日常超級英雄。

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
邏輯應用程式	標準	所有 Logic Apps 區域，但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部（DoD）
Power Apps	進階	除下列區域外的所有 Power Apps 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
Power Automate（自動化服務）	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）

連絡人
名稱	特洛伊·泰勒
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

連接器中繼資料
Publisher	日立解決方案
進一步了解 Secure Code Warrior	https://docs.microsoft.com/connectors/securecodewarrior
網站	https://www.securecodewarrior.com/
隱私策略	https://www.securecodewarrior.com/trust/privacy-policy
類別	資訊科技營運

正在建立連線

連接器支援下列驗證類型：


預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
API 令牌	securestring	此 API 的 API 權杖	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

刪除使用者	刪除指定 ID 所參考的使用者。
刪除團隊	這用於刪除團隊。
取得使用者	這可用來擷取單一使用者記錄。回應可以透過傳入列出要傳回的屬性名稱的欄位查詢參數來調整。
取得團隊	此端點將傳回團隊物件清單，其中包含與團隊相關的一系列資料點。這包括團隊 ID，可與其他團隊 API 端點搭配使用。
取得團隊詳細資料	這可用來取得小組的詳細資料。
取得所有課程	此端點將傳回 Course 物件清單，其中包含與課程相關的一系列資料點。這包括課程 ID，可與其他課程 API 端點搭配使用。
取得活動表現最佳者	這用於檢索表現最好的用戶列表。
取得評估嘗試	此端點會傳回所有已使用指定ID進行評定的開發人員的詳細報告。報表的範圍可以透過多種方式進行篩選。您可以透過提供給定開發人員的電子郵件地址來篩選結果給給定的查詢。如果提供開始日期，則只會包含在此日期之後（並包含）開始或完成的嘗試。如果提供結束日期，則只會包含在此日期之前開始或完成的挑戰。同時提供兩者表示要篩選的日期範圍。這包括摘要報告中的所有數據，以及評估中所有挑戰的詳細資訊。
取得評量	此端點將傳回評估物件清單，其中包含與評估相關的一系列資料點。這包括評定 ID，可與其他評定 API 端點搭配使用。
取得課程網址	包含課程 URL 的 JSON
取得資源	學習資源清單
取得開發人員活動	此端點會傳回組織內所有開發人員的詳細挑戰日誌，以及開發人員的挑戰分數、難度和挑戰結果。
取得開發人員進度	此端點會傳回組織內所有開發人員的訓練進度，以及目前的領域、等級和任務進度。
取得開發者排行榜	此端點會傳回組織內所有開發人員的清單，其中包含其目前的統計資料，以及報告期間（可能是 1、7 或 30 天）的統計資料變更。
建立使用者	建立使用者。
建立團隊	這可用來建立團隊。
指派評量	此端點會將指定的評定指派給指定的使用者/小組。傳回指派給評定的使用者清單，其中包含其電子郵件、inviteUrl 和狀態，指出是否已傳送邀請電子郵件。
搜尋使用者	這可用來擷取所有使用者記錄。回應可以透過傳入列出要傳回的屬性名稱的欄位查詢參數來調整。過濾是通過文本傳遞過濾條件來實現的。
搜尋學習進度	學習說明篩選器 - 使用者、小組和標籤
搜尋評估嘗試	此端點會傳回所有已使用指定ID進行評定的開發人員的詳細報告。報表的範圍可以透過多種方式進行篩選。您可以透過提供查詢中的電子郵件地址來篩選給定開發人員的結果。如果提供狀態，則只會包括具有指定狀態的評估嘗試。如果提供團隊名稱，則僅包括這些團隊內使用者的評估嘗試。如果提供標籤，則只會包含具有這些標籤的使用者的評估嘗試。如果提供pass_status，則只會包含具有指定pass_status的評量嘗試。這包括摘要報告中的所有數據，以及評估中所有挑戰的詳細資訊。
搜尋課程開發人員進度	此端點會傳回組織內所有開發人員的課程進度。
搜尋錦標賽排行榜	此端點會傳回單一錦標賽的排行榜。這包括開發人員參與的所有級別、挑戰和階段，以及每個級別的詳細指標。此端點也可以在報告期間（可能是 1、7 或 30 天）或指定日期範圍內傳回排行榜。可以根據開發人員電子郵件、開發人員標籤和團隊名稱過濾結果。
搜尋開發人員排行榜	此端點會傳回組織內所有開發人員的清單，以及他們目前的統計資料。這也會列出報表期間（可能是 1、7 或 30 天）或指定日期範圍內的統計資料變化。可以根據開發人員電子郵件、開發人員標籤和團隊名稱過濾結果。
搜尋開發人員活動	此端點會傳回組織內所有開發人員的詳細挑戰日誌，以及開發人員的挑戰分數、難度和挑戰結果。這也會列出報表期間（可能是 1、7 或 30 天）或指定日期範圍內的挑戰記錄。可以根據開發人員電子郵件、開發人員標籤和團隊名稱過濾結果。
搜尋開發人員進度	此端點會傳回組織內所有開發人員的訓練進度，以及目前的領域、等級和任務進度。這也會列出開發者在報表期間（可能是 1、7 或 30 天）或指定日期範圍內的進度變化。可以根據開發人員電子郵件、開發人員標籤和團隊名稱過濾結果。
更新使用者	使用給定的資料更新使用者。標籤將被替換。
更新團隊詳細資料	這可用來更新小組的詳細資料。
檢索評估	此端點將傳回評估物件清單，其中包含與評估相關的一系列資料點。這包括評定 ID，可與其他評定 API 端點搭配使用。可以根據狀態、名稱、支持的語言和難度過濾結果。
獲取團隊排行榜	此端點會傳回組織內所有小組的清單，其中包含其目前的統計資料，以及報告期間（可能是 1、7 或 30 天）的統計資料變更。
獲取所有開發人員的課程進度	此端點將傳回指定課程的所有開發人員的進度。
獲取活動優勢和劣勢	此端點會傳回公司、團隊或使用者（取決於查詢的精細程度）特定語言或所有語言的平均優勢和劣勢
獲取用戶	這可用來擷取所有使用者記錄。回應可以透過傳入列出要傳回的屬性名稱的欄位查詢參數來調整。
獲取花費的時間	在平台上花費的時間包括評估、學習、錦標賽和培訓。
獲取錦標賽排行榜	此端點會傳回單一錦標賽的排行榜。這包括開發人員參與的所有級別、挑戰和階段，以及每個級別的詳細指標。
獲得錦標賽	此端點會傳回公司中的錦標賽清單。
讓團隊活動最投入	此端點會傳回前 'N' 個最投入的團隊。
讓用戶活動最投入	此端點會傳回前 'N' 個參與度最高的使用者。
顯示已完成、已閱讀或觀看的學習資源	學習說明

刪除使用者

作業識別碼：: UserDelete

刪除指定 ID 所參考的使用者。

參數

名稱	機碼	必要	類型	Description
ID	id	True	string	使用者資源識別碼。

傳回

已刪除使用者: UserDeleted

刪除團隊

作業識別碼：: TeamDelete

這用於刪除團隊。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	team_id	True	string	團隊識別碼

傳回

團隊刪除回應

身體: TeamDeleteResponse

取得使用者

作業識別碼：: UserGet

這可用來擷取單一使用者記錄。回應可以透過傳入列出要傳回的屬性名稱的欄位查詢參數來調整。

參數

名稱	機碼	必要	類型	Description
ID	id	True	string	使用者資源識別碼。
ID 類型	idtype		string	用於對URL中的使用者ID類型進行分類。
Fields	fields		string	欄位陣列。只會傳回篩選器中指定的屬性。每個屬性都應該以逗號分隔。

傳回

用戶數據: UserData

取得團隊

作業識別碼：: TeamsGet

此端點將傳回團隊物件清單，其中包含與團隊相關的一系列資料點。這包括團隊 ID，可與其他團隊 API 端點搭配使用。

參數

名稱	機碼	必要	類型	Description
頁面	page		integer	結果的頁碼
小組名稱	name		string	團隊名稱

傳回

名稱	路徑	類型	Description
團隊	teams	array of TeamDetails
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

取得團隊詳細資料

作業識別碼：: TeamGetDetails

這可用來取得小組的詳細資料。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	team_id	True	string	團隊識別碼

傳回

團隊詳情

身體: TeamDetails

取得所有課程

作業識別碼：: CoursesGet

此端點將傳回 Course 物件清單，其中包含與課程相關的一系列資料點。這包括課程 ID，可與其他課程 API 端點搭配使用。

參數

名稱	機碼	必要	類型	Description
頁面	page		integer	結果的頁碼

傳回

名稱	路徑	類型	Description
課程	courses	array of Course
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

取得活動表現最佳者

作業識別碼：: ActivityGetTopPerform

這用於檢索表現最好的用戶列表。

參數

名稱	機碼	類型	Description
報告期間	report_period	integer	檢視統計資料變更的天數
使用者數量	num_users	integer	要傳回的表現最好的人數量
頁面	page	integer	結果的頁碼
Tags	tags	string	篩選結果以顯示指定標籤的熱門執行器。指定的標籤會以逗號分隔，並使用 OR 邏輯來篩選結果。
球隊	team	string	篩選結果以顯示給定團隊的最佳表現者
開始時間	starttime	date-time	包括在給定時間或之後完成的進度的分數。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
結束時間	endtime	date-time	包括在給定時間或之前完成的進度的分數。格式：YYYY-MM-DDTHH：mm：ss。SSSZ

傳回

名稱	路徑	類型	Description
結構描述	schema	TopPerformers	表現最好的人名單

取得評估嘗試

作業識別碼：: AssessmentGetAttempts

此端點會傳回所有已使用指定ID進行評定的開發人員的詳細報告。報表的範圍可以透過多種方式進行篩選。您可以透過提供給定開發人員的電子郵件地址來篩選結果給給定的查詢。如果提供開始日期，則只會包含在此日期之後（並包含）開始或完成的嘗試。如果提供結束日期，則只會包含在此日期之前開始或完成的挑戰。同時提供兩者表示要篩選的日期範圍。這包括摘要報告中的所有數據，以及評估中所有挑戰的詳細資訊。

參數

名稱	機碼	必要	類型	Description
評量標識碼	assessment_id	True	string	評量標識碼
頁面	page		integer	結果的頁碼
開發者電子郵件	developer		string	要篩選的開發人員電子郵件地址
開始日期	startdate		date-time	只有在指定日期及之後才開始返回嘗試。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
結束日期	enddate		date-time	只有在指定日期之前開始或完成的傳回嘗試。格式：YYYY-MM-DDTHH：mm：ss。SSSZ

傳回

名稱	路徑	類型	Description
嘗試	attempts	array of object	嘗試
ID	attempts._id	string	評量嘗試標識碼
Assessment	attempts._assessment	string	它所屬的評估
評量名稱	attempts.name	string	評量名稱
名稱	attempts.developer.name	string	開發者的名字（名字+中間名+姓氏）。
Email	attempts.developer.email	string	開發人員的電子郵件地址。
會員自	attempts.developer.member_since	string	開發人員成為成員的日期。
上次登入	attempts.developer.last_logged_in	string	開發人員上次登入的日期。
地位	attempts.developer.status	string	開發人員帳戶的目前狀態。
公司	attempts.developer.company	string	開發人員所屬的公司名稱。
球隊	attempts.developer.team	string	開發人員所屬的小組名稱。
tags	attempts.developer.tags	array of string	tags
角色	attempts.developer.roles	array of string	角色
地位	attempts.status	string	表示可能處於待處理、進行中、已完成或「無法觸及」的挑戰/評估的狀態。
語言	attempts.language	string	評估的語言/框架。 null = 未選擇語言/架構進行支援多種語言的評估。
Started	attempts.started	string	評估開始的日期/時間。
完成	attempts.completed	string	評估完成的日期/時間
Deadline	attempts.deadline	string	評估截止日期的日期/時間。如果評量沒有時間限制，則截止日期將為空。
Score	attempts.score	integer	%年的評估分數。
完成時間	attempts.completed_in	string	完成評量嘗試所花費的時間量。
及格成績	attempts.passing_grade	integer	通過評估所需的百分比。
通行證狀態	attempts.pass_status	string	評定的通過狀態。
正確	attempts.progress.correct	integer	正確挑戰的數量。
不對	attempts.progress.incorrect	integer	錯誤挑戰的數量。
挑戰數量	attempts.progress.number_of_challenges	integer	挑戰總數。
完成	attempts.progress.completed	integer	評估完成的日期/時間。
位於	attempts.accuracy.located	integer	位於的漏洞 %
已識別	attempts.accuracy.identified	integer	已識別的弱點 %
已修正	attempts.accuracy.fixed	integer	已修正的漏洞 %
挑戰	attempts.challenges	array of object	挑戰
數字	attempts.challenges.number	integer	數字
分類	attempts.challenges.category	string	分類
子類別	attempts.challenges.subcategory	string	子類別
䂚	attempts.challenges.difficulty	string	䂚
狀態	attempts.challenges.status	string	狀態
max_score	attempts.challenges.max_score	integer	max_score
分數	attempts.challenges.score	integer	分數
狀態	attempts.challenges.locate.status	string	狀態
狀態	attempts.challenges.identify.status	string	狀態
狀態	attempts.challenges.fix.status	string	狀態
總頁數	links.total_pages	integer	結果中的總頁數。
每頁結果	links.results_per_page	integer	每個頁面中的結果數目上限。
下一頁	links.next_page	integer	下一頁的頁碼（如果存在的話）。
上一頁	links.prev_page	integer	上一頁的頁碼（如果存在的話）。
總結果	links.total_results	integer	結果總數。

取得評量

作業識別碼：: AssessmentsGet

此端點將傳回評估物件清單，其中包含與評估相關的一系列資料點。這包括評定 ID，可與其他評定 API 端點搭配使用。

參數

名稱	機碼	類型	Description
頁面	page	integer	結果的頁碼
開始日期	startdate	date-time	只有在給定日期及之後才開始報稅評估。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
結束日期	enddate	date-time	只有在指定日期之前開始或完成的報稅評估。格式：YYYY-MM-DDTHH：mm：ss。SSSZ

傳回

名稱	路徑	類型	Description
評量	assessments	array of Assessment
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

取得課程網址

作業識別碼：: CourseGetURL

包含課程 URL 的 JSON

參數

名稱	機碼	必要	類型	Description
語言框架	language_framework	True	string	語言和框架的名稱，格式為“Java：：Spring”
Course	course	True	string	當然是名稱
模組	module	True	string	課程模組名稱
重新導向	redirect		boolean	將使用者重新導向至傳回 URL

傳回

訓練課程的網址

課程網址: CourseURL

取得資源

作業識別碼：: LearningGetResources

學習資源清單

傳回

名稱	路徑	類型	Description
resources	resources	array of Resource

取得開發人員活動

作業識別碼：: DeveloperGetActivity

此端點會傳回組織內所有開發人員的詳細挑戰日誌，以及開發人員的挑戰分數、難度和挑戰結果。

參數

名稱	機碼	必要	類型	Description
頁面	page		integer	結果的頁碼

傳回

給定時段內挑戰的詳細日誌

開發者活動: DevelopersActivity

取得開發人員進度

作業識別碼：: DeveloperGetProgress

此端點會傳回組織內所有開發人員的訓練進度，以及目前的領域、等級和任務進度。

參數

名稱	機碼	必要	類型	Description
頁面	page		integer	結果的頁碼

傳回

這包含每個開發人員在每種語言、領域、級別和任務上的進度

開發者進度: DevelopersProgress

取得開發者排行榜

作業識別碼：: DeveloperGetLeaderboard

此端點會傳回組織內所有開發人員的清單，其中包含其目前的統計資料，以及報告期間（可能是 1、7 或 30 天）的統計資料變更。

參數

名稱	機碼	類型	Description
報告期間	report_period	integer	檢視統計資料變更的天數
頁面	page	integer	結果的頁碼
開始日期	startdate	date-time	包括在指定時間或之後完成的排行榜進度。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
結束日期	enddate	date-time	包括在給定時間或之前完成的排行榜進度。格式：YYYY-MM-DDTHH：mm：ss。SSSZ

傳回

名稱	路徑	類型	Description
排行榜	leaderboard	array of object	排行榜
等級	leaderboard.rank	integer	參賽者在錦標賽中的最終位置。
名稱	leaderboard.developer.name	string	開發者姓名（名字+中間+姓氏）
Email	leaderboard.developer.email	string	開發人員的電子郵件地址。
會員自	leaderboard.developer.member_since	string	開發人員成為成員的日期。
上次登入	leaderboard.developer.last_logged_in	string	開發人員上次登入的日期。
地位	leaderboard.developer.status	string	開發人員帳戶的目前狀態。
公司	leaderboard.developer.company	string	開發人員所屬的公司名稱
球隊	leaderboard.developer.team	string	開發人員所屬的小組名稱。
tags	leaderboard.developer.tags	array of string	tags
角色	leaderboard.developer.roles	array of string	角色
已封鎖	leaderboard.blocked	boolean	該參賽者是否被阻止參加比賽。
花費的分鐘數	leaderboard.minutes_spent	integer	開發人員回答的時間（以分鐘為單位）。
語言	leaderboard.language	string	參與者使用的語言/框架。
最高積分	leaderboard.max_points	integer	錦標賽中可用的最高積分
Points	leaderboard.points	integer	參與者獲得的積分。
使用的提示	leaderboard.hints_used	integer	參與者使用的提示數量。
失去的生命	leaderboard.lives_lost	integer	參賽者在比賽期間失去的生命數量。
級別	leaderboard.levels	array of object	級別
名稱	leaderboard.levels.name	string	名稱
挑戰	leaderboard.levels.challenges	array of object	挑戰
數字	leaderboard.levels.challenges.number	integer	數字
分類	leaderboard.levels.challenges.category	string	分類
子類別	leaderboard.levels.challenges.subcategory	string	子類別
䂚	leaderboard.levels.challenges.difficulty	string	䂚
狀態	leaderboard.levels.challenges.status	string	狀態
max_points	leaderboard.levels.challenges.max_points	integer	max_points
積分	leaderboard.levels.challenges.points	integer	積分
codebase_size	leaderboard.levels.challenges.codebase_size	string	codebase_size
minutes_spent	leaderboard.levels.challenges.minutes_spent	integer	minutes_spent
stages	leaderboard.levels.challenges.stages	array of object	stages
數字	leaderboard.levels.challenges.stages.number	integer	數字
名稱	leaderboard.levels.challenges.stages.name	string	名稱
狀態	leaderboard.levels.challenges.stages.status	string	狀態
積分	leaderboard.levels.challenges.stages.points	integer	積分
max_points	leaderboard.levels.challenges.stages.max_points	integer	max_points
minutes_spent	leaderboard.levels.challenges.stages.minutes_spent	integer	minutes_spent
lives_lost	leaderboard.levels.challenges.stages.lives_lost	integer	lives_lost
hints_used	leaderboard.levels.challenges.stages.hints_used	integer	hints_used
總頁數	links.total_pages	integer	結果中的總頁數
每頁結果	links.results_per_page	integer	每個頁面中的結果數目上限。
下一頁	links.next_page	integer	下一頁的頁碼（如果存在的話）。
上一頁	links.prev_page	integer	上一頁的頁碼（如果存在的話）。
總結果	links.total_results	integer	結果總數。

建立使用者

作業識別碼：: UserCreate

建立使用者。

參數

名稱	機碼	必要	類型	Description
發送邀請	sendInvite		boolean	旗標以停用使用者邀請和邀請提醒。
enabled	enabled		boolean	平台上的用戶狀態
電子郵件	email	True	string	使用者的電子郵件
isProfile完整	isProfileComplete		boolean	視需要轉換完成設定檔所需的屬性。如果視需要設定為 true 屬性 'name.first' 和 'name.last'，否則名稱是選擇性的
先	first		string	使用者名字。如果 'isProfileComplete' 設定為 true，則為必要
中	middle		string	使用者中間名
last	last		string	使用者姓氏。如果 'isProfileComplete' 設定為 true，則為必要
角色	role	True	string	指派給使用者的角色，是開發人員、團隊經理或公司管理員之一
小組	team		string	使用者相關聯的團隊
tags	tags		array of string	有關使用者的任何識別資訊。範例：總部、Asia-Pacific
_id	_id		string	語言識別碼
_床	_framework		string	語言框架

傳回

使用者已建立: UserCreated

建立團隊

作業識別碼：: TeamCreate

這可用來建立團隊。

參數

名稱	機碼	類型	Description
名稱	name	string	小組名稱
tags	tags	array of string	有關團隊的任何識別信息。範例：總部、亞太地區、工程
activeFrom	activeFrom	string	團隊活躍來自。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
有效直到	activeUntil	string	團隊活躍直到。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
語言	languages	array of string	團隊語言列表，_id和_framework以雙冒號（：:) 分隔，並以逗號（，）分隔
onboarding訊息	onboardingmessage	string	團隊入職訊息
型別	type	string	授權類型
授予	granted	integer	已授與的授權（只有在授權類型設定為使用時才有效）

傳回

團隊詳情

身體: TeamDetails

指派評量

作業識別碼：: AssessmentAssign

此端點會將指定的評定指派給指定的使用者/小組。傳回指派給評定的使用者清單，其中包含其電子郵件、inviteUrl 和狀態，指出是否已傳送邀請電子郵件。

參數

名稱	機碼	必要	類型	Description
評量標識碼	assessment_id	True	string	評量標識碼
users	users		array of string	要指派評量的使用者清單
團隊	teams		array of string	要指派評量的小組清單
發送電子郵件	sendEmail		boolean	旗標以指出指派評量時是否傳送評量邀請電子郵件（預設值：true）

傳回

名稱	路徑	類型	Description
評估邀請	assessmentInvitations	array of AssessmentAssignResponse

搜尋使用者

作業識別碼：: UserSearch

這可用來擷取所有使用者記錄。回應可以透過傳入列出要傳回的屬性名稱的欄位查詢參數來調整。過濾是通過文本傳遞過濾條件來實現的。

參數

名稱	機碼	類型	Description
Fields	fields	string	欄位陣列。只會傳回提供的屬性。每個屬性都應該以逗號分隔。
頁面	page	integer	傳回編頁結果集的指定頁碼。頁面大小為 1000 筆記錄。
識別碼	id	string	使用者資源識別碼
電子郵件	email	string	使用者的電子郵件
角色	role	string	指派給使用者的角色，是開發人員、團隊經理或公司管理員之一
小組	team	string	使用者相關聯的團隊
tags	tags	array of string	有關使用者的任何識別資訊。範例：總部、Asia-Pacific

傳回

使用者資料清單

使用者清單: UsersList

搜尋學習進度

作業識別碼：: LearningSearchProgress

學習說明篩選器 - 使用者、小組和標籤

參數

名稱	機碼	類型	Description
users	users	string	要包含在學習進度中的使用者（一或多個使用者電子郵件，以逗號分隔）
team_names	team_names	string	團隊名稱（一個或多個團隊名稱，以逗號分隔）
tags	tags	string	使用者標籤（一或多個使用者標籤，以逗號分隔）
頁面	page	integer	結果的頁碼

傳回

名稱	路徑	類型	Description
開發人員	developers	array of ResourceRecord
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

搜尋評估嘗試

作業識別碼：: AssessmentSearchAttempts

此端點會傳回所有已使用指定ID進行評定的開發人員的詳細報告。報表的範圍可以透過多種方式進行篩選。您可以透過提供查詢中的電子郵件地址來篩選給定開發人員的結果。如果提供狀態，則只會包括具有指定狀態的評估嘗試。如果提供團隊名稱，則僅包括這些團隊內使用者的評估嘗試。如果提供標籤，則只會包含具有這些標籤的使用者的評估嘗試。如果提供pass_status，則只會包含具有指定pass_status的評量嘗試。這包括摘要報告中的所有數據，以及評估中所有挑戰的詳細資訊。

參數

名稱	機碼	類型	Description
assessment_id	assessment_id	string	評量標識碼
名稱	name	string	評量名稱
users	users	string	嘗試評量的使用者（一或多個使用者電子郵件，以逗號分隔）
狀態	status	string	評估嘗試狀態
team_names	team_names	string	團隊名稱（一個或多個團隊名稱，以逗號分隔）
tags	tags	string	使用者標籤（一或多個使用者標籤，以逗號分隔）
pass_status	pass_status	string	評量嘗試通過狀態
頁面	page	integer	結果的頁碼

傳回

名稱	路徑	類型	Description
嘗試	attempts	array of object	嘗試
ID	attempts._id	string	評量嘗試標識碼
Assessment	attempts._assessment	string	它所屬的評估
評量名稱	attempts.name	string	評量名稱
名稱	attempts.developer.name	string	開發者的名字（名字+中間名+姓氏）。
Email	attempts.developer.email	string	開發人員的電子郵件地址。
會員自	attempts.developer.member_since	string	開發人員成為成員的日期。
上次登入	attempts.developer.last_logged_in	string	開發人員上次登入的日期。
地位	attempts.developer.status	string	開發人員帳戶的目前狀態。
公司	attempts.developer.company	string	開發人員所屬的公司名稱。
球隊	attempts.developer.team	string	開發人員所屬的小組名稱。
tags	attempts.developer.tags	array of string	tags
角色	attempts.developer.roles	array of string	角色
地位	attempts.status	string	表示可能處於待處理、進行中、已完成或「無法觸及」的挑戰/評估的狀態。
語言	attempts.language	string	評估的語言/框架。 null = 未選擇語言/架構進行支援多種語言的評估。
Started	attempts.started	string	評估開始的日期/時間。
完成	attempts.completed	string	評估完成的日期/時間
Deadline	attempts.deadline	string	評估截止日期的日期/時間。如果評量沒有時間限制，則截止日期將為空。
Score	attempts.score	integer	%年的評估分數。
完成時間	attempts.completed_in	string	完成評量嘗試所花費的時間量。
及格成績	attempts.passing_grade	integer	通過評估所需的百分比。
通行證狀態	attempts.pass_status	string	評定的通過狀態。
正確	attempts.progress.correct	integer	正確挑戰的數量。
不對	attempts.progress.incorrect	integer	錯誤挑戰的數量。
挑戰數量	attempts.progress.number_of_challenges	integer	挑戰總數。
完成	attempts.progress.completed	integer	評估完成的日期/時間。
位於	attempts.accuracy.located	integer	位於的漏洞 %
已識別	attempts.accuracy.identified	integer	已識別的弱點 %
已修正	attempts.accuracy.fixed	integer	已修正的漏洞 %
挑戰	attempts.challenges	array of object	挑戰
數字	attempts.challenges.number	integer	數字
分類	attempts.challenges.category	string	分類
子類別	attempts.challenges.subcategory	string	子類別
䂚	attempts.challenges.difficulty	string	䂚
狀態	attempts.challenges.status	string	狀態
max_score	attempts.challenges.max_score	integer	max_score
分數	attempts.challenges.score	integer	分數
狀態	attempts.challenges.locate.status	string	狀態
狀態	attempts.challenges.identify.status	string	狀態
狀態	attempts.challenges.fix.status	string	狀態
總頁數	links.total_pages	integer	結果中的總頁數。
每頁結果	links.results_per_page	integer	每個頁面中的結果數目上限。
下一頁	links.next_page	integer	下一頁的頁碼（如果存在的話）。
上一頁	links.prev_page	integer	上一頁的頁碼（如果存在的話）。
總結果	links.total_results	integer	結果總數。

搜尋課程開發人員進度

作業識別碼：: DeveloperSearchProgress

此端點會傳回組織內所有開發人員的課程進度。

參數

名稱	機碼	類型	Description
頁面	page	integer	結果的頁碼
course_id	course_id	array of uuid	課程 ID 陣列
user_id	user_id	array of uuid	使用者資源 ID 陣列
狀態	status	string	課程狀態

傳回

名稱	路徑	類型	Description
資料	data	array of object
user_id	data.user_id	string	使用者資源識別碼
狀態	data.status	string	課程狀態
正確性	data.accuracy	integer	正確嘗試的百分比
信賴度	data.confidence	integer	已使用的點擊與可用提示的比率
minutes_spent	data.minutes_spent	integer	使用者在課程上花費的總時間（以分鐘為單位）
first_completed_date	data.first_completed_date	date-time	完成第一門課程語言的日期
first_enrolled_date	data.first_enrolled_date	date-time	註冊第一門課程語言的日期
進展	data.progress	integer	課程進度
語言	data.languages	array of CourseDeveloperProgressLanguageEntry	課程語言列表
邀請	data.invites	array of CourseDeveloperProgressInviteEntry	邀請和提醒清單
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

搜尋錦標賽排行榜

作業識別碼：: TournamentSearchLeaderboard

此端點會傳回單一錦標賽的排行榜。這包括開發人員參與的所有級別、挑戰和階段，以及每個級別的詳細指標。此端點也可以在報告期間（可能是 1、7 或 30 天）或指定日期範圍內傳回排行榜。可以根據開發人員電子郵件、開發人員標籤和團隊名稱過濾結果。

參數

名稱	機碼	必要	類型	Description
錦標賽 ID	tournament_id	True	string	錦標賽 ID
report_period_in_days	report_period_in_days		integer	要報告的過去天數（有效值 - 1、7 和 30 天）
開始日期	startdate		string	開發者排行榜在指定時間或之後完成。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
結束日期	enddate		string	開發者排行榜在指定時間或之前完成。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
users	users		string	要包含在排行榜中的使用者（一或多個使用者電子郵件，以逗號分隔）
team_names	team_names		string	團隊名稱（一個或多個團隊名稱，以逗號分隔）
tags	tags		string	使用者標籤（一或多個使用者標籤，以逗號分隔）
頁面	page		integer	結果的頁碼

傳回

名稱	路徑	類型	Description
排行榜	leaderboard	array of TournamentParticipant
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

搜尋開發人員排行榜

作業識別碼：: DeveloperSearchLeaderboard

此端點會傳回組織內所有開發人員的清單，以及他們目前的統計資料。這也會列出報表期間（可能是 1、7 或 30 天）或指定日期範圍內的統計資料變化。可以根據開發人員電子郵件、開發人員標籤和團隊名稱過濾結果。

參數

名稱	機碼	類型	Description
report_period_in_days	report_period_in_days	integer	要報告的過去天數（有效值 - 1、7 和 30 天）
開始日期	startdate	string	開發者排行榜在指定時間或之後完成。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
結束日期	enddate	string	開發者排行榜在指定時間或之前完成。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
users	users	string	要包含在排行榜中的使用者（一或多個使用者電子郵件，以逗號分隔）
team_names	team_names	string	團隊名稱（一個或多個團隊名稱，以逗號分隔）
tags	tags	string	使用者標籤（一或多個使用者標籤，以逗號分隔）
頁面	page	integer	結果的頁碼

傳回

名稱	路徑	類型	Description
排行榜	leaderboard	array of object	排行榜
等級	leaderboard.rank	integer	參賽者在錦標賽中的最終位置。
名稱	leaderboard.developer.name	string	開發者的名字（名字+中間名+姓氏）。
Email	leaderboard.developer.email	string	開發人員電子郵件地址
會員自	leaderboard.developer.member_since	string	開發人員成為成員的日期。
上次登入	leaderboard.developer.last_logged_in	string	開發人員上次登入的日期。
地位	leaderboard.developer.status	string	開發人員帳戶的目前狀態。
公司	leaderboard.developer.company	string	開發人員所屬的公司名稱。
球隊	leaderboard.developer.team	string	開發人員所屬的小組名稱。
tags	leaderboard.developer.tags	array of string	tags
角色	leaderboard.developer.roles	array of string	角色
已封鎖	leaderboard.blocked	boolean	該參賽者是否被阻止參加比賽。
花費的分鐘數	leaderboard.minutes_spent	integer	開發人員回答的時間（以分鐘為單位）。
語言	leaderboard.language	string	參與者使用的語言/框架。
最高積分	leaderboard.max_points	integer	錦標賽中可用的最大積分。
Points	leaderboard.points	integer	參與者獲得的積分。
使用的提示	leaderboard.hints_used	integer	參與者使用的提示數量。
失去的生命	leaderboard.lives_lost	integer	參賽者在比賽期間失去的生命數量。
級別	leaderboard.levels	array of object	級別
名稱	leaderboard.levels.name	string	名稱
挑戰	leaderboard.levels.challenges	array of object	挑戰
數字	leaderboard.levels.challenges.number	integer	數字
分類	leaderboard.levels.challenges.category	string	分類
子類別	leaderboard.levels.challenges.subcategory	string	子類別
䂚	leaderboard.levels.challenges.difficulty	string	䂚
狀態	leaderboard.levels.challenges.status	string	狀態
max_points	leaderboard.levels.challenges.max_points	integer	max_points
積分	leaderboard.levels.challenges.points	integer	積分
codebase_size	leaderboard.levels.challenges.codebase_size	string	codebase_size
minutes_spent	leaderboard.levels.challenges.minutes_spent	integer	minutes_spent
stages	leaderboard.levels.challenges.stages	array of object	stages
數字	leaderboard.levels.challenges.stages.number	integer	數字
名稱	leaderboard.levels.challenges.stages.name	string	名稱
狀態	leaderboard.levels.challenges.stages.status	string	狀態
積分	leaderboard.levels.challenges.stages.points	integer	積分
max_points	leaderboard.levels.challenges.stages.max_points	integer	max_points
minutes_spent	leaderboard.levels.challenges.stages.minutes_spent	integer	minutes_spent
lives_lost	leaderboard.levels.challenges.stages.lives_lost	integer	lives_lost
hints_used	leaderboard.levels.challenges.stages.hints_used	integer	hints_used
總頁數	links.total_pages	integer	結果中的總頁數。
每頁結果	links.results_per_page	integer	每個頁面中的結果數目上限。
下一頁	links.next_page	integer	下一頁的頁碼（如果存在的話）。
上一頁	links.prev_page	integer	上一頁的頁碼（如果存在的話）。
總結果	links.total_results	integer	結果總數。

搜尋開發人員活動

作業識別碼：: DeveloperSearchActivity

此端點會傳回組織內所有開發人員的詳細挑戰日誌，以及開發人員的挑戰分數、難度和挑戰結果。這也會列出報表期間（可能是 1、7 或 30 天）或指定日期範圍內的挑戰記錄。可以根據開發人員電子郵件、開發人員標籤和團隊名稱過濾結果。

參數

名稱	機碼	類型	Description
report_period_in_days	report_period_in_days	integer	要報告的過去天數（有效值 - 1、7 和 30 天）
開始日期	startdate	string	在指定時間或之後完成的開發者挑戰日誌。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
結束日期	enddate	string	在指定時間或之前完成的開發人員挑戰記錄。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
users	users	string	要包含在挑戰記錄中的使用者（一或多個使用者電子郵件，以逗號分隔）
team_names	team_names	string	團隊名稱（一個或多個團隊名稱，以逗號分隔）
tags	tags	string	使用者標籤（一或多個使用者標籤，以逗號分隔）
頁面	page	integer	結果的頁碼

傳回

給定時段內挑戰的詳細日誌

開發者活動: DevelopersActivity

搜尋開發人員進度

作業識別碼：: DevelopersSearchProgress

此端點會傳回組織內所有開發人員的訓練進度，以及目前的領域、等級和任務進度。這也會列出開發者在報表期間（可能是 1、7 或 30 天）或指定日期範圍內的進度變化。可以根據開發人員電子郵件、開發人員標籤和團隊名稱過濾結果。

參數

名稱	機碼	類型	Description
report_period_in_days	report_period_in_days	integer	要報告的過去天數（有效值 - 1、7 和 30 天）
開始日期	startdate	string	開發人員進度在指定時間或之後完成。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
結束日期	enddate	string	開發人員進度在指定時間或之前完成。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
users	users	string	要包含在開發人員進度中的使用者（一或多個使用者電子郵件，以逗號分隔）
team_names	team_names	string	團隊名稱（一個或多個團隊名稱，以逗號分隔）
tags	tags	string	使用者標籤（一或多個使用者標籤，以逗號分隔）
頁面	page	integer	結果的頁碼

傳回

這包含每個開發人員在每種語言、領域、級別和任務上的進度

開發者進度: DevelopersProgress

更新使用者

作業識別碼：: UserUpdate

使用給定的資料更新使用者。標籤將被替換。

參數

名稱	機碼	必要	類型	Description
ID	id	True	string	使用者資源識別碼。
跳過 SSO 通知	skipNotifyIfSso		boolean	用於停用傳送給使用者的電子郵件通知的變更。
電子郵件	email		email	使用者的電子郵件地址
enabled	enabled		boolean	平台上的用戶狀態
角色	role		string	指派給使用者的角色，是開發人員、團隊經理或公司管理員之一
小組	team		string	使用者相關聯的團隊
tags	tags		array of string	有關使用者的任何識別資訊。範例：總部、Asia-Pacific
_id	_id		string	語言識別碼
_床	_framework		string	語言框架

傳回

用戶更新: UserUpdated

更新團隊詳細資料

作業識別碼：: TeamUpdate

這可用來更新小組的詳細資料。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	team_id	True	string	團隊識別碼
名稱	name		string	小組名稱
tags	tags		array of string	有關團隊的任何識別信息。範例：總部、亞太地區、工程
狀態	status		string	團隊狀態
onboarding訊息	onboardingmessage		string	團隊入職訊息
語言	languages		array of string	團隊語言列表，_id和_framework以雙冒號（：:) 分隔，並以逗號（，）分隔

傳回

團隊詳情

身體: TeamDetails

檢索評估

作業識別碼：: AssessmentSearch

此端點將傳回評估物件清單，其中包含與評估相關的一系列資料點。這包括評定 ID，可與其他評定 API 端點搭配使用。可以根據狀態、名稱、支持的語言和難度過濾結果。

參數

名稱	機碼	類型	Description
狀態	status	string	評量狀態
名稱	name	string	評定名稱
_id	_id	string	語言識別碼
_床	_framework	string	語言框架
䂚	difficulty	string	評估難度
頁面	page	integer	結果的頁碼

傳回

名稱	路徑	類型	Description
評量	assessments	array of Assessment
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

獲取團隊排行榜

作業識別碼：: TeamGetLeaderboard

此端點會傳回組織內所有小組的清單，其中包含其目前的統計資料，以及報告期間（可能是 1、7 或 30 天）的統計資料變更。

參數

名稱	機碼	類型	Description
報告期間	report_period	integer	檢視統計資料變更的天數
省略非作用中	omitInactive	boolean	設定為 true 時，會從結果中省略所有非使用中的帳戶
頁面	page	integer	結果的頁碼
開始日期	startdate	date-time	包括在指定時間或之後完成的排行榜進度。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
結束日期	enddate	date-time	包括在給定時間或之前完成的排行榜進度。格式：YYYY-MM-DDTHH：mm：ss。SSSZ

傳回

response: array of TeamLeaderboard

獲取所有開發人員的課程進度

作業識別碼：: CourseGetDevelopersProgress

此端點將傳回指定課程的所有開發人員的進度。

參數

名稱	機碼	必要	類型	Description
課程 ID	course_id	True	string	課程 ID
頁面	page		integer	結果的頁碼

傳回

名稱	路徑	類型	Description
資料	data	array of CourseDeveloperProgressEntry
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

獲取活動優勢和劣勢

作業識別碼：: ActivityGetStrengthsAndWeaknesses

此端點會傳回公司、團隊或使用者（取決於查詢的精細程度）特定語言或所有語言的平均優勢和劣勢

參數

名稱	機碼	類型	Description
目標類型	targetType	string	目標類型。預設值取決於 API 金鑰的範圍。報告索引鍵預設為公司。團隊索引鍵預設為團隊。
目標識別碼	targetIdentifier	string	目標識別碼（團隊名稱、使用者電子郵件或使用者 ID）
語言 ID	languageId	string	語言識別碼
語言框架	languageFramework	string	語言框架
頁面	page	integer	結果的頁碼

傳回

平均優勢和劣勢對象

身體: StrengthsAndWeaknesses

獲取用戶

作業識別碼：: UsersGet

這可用來擷取所有使用者記錄。回應可以透過傳入列出要傳回的屬性名稱的欄位查詢參數來調整。

參數

名稱	機碼	必要	類型	Description
Fields	fields		string	欄位陣列。只會傳回提供的屬性。每個屬性都應該以逗號分隔。
頁面	page		integer	傳回編頁結果集的指定頁碼。頁面大小為 1000 筆記錄。

傳回

使用者資料清單

使用者清單: UsersList

獲取花費的時間

作業識別碼：: TimeGetSpent

在平台上花費的時間包括評估、學習、錦標賽和培訓。

參數

名稱	機碼	類型	Description
頁面	page	integer	結果的頁碼
ID	id	string	根據 UUID 格式的使用者 ID 篩選結果
Email	email	string	根據電子郵件篩選結果
Tags	tags	string	篩選結果庫以顯示具有標籤的使用者。指定的標籤會以逗號分隔，並使用 OR 邏輯來篩選結果。
球隊	team	string	篩選結果以顯示使用者屬於指定的小組
開始日期	startdate	date-time	篩選結果以包含一天開始的結果。日期格式 'YYYY-MM-DD'。在UTC中
結束日期	enddate	date-time	過濾結果以包括所有結果，直到一天結束。日期格式 'YYYY-MM-DD'。在UTC中

傳回

名稱	路徑	類型	Description
users	users	array of UsersTimeSpent
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

獲取錦標賽排行榜

作業識別碼：: TournamentGetLeaderboard

此端點會傳回單一錦標賽的排行榜。這包括開發人員參與的所有級別、挑戰和階段，以及每個級別的詳細指標。

參數

名稱	機碼	必要	類型	Description
錦標賽 ID	tournament_id	True	string	錦標賽 ID
頁面	page		integer	結果的頁碼

傳回

名稱	路徑	類型	Description
排行榜	leaderboard	array of TournamentParticipant
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

獲得錦標賽

作業識別碼：: TournamentsGet

此端點會傳回公司中的錦標賽清單。

參數

名稱	機碼	類型	Description
頁面	page	integer	結果的頁碼
比賽名稱	name	string	比賽名稱
開始日期	startdate	date-time	僅返回在給定時間或之後開始的錦標賽。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
結束日期	enddate	date-time	僅返回在給定時間或之前結束的錦標賽。時間：YYYY-MM-DDTHH：mm：ss。SSSZ

傳回

名稱	路徑	類型	Description
錦標賽	tournaments	array of Tournament
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

讓團隊活動最投入

作業識別碼：: TeamGetMostEngaged

此端點會傳回前 'N' 個最投入的團隊。

參數

名稱	機碼	類型	Description
報告期間	report_period	integer	檢視最投入團隊的天數（report_period 應單獨指定或與結束日期一起指定）
開始日期	startdate	string	日期範圍的開始日期（不應以 report_period 指定）。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
結束日期	enddate	string	日期範圍的結束日期（應大於開始日期）。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
隊伍數目	number_of_teams	integer	前“N”個團隊數量
Tags	tags	string	使用者標籤
頁面	page	integer	結果的頁碼

傳回

公司中最敬業的團隊

身體: MostEngagedTeams

讓用戶活動最投入

作業識別碼：: UserGetMostEngaged

此端點會傳回前 'N' 個參與度最高的使用者。

參數

名稱	機碼	類型	Description
報告期間	report_period	integer	檢視最多參與使用者的天數（report_period 應單獨指定或與結束日期一起指定）
開始日期	startdate	string	日期範圍的開始日期（不應以 report_period 指定）。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
結束日期	enddate	string	日期範圍的結束日期（應大於開始日期）。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
使用者人數	number_of_users	integer	前 'N' 個使用者數目
小組名稱	team_name	string	小組名稱
Tags	tags	string	使用者標籤
頁面	page	integer	結果的頁碼

傳回

公司中參與度最高的用戶

身體: MostEngagedUsers

顯示已完成、已閱讀或觀看的學習資源

作業識別碼：: LearningGetProgress

學習說明

參數

名稱	機碼	必要	類型	Description
頁面	page		integer	結果的頁碼

傳回

名稱	路徑	類型	Description
開發人員	developers	array of ResourceRecord
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

定義

比賽

名稱	路徑	類型	Description
_id	_id	string	錦標賽的 ID
名稱	name	string	比賽名稱
描述	description	string	比賽說明
開始時間	start_time	date-time	比賽開始時間
end_time	end_time	date-time	比賽結束時間
timezone	timezone	string	比賽舉行的時區

參賽者

名稱	路徑	類型	Description
順位	rank	integer	參賽者在錦標賽中的最終位置
開發人員	developer	Developer	個別開發人員的相關資訊
䠡	blocked	boolean	該參賽者是否被阻止參加巡迴賽
minutes_spent	minutes_spent	integer	開發人員回答所花費的時間（以分鐘為單位）
語言	language	string	參與者使用的語言/架構
max_points	max_points	integer	錦標賽中可用的最高積分
積分	points	integer	參與者獲得的積分數量
hints_used	hints_used	integer	參與者使用的提示數量
lives_lost	lives_lost	integer	參賽者在比賽期間失去的生命數量
級別	levels	array of Level	挑戰的級別

Level

名稱	路徑	類型	Description
名稱	name	string	層級名稱
挑戰	challenges	array of object
數字	challenges.number	integer	挑戰編號（從 1 開始）
分類	challenges.category	string	挑戰類別
子類別	challenges.subcategory	string	挑戰子類別
䂚	challenges.difficulty	string
地位	challenges.status	Status	表示可能處於待處理、進行中、已完成或「無法觸及」的挑戰/評估的狀態
max_points	challenges.max_points	integer	本次挑戰的最高積分
積分	challenges.points	integer	本次挑戰獲得的積分
codebase_size	challenges.codebase_size	string
minutes_spent	challenges.minutes_spent	integer	開發人員回答所花費的時間（以分鐘為單位）
stages	challenges.stages	array of Stage

階段

名稱	路徑	類型	Description
數字	number	integer	階段編號
名稱	name	string	舞台名稱
狀態	status	string	現階段的嘗試狀態
積分	points	integer	本階段獲得的積分
max_points	max_points	integer	此階段的最高可用積分
minutes_spent	minutes_spent	integer	開發人員回答所花費的時間（以分鐘為單位）
lives_lost	lives_lost	integer	這個舞台上喪生的人數
hints_used	hints_used	integer	此階段使用的提示數目

Assessment

名稱	路徑	類型	Description
_id	_id	string	評量標識碼
狀態	status	string	評估狀態
名稱	name	string	評量名稱
描述	description	string	評量說明
supported_languages	supported_languages	array of string	可用於評估的語言/框架列表
䂚	difficulty	string	評估的難度
success_ratio	success_ratio	integer	通過評估所需的百分比
emits_certificate	emits_certificate	boolean	評量是否與憑證相關聯？
time_limit	time_limit	integer	評估的時間限制（以毫秒為單位）。空值 = 無時間限制
start_date	start_date	date-time	評估開始日期
end_date	end_date	date-time	評量結束日期
timezone	timezone	string	評量的時區
number_of_challenges	number_of_challenges	integer	評估中的挑戰數量
self_assess	self_assess	boolean	評估是公開評估嗎？
retries_allowed	retries_allowed	boolean	此評估是否允許重試？

地位

表示可能處於待處理、進行中、已完成或「無法觸及」的挑戰/評估的狀態

地位: string

preferredDevLanguage

開發語言偏好設定

名稱	路徑	類型	Description
_id	_id	string	語言識別碼
_床	_framework	string	語言框架

評定指派回應

回應評量指派 POST 要求

名稱	路徑	類型	Description
使用者	user	string	使用者電子郵件識別碼
invite電子郵件已發送	inviteEmailSent	boolean	是否已發送邀請電子郵件？
邀請網址	inviteUrl	string	評量邀請網址

團隊排行榜

團隊排行榜包含給定報告期內有效的所有團隊排行榜條目

名稱	路徑	類型	Description
report_period_in_days	report_period_in_days	integer	要報告的過去天數
排行榜	leaderboard	array of TeamLeaderboardEntry
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

團隊排行榜進入

團隊排行榜中的條目

名稱	路徑	類型	Description
順位	rank	integer	球隊在排行榜上的排名。
名稱	name	string	小組的名稱
開發人員	developers	integer	團隊中的開發人員數量
points_average	points_average	integer	球隊平均得分
points_total	points_total	integer	球隊總積分
正確性	accuracy	integer	團隊的準確度（以 %為單位）
confidence_level	confidence_level	integer	團隊的信心水平（%）
time_spent	time_spent	integer	團隊在挑戰上花費的總分鐘數
installed_sensei	installed_sensei	integer	團隊中安裝了 sensei 的開發人員數量
報告期間的統計數據	stats_over_report_period	StatsOverReportPeriod	針對指定報告期間計算的統計資料

最投入的團隊

公司中最敬業的團隊

名稱	路徑	類型	Description
團隊	teams	array of TeamEntry	團隊詳情
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

團隊入場

此物件代表小組詳細資料

名稱	路徑	類型	Description
名稱	name	string	團隊名稱
狀態	status	string	團隊狀態
時間花費	timeSpent	integer	團隊花費的時間

最多參與的用戶

公司中參與度最高的用戶

名稱	路徑	類型	Description
users	users	array of UserEntry	使用者詳細資料
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

使用者輸入

此物件代表使用者詳細資料

名稱	路徑	類型	Description
名稱	name	string	用戶的名稱
狀態	status	string	使用者狀態
時間花費	timeSpent	integer	使用者花費的時間

統計資料超過報告期間

針對指定報告期間計算的統計資料

名稱	路徑	類型	Description
points_gained	points_gained	integer	開發者獲得的積分
accuracy_change	accuracy_change	integer	報告期內準確度的變化
confidence_level_change	confidence_level_change	integer	報告期內置信水平的變化
minutes_spent	minutes_spent	integer	團隊在挑戰上花費的分鐘數
challenges_correct	challenges_correct	integer	正確挑戰的數量
challenges_incorrect	challenges_incorrect	integer	錯誤挑戰的數量

開發人員

個別開發人員的相關資訊

名稱	路徑	類型	Description
名稱	name	string	開發者姓名（名字+中間+姓氏）
電子郵件	email	string	開發人員電子郵件地址
member_since	member_since	date-time	開發人員成為成員的日期
last_logged_in	last_logged_in	date-time	開發人員上次登入的日期
狀態	status	string	開發人員帳戶的目前狀態
公司	company	string	開發人員所屬的公司名稱
小組	team	string	開發人員所屬的小組名稱
tags	tags	array of string	與此開發人員相關聯的標籤
角色	roles	string	此開發人員的角色

開發人員進度

這包含每個開發人員在每種語言、領域、級別和任務上的進度

名稱	路徑	類型	Description
開發人員	developers	array of DeveloperProgressEntry	嘗試培訓的開發人員列表
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

開發人員進度項目

此項目代表開發人員訓練進度中的物件，其中包含開發人員及其在訓練模式下嘗試的進度的資訊

名稱	路徑	類型	Description
開發人員	developer	Developer	個別開發人員的相關資訊
語言	languages	array of TrainingProgressEntry	開發人員在訓練模式下嘗試的語言清單

訓練進度進入

包含語言和領域列表完成進度的條目

名稱	路徑	類型	Description
名稱	name	string	語言架構名稱
language_progress	language_progress	integer	完成語言的百分比
領域	realms	array of object	每種語言的領域列表
名稱	realms.name	string	領域名稱
realm_progress	realms.realm_progress	integer	已完成的領域百分比
級別	realms.levels	array of object	每個領域的級別列表
名稱	realms.levels.name	string	層級名稱
level_progress	realms.levels.level_progress	integer	已完成的關卡百分比
任務	realms.levels.quests	array of object	每個關卡的任務列表
名稱	realms.levels.quests.name	string	任務名稱
quest_progress	realms.levels.quests.quest_progress	integer	任務完成百分比

開發人員活動

給定時段內挑戰的詳細日誌

名稱	路徑	類型	Description
activities	activities	array of ActivityEntry	包含包含挑戰嘗試的語言列表的開發人員列表
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

活動項目

此物件代表開發人員及其挑戰嘗試

名稱	路徑	類型	Description
開發人員	developer	Developer	個別開發人員的相關資訊
挑戰嘗試	challenge	ChallengeAttempt	deverloper 在訓練模式下的嘗試

挑戰嘗試

deverloper 在訓練模式下的嘗試

名稱	路徑	類型	Description
語言	language	string	語言架構名稱
領域	realm	string	領域名稱
水平儀	level	string	層級名稱
找	quest	string	任務名稱
分類	category	string	挑戰的類別名稱
子類別	subcategory	string	挑戰的子類別名稱
䂚	difficulty	string	挑戰的難度等級
開始	started	date-time	時間挑戰開始了
已完成	completed	date-time	時間挑戰完成
duration	duration	integer	完成挑戰所需的時間（以秒為單位）
狀態	status	string	挑戰狀態，挑戰狀態不正確，有 1 個或多個不正確的階段
hints_used	hints_used	integer	開發人員使用的挑戰階段提示總數
分數	score	integer	獲得的積分
max_score	max_score	string	挑戰可獲得的最高積分
選取弱點	select_vulnerability	SelectVulnerability	挑戰挑戰的性質
定位漏洞	locate_vulnerability	LocateVulnerability	挑戰挑戰的性質
確定解決方案	identify_solution	IdentifySolution	挑戰挑戰的性質

選取弱點

挑戰挑戰的性質

名稱	路徑	類型	Description
attempt_index	attempt_index	integer	開發人員嘗試該階段的次數
狀態	status	string	挑戰的結果，out_of_reach狀態描述了開發人員尚未嘗試的階段
max_score	max_score	integer	選擇漏洞可獲得的最大分數
分數	score	integer	選擇漏洞所獲得的積分
略過	skipped	boolean	當設定為 true 時，已略過階段。如果狀態為false，則階段已完成或尚未嘗試

定位漏洞

挑戰挑戰的性質

名稱	路徑	類型	Description
attempt_index	attempt_index	integer	開發人員嘗試該階段的次數
狀態	status	string	挑戰的結果
max_score	max_score	integer	定位漏洞可達到的最高點數
分數	score	integer	尋找弱點所取得的點數

識別解決方案

挑戰挑戰的性質

名稱	路徑	類型	Description
attempt_index	attempt_index	integer	開發人員嘗試該階段的次數
狀態	status	string	挑戰的結果
max_score	max_score	integer	識別解決方案可達到的最高分數
分數	score	integer	識別解決方案所獲得的積分

資源項目

資源項目詳細資料

名稱	路徑	類型	Description
識別碼	id	string
名稱	name	string

Resource

資源詳細資料

名稱	路徑	類型
識別碼	id	string
名稱	name	string
items	items	array of ResourceItem

已完成資源

已完成學習資源的詳細資料

名稱	路徑	類型	Description
資源	resource	array of string	已完成資源的分類和名稱的排序清單
time_completed	time_completed	date-time	學習資源完成的時間

資源記錄

開發人員已完成學習資源的記錄

名稱	路徑	類型	Description
開發人員	profile	Developer	個別開發人員的相關資訊
已完成	completed	array of CompletedResource	使用者完成的所有學習資源

課程網址

訓練課程的網址

名稱	路徑	類型	Description
url	url	string	課程的網址

團隊數據

名稱	路徑	類型	Description
名稱	name	string	團隊名稱

使用者資料

名稱	路徑	類型	Description
識別碼	id	string	使用者的資源識別碼
電子郵件	email	string	使用者的電子郵件
角色	role	string	指派給使用者的角色，是開發人員、團隊經理或公司管理員之一
先	name.first		名字
中	name.middle		中間名
last	name.last		姓氏
狀態	status	string	使用者狀態
邀請日期	invite-date	date-time	使用者上次受邀的時間
最後登入日期	last-login-date	date-time	使用者上次登入的時間
球隊數據	team	TeamData
tags	tags	array of string	有關使用者的任何識別資訊。範例：總部、Asia-Pacific
preferredDev語言	preferredDevLanguages	array of preferredDevLanguage	開發語言偏好設定

用戶更新

名稱	路徑	類型	Description
StatusCode	statusCode	integer	成功回應訊息狀態碼
訊息	message	string	成功回應訊息描述
字碼	code	string	安全代碼戰士代碼

使用者建立

名稱	路徑	類型	Description
識別碼	id	string	Secure Code Warrior 資源識別碼
StatusCode	statusCode	integer	成功回應訊息狀態碼
訊息	message	string	成功回應訊息描述
字碼	code	string	安全代碼戰士代碼

使用者刪除

名稱	路徑	類型	Description
StatusCode	statusCode	integer	成功回應訊息狀態碼
訊息	message	string	成功回應訊息描述
字碼	code	string	安全代碼戰士代碼

使用者清單

使用者資料清單

名稱	路徑	類型	Description
users	users	array of UserData

最佳表現者

表現最好的人名單

名稱	路徑	類型	Description
report_period_in_days	report_period_in_days	integer	過去要報告的天數
top_performers	top_performers	array of TopPerformer
total_pages	links.total_pages	integer	結果中的總頁數
results_per_page	links.results_per_page	integer	每個頁面的結果數目上限
next_page	links.next_page	integer	下一頁的頁碼（如果存在）
prev_page	links.prev_page	integer	上一頁的頁碼（如果存在）
total_results	links.total_results	integer	結果總數

頂級表現者

表現最佳的用戶

名稱	路徑	類型	Description
積分	points	integer	一段時間內獲得的總積分
識別碼	id	string	UUID 格式的使用者 ID
電子郵件	email	string	使用者電子郵件
先	name.first	string	使用者名字
中	name.middle	string	使用者中間名
last	name.last	string	使用者姓氏
tags	tags	array of string	使用者標籤
狀態	status	string	使用者狀態
球隊數據	team	TeamData

使用者花費時間

顯示使用者活動的項目。

名稱	路徑	類型	Description
識別碼	id	string	UUID 格式的使用者 ID
電子郵件	email	string	使用者電子郵件
先	name.first	string	使用者名字
中	name.middle	string	使用者中間名
last	name.last	string	使用者姓氏
tags	tags	array of string	使用者標籤
狀態	status	string	使用者狀態
球隊數據	team	TeamData
花費的時間	time-spent	array of object	日期陣列，其中包含一天內花費的時間/活動明細
date	time-spent.date	date	UTC 日期
評定	time-spent.activity.Assessments	integer	評估所花費的時間
學習	time-spent.activity.Learning	integer	花在學習上的時間
錦標賽	time-spent.activity.Tournaments	integer	花在錦標賽上的時間
Training	time-spent.activity.Training	integer	訓練時間

優勢和劣勢

平均優勢和劣勢對象

名稱	路徑	類型	Description
auth	auth	AverageStrengthsAndWeaknessesEntry	此物件代表每個個別的管理類別
data_handling	data_handling	AverageStrengthsAndWeaknessesEntry	此物件代表每個個別的管理類別
設定錯誤	misconfig	AverageStrengthsAndWeaknessesEntry	此物件代表每個個別的管理類別
實踐	practices	AverageStrengthsAndWeaknessesEntry	此物件代表每個個別的管理類別
sensitive_data	sensitive_data	AverageStrengthsAndWeaknessesEntry	此物件代表每個個別的管理類別
other	other	AverageStrengthsAndWeaknessesEntry	此物件代表每個個別的管理類別

平均優勢和劣勢入口

此物件代表每個個別的管理類別

名稱	路徑	類型	Description
挑戰	challenges	ChallengesEntry	挑戰數據
提示	hints	HintsEntry	提示數據
積分	points	integer	Points
時間花費	timeSpent	integer	花費的時間

挑戰參賽

挑戰數據

名稱	路徑	類型	Description
嘗試	attempted	integer	嘗試的挑戰
對	correct	integer	嘗試的正確
䡁	incorrect	integer	嘗試不正確
百分比正確	percentageCorrect	integer	正確百分比
比率正確	ratioCorrect	number	比例正確

提示條目

提示數據

名稱	路徑	類型	Description
confidenceLevel	confidenceLevel	integer	置信水平
總計	total	integer	總數
用過的	used	integer	使用過的

團隊詳情

名稱	路徑	類型	Description
識別碼	id	string	團隊 ID
名稱	name	string	團隊名稱
tags	tags	array of string	有關團隊的任何識別信息。範例：總部、亞太地區、工程
onboarding訊息	onboardingMessage	string	團隊的上線訊息
狀態	status	string	團隊狀態
memberJoinToken	memberJoinToken	string	會員加入令牌
companyName	companyName	string	公司名稱
語言	languages	array of string	團隊語言

TeamDelete回應

團隊刪除回應

名稱	路徑	類型	Description
刪除狀態	deleteStatus	string	刪除作業的狀態

Course

名稱	路徑	類型	Description
_id	_id	string	課程標識碼
名稱	name	string	課程名稱
描述	description	string	課程說明
狀態	status	string	課程狀態
supported_languages	supported_languages	array of string	課程可用的語言/框架列表
截止日期	deadline	date-time	課程結束日期
創建者	created_by	string	課程作者的 ResourceId

課程開發人員進度條目

此條目代表開發人員課程進度

名稱	路徑	類型	Description
user_id	user_id	string	使用者資源識別碼
狀態	status	string	課程狀態
正確性	accuracy	integer	正確嘗試的百分比
信賴度	confidence	integer	已使用的點擊與可用提示的比率
minutes_spent	minutes_spent	integer	使用者在課程上花費的總時間（以分鐘為單位）
first_completed_date	first_completed_date	date-time	完成第一門課程語言的日期
first_enrolled_date	first_enrolled_date	date-time	註冊第一門課程語言的日期
進展	progress	integer	課程進度
語言	languages	array of CourseDeveloperProgressLanguageEntry	課程語言列表
邀請	invites	array of CourseDeveloperProgressInviteEntry	邀請和提醒清單

課程開發人員進度邀請進入

此條目代表開發人員課程進度邀請和提醒。

開發人員課程進度條目，用於邀請和提醒。

課程開發人員進度語言條目

此項目代表單一語言的開發人員課程進度

名稱	路徑	類型	Description
語言	language	string	程式語言
狀態	status	string	課程語言的狀態
正確性	accuracy	integer	語言的正確嘗試百分比
信賴度	confidence	integer	使用的點擊次數與語言可用提示的比率
minutes_spent	minutes_spent	integer	使用者在語言課程上花費的總時間（以分鐘為單位）
進展	progress	integer	語言課程的進度
videos_watched	videos_watched	integer	用戶觀看該語言的視頻數量

共用方式為

Secure Code Warrior （獨立發行者） （預覽版）

正在建立連線

預設

節流限制

動作

刪除使用者

參數

傳回

刪除團隊

參數

傳回

取得使用者

參數

傳回

取得團隊

參數

傳回

取得團隊詳細資料

參數

傳回

取得所有課程

參數

傳回

取得活動表現最佳者

參數

傳回

取得評估嘗試

參數

傳回

取得評量

參數

傳回

取得課程網址

參數

傳回

取得資源

傳回

取得開發人員活動

參數

傳回

取得開發人員進度

參數

傳回

取得開發者排行榜

參數

傳回

建立使用者

參數

傳回

建立團隊

參數

傳回

指派評量

參數

傳回

搜尋使用者

參數

傳回

搜尋學習進度

參數

傳回

搜尋評估嘗試

參數

傳回

搜尋課程開發人員進度

參數

傳回

搜尋錦標賽排行榜

參數

傳回

搜尋開發人員排行榜

參數

傳回

搜尋開發人員活動

參數

傳回

搜尋開發人員進度

參數

傳回

Secure Code Warrior （獨立發行者）（預覽版）