Metrics

Métricas de Cardápio Web con la API

Tu cliente conecta su cuenta de Cardápio Web y tu producto consulta 9 métricas por el mismo endpoint que las demás plataformas. Cada métrica tiene un identificador (reference_key) que va en la llamada.

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"
      ]
    }
  ]
}
Ejemplo: "Total de Pedidos" en octubre, comparado con septiembre.

Más ejemplos de llamadas a Cardápio Web

El mismo endpoint para cada tipo de métrica. Los campos metrics y dimensions de cada ítem vienen del catálogo de la plataforma (GET /api/metrics/{integration_slug}).

Gráfico

Pedidos por Día

Evolución diaria de los pedidos completados.

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"
      ]
    }
  ]
}

Tabla

Desglose por Canal

Cantidad de pedidos e ingresos agrupados por canal de venta.

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"
      ]
    }
  ]
}

Número

Total de ingresos

Suma del valor total de los pedidos completados en el período.

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"
      ]
    }
  ]
}

Números

3 métricas

  • Total de Pedidos

    Número de pedidos completados en el período (excluye cancelados).

    cardapio_web:total_orders
  • Total de ingresos

    Suma del valor total de los pedidos completados en el período.

    cardapio_web:total_revenue
  • Ticket Promedio

    Ingresos totales divididos por el número de pedidos completados.

    cardapio_web:average_ticket

Gráficos

4 métricas

  • Pedidos por Día

    Evolución diaria de los pedidos completados.

    cardapio_web:orders_over_time
  • Ingresos por Día

    Evolución diaria de los ingresos totales.

    cardapio_web:revenue_over_time
  • Pedidos por Canal

    Distribución de los pedidos completados por canal de venta.

    cardapio_web:orders_by_channel
  • Facturación por Canal

    Ingresos totales agrupados por canal de venta.

    cardapio_web:revenue_by_channel

Tablas

2 métricas

  • Desglose por Canal

    Cantidad de pedidos e ingresos agrupados por canal de venta.

    cardapio_web:channel_breakdown
  • Productos Más Vendidos

    Productos más vendidos clasificados por cantidad vendida.

    cardapio_web:top_products

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.