Metrics

Métricas do Cardápio Web pela API

Seu cliente conecta a conta do Cardápio Web e seu produto consulta 9 métricas pelo mesmo endpoint das outras plataformas. Cada métrica tem um identificador (reference_key) que vai na chamada.

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"
      ]
    }
  ]
}
Exemplo: "Total de Pedidos" em outubro, comparado a setembro.

Mais exemplos de chamadas no Cardápio Web

O mesmo endpoint para cada tipo de métrica. Os campos metrics e dimensions de cada item vêm do catálogo da plataforma (GET /api/metrics/{integration_slug}).

Gráfico

Pedidos por Dia

Evolução diária dos pedidos concluídos.

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

Tabela

Detalhamento por Canal

Quantidade de pedidos e receita agrupados por canal de venda.

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

Receita total

Soma do valor total dos pedidos concluídos no 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 concluídos no período (exclui cancelados).

    cardapio_web:total_orders
  • Receita total

    Soma do valor total dos pedidos concluídos no período.

    cardapio_web:total_revenue
  • Ticket Médio

    Receita total dividida pelo número de pedidos concluídos.

    cardapio_web:average_ticket

Gráficos

4 métricas

  • Pedidos por Dia

    Evolução diária dos pedidos concluídos.

    cardapio_web:orders_over_time
  • Receita por Dia

    Evolução diária da receita total.

    cardapio_web:revenue_over_time
  • Pedidos por Canal

    Distribuição dos pedidos concluídos por canal de venda.

    cardapio_web:orders_by_channel
  • Faturamento por Canal

    Receita total agrupada por canal de venda.

    cardapio_web:revenue_by_channel

Tabelas

2 métricas

  • Detalhamento por Canal

    Quantidade de pedidos e receita agrupados por canal de venda.

    cardapio_web:channel_breakdown
  • Produtos Mais Vendidos

    Produtos mais vendidos classificados por quantidade vendida.

    cardapio_web:top_products

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.