Metrics
Cardápio Web metrics via API
Your customer connects their Cardápio Web account and your product queries 9 metrics through the same endpoint as every other platform. Each metric has an id (reference_key) that goes in the request.
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"
]
}
]
}More Cardápio Web request examples
The same endpoint for every kind of metric. The metrics and dimensions of each item come from the platform catalog (GET /api/metrics/{integration_slug}).
Chart
Orders per Day
Daily evolution of completed orders.
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"
]
}
]
}Table
Channel Breakdown
Orders count and revenue grouped by sales channel.
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"
]
}
]
}Number
Total Revenue
Sum of order totals for completed orders in the period.
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"
]
}
]
}Numbers
3 metrics
Total Orders
Number of completed orders in the period (excludes cancelled orders).
cardapio_web:total_ordersTotal Revenue
Sum of order totals for completed orders in the period.
cardapio_web:total_revenueAverage Ticket
Total revenue divided by the number of completed orders.
cardapio_web:average_ticket
Charts
4 metrics
Orders per Day
Daily evolution of completed orders.
cardapio_web:orders_over_timeRevenue per Day
Daily evolution of total revenue.
cardapio_web:revenue_over_timeOrders by Channel
Distribution of completed orders by sales channel.
cardapio_web:orders_by_channelRevenue by Channel
Total revenue grouped by sales channel.
cardapio_web:revenue_by_channel
Tables
2 metrics
Channel Breakdown
Orders count and revenue grouped by sales channel.
cardapio_web:channel_breakdownTop Selling Products
Best-selling products ranked by quantity sold.
cardapio_web:top_products
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
