Metrics

Métricas do iFood Financial pela API

Seu cliente conecta a conta do iFood Financial e seu produto consulta 52 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": "ifood:total_sales",
      "component": "number_v1",
      "metrics": [
        "total_sales"
      ],
      "dimensions": [
        "sales"
      ]
    }
  ]
}
Exemplo: "Total de Vendas" em outubro, comparado a setembro.

Mais exemplos de chamadas no iFood Financial

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

Vendas por Dia

Evolução diária do número de vendas concluídas.

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

Tabela

Pagamentos por Método

Contagem e valor de vendas por método de pagamento (Cartão, Pix, Vale Refeição, 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"
      ]
    }
  ]
}

Número

Valor total das vendas

Soma do valor dos pedidos concluídos: (itens + taxa de entrega − descontos custeados pela loja e pela rede). Subsídios custeados pelo iFood não são descontados.

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

Números

33 métricas

  • Total de Vendas

    Número de pedidos concluídos no período (exclui cancelados e Easy Delivery).

    ifood:total_sales
  • Valor total das vendas

    Soma do valor dos pedidos concluídos: (itens + taxa de entrega − descontos custeados pela loja e pela rede). Subsídios custeados pelo iFood não são descontados.

    ifood:total_sales_value
  • Ticket Médio

    Valor total das vendas dividido pelo número de vendas concluídas.

    ifood:average_ticket
  • Taxa de Cancelamento

    Porcentagem de pedidos cancelados em relação ao total de pedidos no período.

    ifood:cancelled_rate
  • Valor bruto das vendas

    Valor bruto total das vendas: soma das entradas financeiras (iFood + loja) e promoções (iFood + entrega loja). Todos os valores são exibidos como positivos (valor absoluto).

    ifood:recon_gross_sales_value
  • Débito gerado por Cancelamento Total

    Débito gerado por Cancelamento Total.

    ifood:recon_debit_cancelamento_total_value
  • Débito gerado por Cancelamento Parcial

    Débito gerado por Cancelamento Parcial.

    ifood:recon_debit_cancelamento_parcial_value
  • Crédito gerado por Ressarcimento/Indenização

    Crédito gerado por Ressarcimento/Indenização.

    ifood:recon_credit_ressarcimento_value
  • Cancelamentos e reembolsos

    Valor total de reembolsos/indenizações de pedidos cancelados. Valor positivo representando compensação paga à loja.

    ifood:recon_refund_cancelled_orders_value
  • Valor total (crédito ou débito) gerado por Ocorrências de Venda

    Valor total gerado por Ocorrências de Venda.

    ifood:recon_ocorrencia_venda_value
  • Valor total gerado por Ocorrências Avulsas

    Valor total gerado por Ocorrências Avulsas.

    ifood:recon_ocorrencia_avulsa_value
  • Valor total gerado por Processamento Manual

    Valor total gerado por Processamento Manual.

    ifood:recon_processamento_manual_value
  • Entrada financeira (recebido via iFood)

    Entrada financeira recebida via iFood.

    ifood:recon_financial_entry_ifood_value
  • Promoção custeada pelo iFood

    Valor total de promoções custeadas pelo iFood.

    ifood:recon_promo_ifood_value
  • Taxas cobradas do usuário devidas ao iFood

    Valor total de taxas cobradas do usuário devidas ao iFood.

    ifood:recon_customer_fee_ifood_value
  • Taxa de Entrega iFood

    Total de taxas de entrega do iFood.

    ifood:recon_delivery_fee_ifood_value
  • Reembolso iFood

    Total de reembolsos do iFood.

    ifood:recon_reembolso_ifood_value
  • Estorno de pedido recebido via Loja (VR/VA)

    Valor total de estornos de pedidos recebidos via Loja (VR/VA).

    ifood:recon_estorno_loja_vr_va_value
  • Comissão do iFood

    Total de comissão do iFood cobrada.

    ifood:recon_commission_ifood_value
  • Comissão iFood de entrega própria

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

    ifood:recon_commission_merchant_delivery_value
  • Taxa de Transação

    Total de taxas de transação cobradas.

    ifood:recon_transaction_fee_value
  • Taxa transação iFood benefícios

    Total de taxas de transação para iFood benefícios.

    ifood:recon_transaction_fee_benefits_value
  • Taxa de Plano de Repasse

    Total de taxas de plano de repasse.

    ifood:recon_settlement_plan_fee_value
  • Solicitação de Frete (iFood entrega)

    Total de cobranças por solicitações de frete (iFood entrega).

    ifood:recon_solicitacao_frete_ifood_value
  • Taxa de Serviço Solicitação de Frete (iFood entrega)

    Total de taxas de serviço para solicitação de frete (iFood entrega).

    ifood:recon_solicitacao_frete_service_fee_value
  • Desconto taxa transação iFood benefícios

    Total de descontos ou estornos de taxas de transação do iFood benefícios.

    ifood:recon_discount_transaction_benefits_value
  • Reembolso taxa adquirência

    Total de reembolsos de taxa de adquirência.

    ifood:recon_acquirer_fee_refund_value
  • Cobrança Pacote Anúncios

    Total de cobranças por pacotes de anúncios.

    ifood:recon_ads_package_charge_value
  • Entrada financeira (recebido via Loja)

    Dinheiro recebido diretamente via Loja.

    ifood:recon_financial_entry_loja_value
  • Promoção custeada pela Loja

    Valor total de promoções custeadas pela Loja.

    ifood:recon_promo_loja_value
  • Promoção custeada pela Loja no Delivery

    Valor total de promoções de delivery custeadas pela Loja.

    ifood:recon_promo_loja_delivery_value
  • Taxa de serviço iFood cobrada do cliente

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

    ifood:recon_customer_fee_loja_value
  • Valor líquido total

    Valor líquido a ser repassado à loja apenas pelas vendas.

    ifood:recon_total_sales_value

Gráficos

15 métricas

  • Vendas por Dia

    Evolução diária do número de vendas concluídas.

    ifood:sales_over_time
  • Valor das Vendas por Dia

    Evolução diária do valor total das vendas (líquido).

    ifood:sales_value_over_time
  • Ticket Médio por Dia

    Evolução diária do ticket médio (valor por venda).

    ifood:average_ticket_over_time
  • Horários de Maior Venda

    Distribuição de vendas por faixas de horário.

    ifood:best_hours
  • Melhores Dias de Venda (Seg–Qui)

    Distribuição de vendas por dia da semana considerando apenas segunda a quinta-feira.

    ifood:best_days
  • Melhores Dias de Venda (Sex–Dom)

    Distribuição de vendas por dia da semana considerando apenas sexta a domingo.

    ifood:best_days_weekend
  • Métodos de Pagamento Mais Utilizados

    Número de vendas por método de pagamento (ex.: Crédito, Débito, Pix, Dinheiro, Vale Refeição, Carteira Digital).

    ifood:payment_methods
  • Pagamentos por Responsabilidade

    Vendas e valores agrupados por responsabilidade de pagamento (ex.: iFood, Lojista).

    ifood:payments_by_liability
  • Pagamentos por Tipo

    Vendas e valores por tipo de pagamento (ex.: Online, Offline).

    ifood:payments_by_type
  • Pagamentos por Bandeira do Cartão

    Vendas e valores por bandeira do cartão (ex.: Visa, MasterCard).

    ifood:payments_by_brand
  • Logística por Produto

    Número de vendas por produto de entrega (ex.: Entrega Própria, Entrega iFood, Entrega Fácil).

    ifood:logistics_by_product
  • Logística por Provedor

    Número de vendas por provedor logístico (ex.: iFood, Lojista).

    ifood:logistics_by_provider
  • Cancelamentos por Origem

    Contagem de cancelamentos por origem (ex.: Automático, Cliente, Lojista, Sistema).

    ifood:cancellations_by_origin
  • Cancelamentos por Estágio

    Contagem de cancelamentos por estágio do pedido (ex.: Pré-Confirmado, Confirmado, Despachado, Concluído).

    ifood:cancellations_by_stage
  • Cancelamentos por Dia

    Evolução diária do número de pedidos cancelados.

    ifood:cancelled_over_time

Tabelas

4 métricas

  • Pagamentos por Método

    Contagem e valor de vendas por método de pagamento (Cartão, Pix, Vale Refeição, etc.).

    ifood:payments_by_method
  • Cancelamentos por Código

    Contagem de pedidos cancelados agrupados por código de cancelamento do iFood.

    ifood:cancellations_by_code
  • Reembolsos e Estornos

    Contagem e valor de reembolsos e estornos associados aos pedidos (ex.: Reembolso, Estorno).

    ifood:refunds_and_chargebacks
  • Tempos Médios (SLA)

    SLA representa metas de tempo de atendimento. Este widget exibe os minutos médios entre as principais etapas do pedido no iFood: Realizado→Confirmado (tempo de confirmação da loja), Confirmado→Despachado (preparo + repasse ao entregador) e Realizado→Concluído (tempo total do pedido). Valores menores indicam operação mais rápida.

    ifood:avg_times

Veja o Connect aplicado ao seu produto.

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