ショップの分析データを取得できる「カラーミーショップ アナリティクス API」を公開しました
2026/06/17
ショップの分析データを取得できる「カラーミーショップ アナリティクス API」を公開しました。ショップ全体や商品ごとの閲覧数 (PV)・訪問者数 (UU)・売上を、日次・月次や、参照元別・時間帯別といった切り口で取得できます。
集計済みのデータをそのまま取得できるため、ショップオーナー向けの分析画面・レポートの構築や、自社サービスとの連携などにご活用いただけます。
利用前提
- 認可・トークン交換などのフローはカラーミーショップ API と同一です。認可時のスコープに
read_analyticsを含めてください - 対象ショップがアプリストアからカラーミーアナリティクスをインストールしている必要があります
公開したエンドポイント
ショップ
| メソッド | パス | 概要 | ドキュメント |
|---|---|---|---|
| GET | /analytics/v1/shop |
ショップの閲覧数・訪問者数・売上を、指定期間 (日付範囲) の日次で取得 | 指定期間の日次集計を取得 |
| GET | /analytics/v1/shop/monthly |
ショップの閲覧数・訪問者数・売上を、指定月の日次で取得 | 指定月の日次集計を取得 |
| GET | /analytics/v1/referrers |
ショップへの参照元 URL とアクセス数を、指定日1日分で取得 | 指定日の参照元別集計を取得 |
| GET | /analytics/v1/referrers/monthly |
ショップへの参照元 URL とアクセス数を、指定月1ヶ月分で取得 | 指定月の参照元別集計を取得 |
| GET | /analytics/v1/access_by_hour |
ショップの閲覧数・訪問者数を、指定日の0-23時の時間帯別で取得 | 指定日の時間別集計を取得 |
| GET | /analytics/v1/access_by_hour/monthly |
ショップの閲覧数・訪問者数を、指定月の0-23時の時間帯別で取得 | 指定月の時間別集計を取得 |
商品
| メソッド | パス | 概要 | ドキュメント |
|---|---|---|---|
| GET | /analytics/v1/products |
商品ごとの閲覧数・訪問者数・売上を、指定日1日分で取得 | 指定日の商品ごとの集計を取得 |
| GET | /analytics/v1/products/monthly |
商品ごとの閲覧数・訪問者数・売上を、指定月1ヶ月分で取得 | 指定月の商品ごとの集計を取得 |
| GET | /analytics/v1/products/{product_id}/time_series |
指定商品の閲覧数・訪問者数・売上を、指定期間 (日付範囲) の日次で取得 | 指定期間の日次集計を取得 |
| GET | /analytics/v1/products/{product_id}/time_series/monthly |
指定商品の閲覧数・訪問者数・売上を、指定月の日次で取得 | 指定月の日次集計を取得 |
| GET | /analytics/v1/products/{product_id}/referrers |
指定商品ページへの参照元 URL とアクセス数を、指定日1日分で取得 | 指定日の参照元別集計を取得 |
| GET | /analytics/v1/products/{product_id}/referrers/monthly |
指定商品ページへの参照元 URL とアクセス数を、指定月1ヶ月分で取得 | 指定月の参照元別集計を取得 |
メタ情報
| メソッド | パス | 概要 | ドキュメント |
|---|---|---|---|
| GET | /analytics/v1/last_aggregated_date |
最新の集計日を取得 | 最新の集計日を取得 |
エンドポイントの種類と期間の指定方法
各指標は時系列型・スナップショット型×日次・月次の組み合わせでエンドポイントが分かれています。月次のエンドポイントはパスの末尾が /monthly です。
- 時系列型 (
/shop,/products/{product_id}/time_seriesとそれぞれの/monthly): 期間内の各日を1件とする日次バケットの並びを返します (データが無い日も0埋め) - スナップショット型 (
/products,/referrers,/products/{product_id}/referrers,/access_by_hourとそれぞれの/monthly): 指定日・指定月の集計値を返します
注意事項
- アクセス可能な期間は、最新集計日 (
GET /analytics/v1/last_aggregated_dateで取得できる日付) から18ヶ月以内です - 日付・時間帯はすべて日本時間 (JST, Asia/Tokyo) 基準です
- エラーはカラーミーショップ API と同じ
errors配列形式 (code・message・status) で返します
詳細は以下のドキュメントを確認ください。