Skip to main content
GET
コードスキャンのメトリクスを取得

権限

組織レベルの ViewCodeScans 権限を持つサービスユーザーまたはパーソナルアクセストークンが必要です。

時間フィルター

このエンドポイントでは、time_after および time_before クエリパラメータが必要です。
  • time_aftertime_before はどちらも、UTC として解釈される秒単位の Unix タイムスタンプです。
  • time_aftertime_before より前の時刻である必要があります。
  • time_aftertime_before の間の期間は100 日以下である必要があります。
  • メトリクスの対象は、この期間内に作成されたコードスキャンです。
Enterprise 内のすべての組織のメトリクスを取得するには、Get Code Scan Metrics (Enterprise) を利用してください。

承認

Authorization
string
header
必須

サービスユーザーの認証情報(接頭辞: cog_)

パスパラメータ

org_id
string
必須

組織ID(プレフィックス: org-)

:

"org-abc123def456"

クエリパラメータ

time_before
integer
必須
time_after
integer
必須

レスポンス

成功レスポンス

コードスキャンのメトリクスのレスポンスモデル。

すべてのメトリクスは、指定した期間内に作成されたコードスキャンを対象としています。検出結果と修復用PRは、それらを生成したスキャンに紐付けられます。

avg_pr_open_duration_seconds
number | null
必須

PRがオープン状態にある(またはあった)平均時間(秒)。完了したPRでは作成からマージまたはクローズまで、オープン中のPRでは作成から現在までを指します。PRが1件も作成されていない場合は Null。

avg_pr_time_to_merge_seconds
number | null
必須

PRの作成からマージまでの平均時間(秒)。マージ済みのPRが1件もない場合は Null。

open_critical_findings_count
integer
必須

重大度がcriticalの未解決の検出結果数。

open_high_findings_count
integer
必須

重大度がhighの未解決の検出結果数。

open_low_findings_count
integer
必須

重大度がlowの未解決の検出結果数。

open_medium_findings_count
integer
必須

重大度がmediumの未解決の検出結果数。

prs_closed_count
integer
必須

マージされずにクローズされた修復用PRの数。

prs_created_count
integer
必須

スキャンの修復セッションによって作成されたPRの数。

prs_merged_count
integer
必須

マージされた修復用PRの数。

prs_open_count
integer
必須

現在オープン状態の修復用PRの数。

repos_scanned_count
integer
必須

スキャン対象となった一意のリポジトリ数。

scans_count
integer
必須

指定した期間内に作成されたコードスキャンの数。