Smarter video starts here! Explore tools for previews, smart cropping, and image-to-video creation. Explore the Q4 launch →
Imgix APIsマネージメント APIレポート

レポート

注意: Image Analyticsレポートはすべての有料顧客にご利用いただけますが、その他のレポートはプレミアム機能であり、すべてのアカウントで有効になっているわけではありません。詳細についてはサポートにお問い合わせいただくか、アカウントマネージャーにご相談ください。

レポートは毎日更新され、最終的には 90 日間保持されます。レポートは 00:00 UTC に確定され、04:00 UTC までに API 経由で利用可能です。

ダッシュボードでレポートページにアクセスすることにより、ダウンロードすることもできます。

レポート操作

レポート操作には Analytics 権限が必要です。

エンドポイントメソッド必要なパーミッション説明
reportsGETアナリティクス利用可能なすべてのレポートの一覧を取得します。
reports/:report_idGETアナリティクスid によって単一のレポートを取得します。

レポートフィルタ

フィルタタイプメモ
completedBooleanレポートが完全に完了しているかどうか。
report_typeStringレポートタイプ。サポートされているレポートタイプを参照してください。

レポートソート

  • period_end
  • period_start
  • report_key
  • report_type

レポート属性

フィールドタイプ説明
completedBooleanレポートが完了したかどうか。
filesListダウンロード可能なレポートの URL のリスト。ファイルサイズは最大で 64MB です。そのため、レポートがそれを超える場合は複数のファイルに分割される場合があります。
period_endIntegerレポートでカバーされる期間の終わりを表す Unix タイムスタンプ。
period_startIntegerレポートでカバーされる期間の開始を表す Unix タイムスタンプ。
report_keyString各レポートの人間が読みやすい ID、例: source_analytics_20201130。
report_typeStringレポートタイプ。サポートされているレポートタイプを参照してください。

レポートタイプ

タイプ説明
cdn_logs画像に対する CDN へのリクエストの日次ログを含みます。参照元、ユーザーエージェント、画像ごとのキャッシュヒット/ミスなどの情報が含まれます。 Example file.

referers と user_agent の列では、空白の値は Imgix に referer または user-agent データが送信されていなかったことを示します。
credit_analytics_dailyソースごとの 1 日分のクレジット消費量を含みます。1 ソースにつき 1 行で、そのソースがレポート日当日に消費したクレジットのみを対象とします。列の詳細については クレジット分析レポート を参照してください。source_analytics レポートが有効になっているすべてのアカウントに対して自動的に生成されます。
credit_analytics_mtdソースごとの月初来 (month-to-date) クレジット消費量を含みます。1 ソースにつき 1 行で、そのソースが月の 1 日からレポート日までに累積で消費したクレジットを対象とします。各暦月の開始時にゼロにリセットされます。列の詳細については クレジット分析レポート を参照してください。source_analytics レポートが有効になっているすべてのアカウントに対して自動的に生成されます。
image_analytics今月中にアクセスされた各オリジン画像に関する累積メトリクスを含みます。各オリジン画像URLごとのリクエスト数、帯域幅、およびエラー数の合計が含まれます。サンプルファイル
mild_errors画像ごとの 4xx レベルのエラーに関連するデータを含みます。 Example file
source_analytics各ソースの累積メトリクスを含みます。合計オリジン画像数、合計帯域幅、平均応答時間などの情報が含まれます。 Example file

このレポートは累積なので、7 月 31 日に生成されたレポートはその月全体のソース分析を持ちます。7 月 15 日に生成されたレポートは、その日までの 7 月のソース分析を持ちます。

クレジット分析レポート

credit_analytics_mtd および credit_analytics_daily レポートは、アカウントのクレジット消費量をソースごとに分解したものです。source_analytics レポートが有効になっているすべてのアカウントに対して自動的に生成され、別途のセットアップは必要ありません。

両レポートの列とレイアウトは同一であり、対象とする期間のみが異なります。

  • credit_analytics_mtd — 月初来のクレジット合計。月の 1 日からレポート日までの累積値です。22 日の値は、その月の 1 日以降の使用量を反映するものであり、ローリング 30 日間や累計の数値ではありません。各暦月の開始時にゼロにリセットされます。
  • credit_analytics_daily — レポート日当日に消費されたクレジットのみ。

各レポートは、ヘッダー行を含む gzip 圧縮された CSV として配信されます (アカウントごとに 1 日 1 ファイル。大規模アカウントの場合は複数ファイルに分割される場合があります)。1 ソースにつき 1 行です。レポートは毎日生成され、前日の確定済みクレジット数値を反映します。

列

列説明
timestampレポート日。
source_idimgix ソース ID。
source_nameソース名。ソースがその後削除または名前変更された場合は空白になることがあります。
total_credits消費されたクレジットの合計。これは権威ある数値であり、個別に列挙されていないものを含むすべてのクレジットカテゴリの合計です。そのため、新しいクレジットタイプが個別に分解されていない場合、列挙された列の合計より大きくなることがあります。
standard_renders_credits標準画像レンダリングクレジット。
advanced_renders_credits高度な画像レンダリングクレジット。
premium_renders_creditsプレミアム画像レンダリングクレジット。
storage_creditsストレージクレジット。
delivery_bandwidth_credits配信帯域幅クレジット。
cache_reads_creditsキャッシュ読み取りクレジット。
premium_video_encoding_seconds_creditsプレミアム動画エンコードクレジット。
video_smartcropping_seconds_credits動画スマートクロッピングクレジット。
video_preview_seconds_credits動画プレビュークレジット。
video_ai_interpolation_seconds_creditsAI 動画補間クレジット。
video_vmaf_encoded_seconds_creditsVMAF 動画エンコードクレジット。
video_render_cache_credits動画レンダリングキャッシュクレジット。
specialized_transformations_credits特殊変換クレジット。

すべてのクレジット値は数値であり、timestamp は日付として表現されます。

注意: 一部の新しい動画クレジットタイプ（AI 補間、VMAF エンコード、動画レンダリングキャッシュ）は、それらの機能がまだクレジット課金の対象でないため、現在は 0 を返します。これらの列はすでに存在しており、対象のクレジットタイプが提供開始されると自動的に値が入力されます。

レポートの例

レポートのリストを取得する

# Request
GET /api/v1/reports
# Response
{
  "data": [
    {
      "attributes": {
        "completed": true,
        "files": [
          ...
        ],
        "period_end": 1601769600,
        "period_start": 1601769600,
        "report_key": "image_analytics_20201004",
        "report_type": "image_analytics"
      },
      "id": "5f7a6ab42528f162276c5584",
      "relationships": {
        ...
      },
      "type": "reports"
    },
    {
      "attributes": {
        "completed": true,
        "files": [
          ...
        ],
        "period_end": 1601769600,
        "period_start": 1601769600,
        "report_key": "source_analytics_20201004",
        "report_type": "source_analytics"
      },
      "id": "5f7a6b9a2528f16239772ab8",
      "relationships": {
        ...
      },
      "type": "reports"
    },
    ...
  ],
  "included": [],
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "authentication": {
      ...
    },
    "pagination": {
      "currentPage": 0,
      "hasNextPage": false,
      "hasPreviousPage": false,
      "nextPage": 0,
      "pageSize": 20,
      "previousPage": 0,
      "totalPages": 1,
      "totalRecords": 16
    },
    "server": {
      ...
    }
  }
}

report_id で1つのレポートを取得する

# Request
GET /api/v1/reports/5f7676862528f12b1bfbf65b
# Response
{
  "data": {
    "attributes": {
      "completed": true,
      "files": [
          "https://storage.googleapis.com/imgix-reports/..."
      ],
      "period_end": 1601510400,
      "period_start": 1601510400,
      "report_key": "image_analytics_20201001",
      "report_type": "image_analytics"
    },
    "id": "5f7676862528f12b1bfbf65b",
    "relationships": {
      "account": {
        "data": {
          "id": "5ae39a60781cee0001020d8f",
          "type": "accounts"
        }
      }
    },
    "type": "reports"
  },
  "included": [],
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    ...
  }
}

mild_errors レポートを取得し、最新のものからソートする

# Request
GET /api/v1/reports?sort=-period_end&fields[reports]=report_key,files&filter[report_type]=mild_errors
# Response
{
  "data": [
    {
      "attributes": {
        "files": [
          "https://storage.googleapis.com/imgix-reports/..."
        ],
        "report_key": "mild_errors_20201006"
      },
      "id": "5f7d0f842528f160f103836d",
      "relationships": {},
      "type": "reports"
    },
    {
      "attributes": {
        "files": [
          "https://storage.googleapis.com/imgix-reports/..."
        ],
        "report_key": "mild_errors_20201005"
      },
      "id": "5f7bbec22528f12bbde9db3d",
      "relationships": {},
      "type": "reports"
    },
    {
      "attributes": {
        "files": [
          "https://storage.googleapis.com/imgix-reports/..."
        ],
        "report_key": "mild_errors_20201004"
      },
      "id": "5f7a6bc82528f1623a2fdaf6",
      "relationships": {},
      "type": "reports"
    },
    ...
  ],
  "included": [],
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    ...
  }
}
パージソース