Metrics

iFood Financial metrics via API

Your customer connects their iFood Financial account and your product queries 52 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": "ifood:total_sales",
      "component": "number_v1",
      "metrics": [
        "total_sales"
      ],
      "dimensions": [
        "sales"
      ]
    }
  ]
}
Example: "Total Sales" in October, compared to September.

More iFood Financial 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

Sales per Day

Daily evolution of the number of completed sales.

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": "ifood:sales_over_time",
      "component": "chart_v1",
      "metrics": [
        "total_sales"
      ],
      "dimensions": [
        "date"
      ]
    }
  ]
}

Table

Payments by Method

Sales count and value by payment method (Card, Pix, Meal Voucher, etc.).

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": "ifood:payments_by_method",
      "component": "datatable_v1",
      "metrics": [
        "total_sales",
        "total_sales_value"
      ],
      "dimensions": [
        "payment_method"
      ]
    }
  ]
}

Number

Total Sales Value

Sum of the value of completed orders: (items + delivery fee − discounts funded by the merchant and by the chain). iFood-funded subsidies are not deducted.

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": "ifood:total_sales_value",
      "component": "number_v1",
      "metrics": [
        "total_sales_value"
      ],
      "dimensions": [
        "sales"
      ]
    }
  ]
}

Numbers

33 metrics

  • Total Sales

    Number of completed orders in the period (excludes cancelled and Easy Delivery).

    ifood:total_sales
  • Total Sales Value

    Sum of the value of completed orders: (items + delivery fee − discounts funded by the merchant and by the chain). iFood-funded subsidies are not deducted.

    ifood:total_sales_value
  • Average Ticket

    Total sales value divided by the number of completed sales.

    ifood:average_ticket
  • Cancellation Rate

    Percentage of cancelled orders relative to total orders in the period.

    ifood:cancelled_rate
  • Gross Sales Value

    Total gross sales value: sum of financial entries (iFood + merchant) and promotions (iFood + merchant delivery). All values shown as positive (absolute value).

    ifood:recon_gross_sales_value
  • Debit from Full Cancellation

    Total debits from orders fully cancelled.

    ifood:recon_debit_cancelamento_total_value
  • Debit from Partial Cancellation

    Total debits from partial cancellations.

    ifood:recon_debit_cancelamento_parcial_value
  • Credit from Refund/Indemnification

    Total credits from refunds or indemnifications.

    ifood:recon_credit_ressarcimento_value
  • Refund of Cancelled Orders

    Total value of refunds/indemnifications for cancelled orders. Positive value representing compensation paid to the merchant.

    ifood:recon_refund_cancelled_orders_value
  • Sales Occurrences (Value)

    Total adjustments related to sales occurrences.

    ifood:recon_ocorrencia_venda_value
  • Standalone Occurrences (Value)

    Total adjustments from standalone occurrences.

    ifood:recon_ocorrencia_avulsa_value
  • Manual Processing (Value)

    Total adjustments made by manual processing.

    ifood:recon_processamento_manual_value
  • Financial Entry (iFood)

    Money received via iFood as financial entries.

    ifood:recon_financial_entry_ifood_value
  • Promotion Funded by iFood

    Total value of promotions funded by iFood.

    ifood:recon_promo_ifood_value
  • Customer Fees Due to iFood

    Total value of customer fees due to iFood.

    ifood:recon_customer_fee_ifood_value
  • iFood Delivery Fee

    Total iFood delivery fees.

    ifood:recon_delivery_fee_ifood_value
  • iFood Refund

    Total iFood refunds.

    ifood:recon_reembolso_ifood_value
  • Store VR/VA Reversal

    Total value of store VR/VA reversals.

    ifood:recon_estorno_loja_vr_va_value
  • iFood Commission

    Total iFood commission charged.

    ifood:recon_commission_ifood_value
  • iFood Commission (Merchant Delivery)

    Total iFood commission charged for orders with merchant's own delivery (not iFood logistics).

    ifood:recon_commission_merchant_delivery_value
  • Transaction Fee

    Total transaction fees charged.

    ifood:recon_transaction_fee_value
  • iFood Benefits Transaction Fee

    Total transaction fees for iFood Benefits.

    ifood:recon_transaction_fee_benefits_value
  • Settlement Plan Fee

    Total settlement plan fees.

    ifood:recon_settlement_plan_fee_value
  • On-demand Delivery Request (iFood Delivery)

    Total charges for on-demand delivery requests (iFood delivery).

    ifood:recon_solicitacao_frete_ifood_value
  • On-demand Delivery Service Fee (iFood Delivery)

    Total service fees for on-demand delivery (iFood delivery).

    ifood:recon_solicitacao_frete_service_fee_value
  • Transaction Fee Discount (iFood Benefits)

    Total discounts or refunds of iFood Benefits transaction fees.

    ifood:recon_discount_transaction_benefits_value
  • Acquirer Fee Refund

    Total acquirer fee refunds.

    ifood:recon_acquirer_fee_refund_value
  • Ads Package Charge

    Total charges for ads packages.

    ifood:recon_ads_package_charge_value
  • Financial Entry (Merchant)

    Money received directly via the merchant.

    ifood:recon_financial_entry_loja_value
  • Promotion Funded by Merchant

    Total value of promotions funded by the merchant.

    ifood:recon_promo_loja_value
  • Merchant-funded Delivery Promotion

    Total value of merchant‑funded delivery promotions.

    ifood:recon_promo_loja_delivery_value
  • Customer Service Fee (Merchant)

    Total value of customer service fees charged by iFood but paid to the merchant (no impact on settlement).

    ifood:recon_customer_fee_loja_value
  • Total Sales Value (Net)

    Total net value of sales that will be paid to your store (sales only).

    ifood:recon_total_sales_value

Charts

15 metrics

  • Sales per Day

    Daily evolution of the number of completed sales.

    ifood:sales_over_time
  • Sales Value per Day

    Daily evolution of total sales value (net).

    ifood:sales_value_over_time
  • Average Ticket per Day

    Daily evolution of the average ticket (value per sale).

    ifood:average_ticket_over_time
  • Top Selling Hours

    Sales distribution by time ranges.

    ifood:best_hours
  • Top Selling Days (Mon–Thu)

    Distribution of sales by weekday considering only Monday to Thursday.

    ifood:best_days
  • Top Selling Days (Fri–Sun)

    Distribution of sales by weekday considering only Friday to Sunday.

    ifood:best_days_weekend
  • Most Used Payment Methods

    Number of sales per payment method (e.g., Credit, Debit, Pix, Cash, Meal Voucher, Digital Wallet).

    ifood:payment_methods
  • Payments by Liability

    Sales and values grouped by payment liability (e.g., iFood, Merchant).

    ifood:payments_by_liability
  • Payments by Type

    Sales and values by payment type (e.g., Online, Offline).

    ifood:payments_by_type
  • Payments by Card Brand

    Sales and values by card brand (e.g., Visa, MasterCard).

    ifood:payments_by_brand
  • Logistics by Product

    Number of sales by delivery product (e.g., Self Delivery, iFood Delivery, Easy Delivery).

    ifood:logistics_by_product
  • Logistics by Provider

    Number of sales by logistic provider (e.g., iFood, Merchant).

    ifood:logistics_by_provider
  • Cancellations by Origin

    Count of cancellations by origin (e.g., Automatic, Customer, Merchant, System).

    ifood:cancellations_by_origin
  • Cancellations by Stage

    Count of cancellations by order stage (e.g., Pre-Confirmed, Confirmed, Dispatched, Concluded).

    ifood:cancellations_by_stage
  • Cancellations per Day

    Daily evolution of the number of cancelled orders.

    ifood:cancelled_over_time

Tables

4 metrics

  • Payments by Method

    Sales count and value by payment method (Card, Pix, Meal Voucher, etc.).

    ifood:payments_by_method
  • Cancellations by Code

    Count of cancelled orders grouped by iFood cancellation code.

    ifood:cancellations_by_code
  • Refunds and Chargebacks

    Count and value of refunds and chargebacks associated with orders (e.g., Refund, Chargeback).

    ifood:refunds_and_chargebacks
  • Average Times (SLA)

    SLA represents service-level time targets. This widget shows the average elapsed minutes between key iFood order stages: Placed→Confirmed (merchant confirmation time), Confirmed→Dispatched (prep + handoff time), and Placed→Concluded (end-to-end fulfillment time). Lower values indicate faster operations.

    ifood:avg_times

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.