New to imgix ? 🎉  See how we'd do on your website →
imgix APIsマネージメント APIレポート

レポート

注意: レポートはプレミアム機能であり、すべてのアカウントで有効になっているわけではありません。サポートにお問い合わせ するか、アカウントマネージャーにお問い合わせください。

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

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

レポート操作

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

エンドポイントメソッド説明
reportsGET利用可能なすべてのレポートのリストを取得します
reports/:report_idGETid で単一のレポートを取得します

レポートフィルタ

フィルタタイプメモ
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 データが送信されていなかったことを示します。
image_analyticsその日アクセスされた各オリジン画像のメトリクスを含みます。各オリジン画像 URL によって生成されたリクエスト数とエラー数が含まれます。 Example file
mild_errors画像ごとの 4xx レベルのエラーに関連するデータを含みます。 Example file
source_analytics各ソースの累積メトリクスを含みます。合計オリジン画像数、合計帯域幅、平均応答時間などの情報が含まれます。 Example file

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

レポートの例

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

GET /api/v1/reports
{
  "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つのレポートを取得する

GET /api/v1/reports/5f7676862528f12b1bfbf65b
{
  "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 レポートを取得し、最新のものからソートする

GET /api/v1/reports?sort=-period_end&fields[reports]=report_key,files&filter[report_type]=mild_errors
{
  "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": {
    ...
  }
}
パージソース