メインコンテンツへスキップ
GET
コードスキャンのメトリクスを取得

権限

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

時間フィルター

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

承認

Authorization
string
header
必須

サービスユーザーの credential(プレフィックス: cog_)

パスパラメータ

org_id
string
必須

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

例:

"org-abc123def456"

クエリパラメータ

time_before
integer
必須
time_after
integer
必須

レスポンス

成功レスポンス

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

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

scans_count
integer
必須

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

repos_scanned_count
integer
必須

スキャンされた一意のリポジトリ数。

prs_created_count
integer
必須

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

prs_open_count
integer
必須

現在open状態にある修正用PR数。

prs_merged_count
integer
必須

マージ済みの修正用PR数。

prs_closed_count
integer
必須

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

avg_pr_time_to_merge_seconds
number | null
必須

PRの作成からマージまでの平均時間(秒)。マージされたPRがない場合はNull。

avg_pr_open_duration_seconds
number | null
必須

PRがopenである、またはopenだった平均時間(秒)。完了したPRは作成からマージまたはクローズまで、openなPRは作成から現在までを指します。PRが作成されていない場合はNull。

open_critical_findings_count
integer
必須

重大度がcriticalのopenな検出結果数。

open_high_findings_count
integer
必須

重大度がhighのopenな検出結果数。

open_medium_findings_count
integer
必須

重大度がmediumのopenな検出結果数。

open_low_findings_count
integer
必須

重大度がlowのopenな検出結果数。