Metrics

Métriques Cardápio Web via l'API

Votre client connecte son compte Cardápio Web et votre produit interroge 9 métriques par le même endpoint que les autres plateformes. Chaque métrique a un identifiant (reference_key) qui figure dans l'appel.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "comparison_start": "2026-09-01",
  "comparison_end": "2026-09-30",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "cardapio_web:total_orders",
      "component": "number_v1",
      "metrics": [
        "total_orders"
      ],
      "dimensions": [
        "sales"
      ]
    }
  ]
}
Exemple : « Total des Commandes » en octobre, comparé à septembre.

Plus d'exemples d'appels Cardápio Web

Le même endpoint pour chaque type de métrique. Les champs metrics et dimensions de chaque élément viennent du catalogue de la plateforme (GET /api/metrics/{integration_slug}).

Graphique

Commandes par Jour

Évolution quotidienne des commandes terminées.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "cardapio_web:orders_over_time",
      "component": "chart_v1",
      "metrics": [
        "total_orders"
      ],
      "dimensions": [
        "date"
      ]
    }
  ]
}

Tableau

Détails par Canal

Quantité de commandes et revenu regroupés par canal de vente.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "cardapio_web:channel_breakdown",
      "component": "datatable_v1",
      "metrics": [
        "total_orders",
        "total_revenue"
      ],
      "dimensions": [
        "sales_channel"
      ]
    }
  ]
}

Chiffre

Recette totale

Somme de la valeur totale des commandes complétées pendant la période.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "cardapio_web:total_revenue",
      "component": "number_v1",
      "metrics": [
        "total_revenue"
      ],
      "dimensions": [
        "sales"
      ]
    }
  ]
}

Chiffres

3 métriques

  • Total des Commandes

    Nombre de commandes terminées dans la période (exclut les annulées).

    cardapio_web:total_orders
  • Recette totale

    Somme de la valeur totale des commandes complétées pendant la période.

    cardapio_web:total_revenue
  • Ticket Moyen

    Recette totale divisée par le nombre de commandes terminées.

    cardapio_web:average_ticket

Graphiques

4 métriques

  • Commandes par Jour

    Évolution quotidienne des commandes terminées.

    cardapio_web:orders_over_time
  • Recette par Jour

    Évolution quotidienne de la recette totale.

    cardapio_web:revenue_over_time
  • Commandes par Canal

    Distribution des commandes complétées par canal de vente.

    cardapio_web:orders_by_channel
  • Chiffre d'affaires par Canal

    Revenu total regroupé par canal de vente.

    cardapio_web:revenue_by_channel

Tableaux

2 métriques

  • Détails par Canal

    Quantité de commandes et revenu regroupés par canal de vente.

    cardapio_web:channel_breakdown
  • Produits les Plus Vendus

    Produits les plus vendus classés par quantité vendue.

    cardapio_web:top_products

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.