Aller au contenu principal

Référence de l'API

API des statistiques

API des statistiques

L'API des statistiques fournit des données de performance du menu aux restaurateurs, ainsi qu'un endpoint de suivi pour enregistrer les interactions des clients.

GET /api/analytics

Récupère les statistiques de votre restaurant.

Authentification : requise (jeton Bearer). Vérifie également la propriété du restaurant.

Réponse (200 OK)

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

Remarque : le champ modelCoverage indique le pourcentage d'articles de menu disposant d'un modèle 3D à l'état READY (3D Menu Pro uniquement). Il utilise un LEFT JOIN sur la table three_d_models avec status = 'READY'.

POST /api/analytics/track

Enregistre une nouvelle vue de page. Utilisé par le client de visualisation du menu.

Authentification : publique (aucun jeton requis)

Corps de la requête

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

Réponse (201 Created)

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

Important : la réponse encapsule les données dans data.data — utilisez response.data?.id à partir du JSON analysé, et non response.id.

PATCH /api/analytics/track

Met à jour un enregistrement de vue existant avec la durée et les données d'interaction.

Authentification : publique (aucun jeton requis)

Corps de la requête

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

Réponse (200 OK)

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

Remarque : utilisez toujours fetch avec keepalive: true pour les appels de suivi statistique. N'utilisez pas navigator.sendBeacon, qui ne prend en charge que POST avec le type de contenu text/plain.