Metrics

Métricas do WooCommerce pela API

Seu cliente conecta a conta do WooCommerce e seu produto consulta 30 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": "woo_commerce:number_orders_total",
      "component": "number_v1",
      "metrics": [
        "orders_total"
      ],
      "dimensions": [
        "orders"
      ]
    }
  ]
}
Exemplo: "Pedidos" em outubro, comparado a setembro.

Mais exemplos de chamadas no WooCommerce

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

Reembolsos ao longo do tempo

Valor total de dinheiro devolvido aos clientes por meio de reembolso durante o período analisado.

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": "woo_commerce:refunds_over_time",
      "component": "chart_v1",
      "metrics": [
        "refunds"
      ],
      "dimensions": [
        "date"
      ]
    }
  ]
}

Tabela

Receita por dia

Detalhamento da receita diária da loja ao longo do período analisado.

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": "woo_commerce:revenue_by_day",
      "component": "datatable_v1",
      "metrics": [
        "orders",
        "sales",
        "net_sales",
        "refunds",
        "tax",
        "shipping",
        "coupons"
      ],
      "dimensions": [
        "daily_revenue"
      ]
    }
  ]
}

Número

Pedidos pendentes

Número de pedidos recebidos, mas que o pagamento ainda não foi iniciado. Os pedidos com esse status não são considerados pagos.

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": "woo_commerce:number_pending_orders",
      "component": "number_v1",
      "metrics": [
        "pending_orders"
      ],
      "dimensions": [
        "orders"
      ]
    }
  ]
}

Números

16 métricas

  • Pedidos

    Total de novos pedidos no período analisado, excluindo pedidos com pagamento pendente, cancelados e com falha.

    woo_commerce:number_orders_total
  • Pedidos pendentes

    Número de pedidos recebidos, mas que o pagamento ainda não foi iniciado. Os pedidos com esse status não são considerados pagos.

    woo_commerce:number_pending_orders
  • Pedidos em espera

    Número de pedidos em espera.

    woo_commerce:number_on_hold_orders
  • Valor líquido de desconto

    Soma total dos descontos de cupons durante o período analisado.

    woo_commerce:number_net_discount
  • Total de taxas

    Valor total das taxas do período analisado. A métrica é calculada somando a Taxa de pedido + Taxa de entrega.

    woo_commerce:number_total_taxes
  • Reembolsos

    Total amount of money returned to customers through a refund during the analyzed period.

    woo_commerce:number_refunds
  • Itens vendidos

    Número total de itens vendidos durante o período analisado.

    woo_commerce:number_items_sold
  • Valor médio do pedido

    Receita média gerada por cada pedido feito na loja online. Esta métrica é calculada dividindo-se as vendas líquidas totais pelo número total de pedidos durante o período analisado.

    woo_commerce:number_avg_order_value
  • Total de vendas

    Valor total de vendas para o período analisado. Esta métrica é calculada da seguinte forma: Vendas brutas – Reembolsos – Cupons + Taxas + Frete.

    woo_commerce:number_total_sales
  • Vendas líquidas

    Valor líquido das vendas do período analisado. Esta métrica é calculada da seguinte forma: Vendas brutas – Reembolsos – Cupons.

    woo_commerce:number_net_sales
  • Vendas brutas

    Preço de venda dos produtos multiplicado pela quantidade de produtos pedidos. Não inclui reembolsos, cupons, taxas ou envio.

    woo_commerce:number_gross_sales
  • Taxa de pedido

    O total de taxas aplicadas aos itens em um pedido durante o período analisado.

    woo_commerce:number_order_tax
  • Taxa de envio

    O total de taxas aplicadas ao envio em um pedido durante o período analisado.

    woo_commerce:number_shipping_tax
  • Pedidos com desconto

    Número de pedidos com um cupom aplicado durante o período analisado.

    woo_commerce:number_orders_with_coupon
  • Entrega

    Os custos de entrega associados a um pedido ou reembolso.

    woo_commerce:number_total_delivery
  • Produtos sem estoque

    Número de produtos que não possuem unidades disponíveis em estoque para venda.

    woo_commerce:number_products_out_of_stock

Gráficos

8 métricas

  • Reembolsos ao longo do tempo

    Valor total de dinheiro devolvido aos clientes por meio de reembolso durante o período analisado.

    woo_commerce:refunds_over_time
  • Pedidos ao longo do tempo

    O número total de novos pedidos realizados ao longo do período analisado.

    woo_commerce:orders_over_time
  • Entregas ao longo do período

    Entregas ao longo do período

    woo_commerce:deliveries_over_time
  • Valor médio por pedido ao longo do tempo

    Valor médio de receita gerada por cada pedido realizado na loja virtual ao longo do período analisado. Essa métrica é calculada dividindo o total de vendas líquidas pelo número total de pedidos durante o período analisado.

    woo_commerce:avg_order_value_over_time
  • Itens vendidos ao longo do tempo

    O número total de itens vendidos ao longo do período analisado.

    woo_commerce:items_sold_over_time
  • Valor dos cupons usados

    Soma total dos descontos dos cupons usados ao longo do período analisado.

    woo_commerce:coupon_value_over_time
  • Total de vendas

    Valor total das vendas ao longo do período analisado. Esta métrica é calculada da seguinte forma: Vendas brutas – Reembolsos – Cupons + Taxas + Envio.

    woo_commerce:total_sales_over_time
  • Vendas líquidas ao longo do tempo

    Valor líquido das vendas ao longo do período analisado. Esta métrica é calculada da seguinte forma: Vendas brutas – Reembolsos – Cupons.

    woo_commerce:net_sales_over_time

Tabelas

6 métricas

  • Receita por dia

    Detalhamento da receita diária da loja ao longo do período analisado.

    woo_commerce:revenue_by_day
  • Clientes em destaque

    Clientes que mais gastaram em sua loja durante o período analisado.

    woo_commerce:featured_customers_performance
  • Desempenho por categoria

    Resumo do desempenho das categorias de produtos da sua loja durante o período analisado.

    woo_commerce:category_performance
  • Desempenho de cupons

    Resumo do desempenho dos cupons durante o período analisado.

    woo_commerce:coupon_performance
  • Desempenho das taxas

    Resumo de desempenho das taxas cobradas em sua loja.

    woo_commerce:tax_performance
  • Desempenho dos produtos

    Desempenho de vendas de cada produto da loja durante o período analisado.

    woo_commerce:product_performance

Veja o Connect aplicado ao seu produto.

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