Saltar al contenido principal

Referencia de la API

API de analíticas

API de analíticas

La API de analíticas proporciona datos de rendimiento del menú para los dueños de restaurantes y un endpoint de seguimiento para registrar las interacciones de los clientes.

GET /api/analytics

Obtiene los datos de analíticas de su restaurante.

Autenticación: Obligatoria (token Bearer). También verifica que usted sea el dueño del restaurante.

Respuesta (200 OK)

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

Nota: El campo modelCoverage indica el porcentaje de artículos del menú que tienen un modelo 3D en estado READY (solo 3D Menu Pro). Usa un LEFT JOIN con la tabla three_d_models donde status = 'READY'.

POST /api/analytics/track

Registra una nueva vista de página. Lo usa el cliente visor del menú.

Autenticación: Pública (no se requiere token)

Cuerpo de la solicitud

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

Respuesta (201 Created)

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

Importante: La respuesta envuelve los datos en data.data: use response.data?.id del JSON analizado, no response.id.

PATCH /api/analytics/track

Actualiza un registro de vista existente con datos de duración e interacción.

Autenticación: Pública (no se requiere token)

Cuerpo de la solicitud

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

Respuesta (200 OK)

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

Nota: Use siempre fetch con keepalive: true para las llamadas de seguimiento de analíticas. No use navigator.sendBeacon, que solo admite POST con el tipo de contenido text/plain.