メインコンテンツへスキップ

API リファレンス

アナリティクス API

アナリティクス API

アナリティクス API は、レストランオーナー向けのメニューのパフォーマンスデータと、お客様の操作を記録するためのトラッキングエンドポイントを提供します。

GET /api/analytics

レストランのアナリティクスデータを取得します。

認証: 必須 (Bearer トークン)。レストランの所有権も検証します。

レスポンス (200 OK)

{
  "success": true,
  "data": {
    "totalViews": 1250,
    "uniqueVisitors": 890,
    "averageDuration": 45.2,
    "topItems": [
      {
        "id": "uuid",
        "name": "Margherita Pizza",
        "views": 340
      }
    ],
    "modelCoverage": 0.85
  }
}

注: modelCoverage フィールドは、READY 状態の 3D モデルを持つメニューアイテムの割合を示します (3D Menu Pro のみ)。status = 'READY' の条件で three_d_models テーブルへの LEFT JOIN を使用します。

POST /api/analytics/track

新しいページビューを記録します。メニュービューアのクライアントで使用されます。

認証: 公開 (トークン不要)

リクエストボディ

{
  "restaurantId": "uuid",
  "menuItemId": "uuid"
}

レスポンス (201 Created)

{
  "success": true,
  "data": {
    "id": "uuid"
  }
}

重要: レスポンスはデータを data.data でラップしています — response.id ではなく、パース済み JSON の response.data?.id を使用してください。

PATCH /api/analytics/track

既存の閲覧レコードを、滞在時間と操作データで更新します。

認証: 公開 (トークン不要)

リクエストボディ

{
  "viewId": "uuid",
  "duration": 45,
  "interactions": 3
}

レスポンス (200 OK)

{
  "success": true,
  "data": {
    "id": "uuid",
    "duration": 45,
    "interactions": 3
  }
}

注: アナリティクスのトラッキング呼び出しには、必ず keepalive: true を指定した fetch を使用してください。 navigator.sendBeacon は、text/plain コンテンツタイプの POST にしか対応していないため使用しないでください。