エンドポイント一覧
| メソッド | パス | 説明 | レスポンス |
|---|---|---|---|
| GET |
/api/v1/sales/kpis
|
主要指標を取得
売上・客数・客単価を期間で取得します。
|
200 |
| GET |
/api/v1/sales/trend
|
売上推移を取得
日次・週次・月次の推移を取得します。
|
200 |
| GET |
/api/v1/sales/forecast
|
売上を予測
直近の実績から今後の売上を予測します。
|
200 |
| GET |
/api/v1/sales/churn
|
離反リスクを取得
しばらく来店のない顧客を、離反しやすい順に返します。
|
200 |
| GET |
/api/v1/sales/recommendations
|
推奨商品を取得
顧客ごとの購買傾向から次に薦める商品を返します。
|
200 |
| GET |
/api/v1/sales/advice
|
改善アドバイスを取得
数字の変化を文章にして返します。
|
200 |
| GET |
/api/v1/sales/products
|
商品別売上を取得
売れ筋と死に筋を返します。
|
200 |
| GET |
/api/v1/sales/visitors
|
来店分析を取得
曜日・時間帯別の来店傾向を返します。
|
200 |
エンドポイント詳細
売上・客数・客単価を期間で取得します。
完全パス：
GET /api/v1/sales/kpis
レスポンスコード：
200
日次・週次・月次の推移を取得します。
完全パス：
GET /api/v1/sales/trend
レスポンスコード：
200
直近の実績から今後の売上を予測します。
完全パス：
GET /api/v1/sales/forecast
レスポンスコード：
200
しばらく来店のない顧客を、離反しやすい順に返します。
完全パス：
GET /api/v1/sales/churn
レスポンスコード：
200
顧客ごとの購買傾向から次に薦める商品を返します。
完全パス：
GET /api/v1/sales/recommendations
レスポンスコード：
200
数字の変化を文章にして返します。
完全パス：
GET /api/v1/sales/advice
レスポンスコード：
200
売れ筋と死に筋を返します。
完全パス：
GET /api/v1/sales/products
レスポンスコード：
200
曜日・時間帯別の来店傾向を返します。
完全パス：
GET /api/v1/sales/visitors
レスポンスコード：
200
リクエスト例
リクエスト
GET /api/v1/sales/forecast?storeId={storeId}
Authorization: Bearer {access_token}
レスポンス
{
"storeId": "21cc…",
"horizonDays": 30,
"points": [
{ "date": "2026-09-01", "predictedAmount": 128400 }
]
}
認証について
このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。トークンの取得方法は認証ガイドをご確認ください。