分析 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)。它通过
LEFT JOIN 关联 three_d_models 表,条件为
status = 'READY'。
POST /api/analytics/track
记录一次新的页面浏览。供菜单查看器客户端使用。
身份验证:公开(无需令牌)
请求体
{
"restaurantId": "uuid",
"menuItemId": "uuid"
}
响应(201 Created)
{
"success": true,
"data": {
"id": "uuid"
}
}
重要:响应将数据包装在
data.data 中 — 请从解析后的 JSON 中使用
response.data?.id,而不是 response.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 请求。