正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

プロジェクト統計API

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、プロジェクトに関する統計を取得することができます。すべてのエンドポイントで認証が必要です。

リポジトリへの読み取りアクセス権が必要です。パーソナルアクセストークンにはread_apiスコープが必要です。グループアクセストークンはレポーターロールとread_apiスコープを使用できます。

このAPIは、プロジェクトがHTTPメソッドでクローンまたはプルされた回数を取得します。SSHによるフェッチは含まれません。

過去30日間の統計を取得する

指定されたプロジェクトの過去30日間のクローンとプルの統計を取得することができます。

GET /projects/:id/statistics

サポートされている属性は以下のとおりです:

属性必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス

成功した場合、200 OKと次のレスポンス属性を返します:

属性説明
fetchesオブジェクトプロジェクトのフェッチ統計。
fetches.days配列日ごとのフェッチ統計の配列。
fetches.days[].count整数特定の日付のフェッチ数。
fetches.days[].date文字列ISO形式の日付 (YYYY-MM-DD)。
fetches.total整数過去30日間の合計フェッチ数。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/42/statistics"

レスポンス例:

{
  "fetches": {
    "total": 50,
    "days": [
      {
        "count": 10,
        "date": "2018-01-10"
      },
      {
        "count": 10,
        "date": "2018-01-09"
      },
      {
        "count": 10,
        "date": "2018-01-08"
      },
      {
        "count": 10,
        "date": "2018-01-07"
      },
      {
        "count": 10,
        "date": "2018-01-06"
      }
    ]
  }
}