Metrics
Métricas do Shopify pela API
Seu cliente conecta a conta do Shopify e seu produto consulta 33 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": "shopify:processed_orders",
"component": "number_v1",
"metrics": [
"fulfilledOrdersTotal"
],
"dimensions": [
"orders_date"
]
}
]
}Mais exemplos de chamadas no Shopify
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 canal
Total de vendas do período associado a cada canal de vendas ativo.
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": "shopify:sales_per_channel",
"component": "chart_v1",
"metrics": [
"totalSales"
],
"dimensions": [
"orders_channel"
]
}
]
}Tabela
Produtos mais vendidos
Resumo do desempenho de vendas de cada produto durante o período analisado. Inclui pedidos feitos em todos os canais de vendas.
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": "shopify:best_selling_products",
"component": "datatable_v1",
"metrics": [
"vendor",
"productType",
"currentQuantity",
"grossSales",
"liquidSales",
"discount",
"refund",
"tax",
"totalSales"
],
"dimensions": [
"orders_products"
]
}
]
}Número
Lucro bruto total
O lucro total obtido dos produtos durante o período analisado. É calculado subtraindo o custo das vendas líquidas.
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": "shopify:gross_profit",
"component": "number_v1",
"metrics": [
"grossProfitTotal"
],
"dimensions": [
"orders_products"
]
}
]
}Números
21 métricas
Pedidos processados
O número acumulado de pedidos processados e marcados como processados durante o período de análise.
shopify:processed_ordersLucro bruto total
O lucro total obtido dos produtos durante o período analisado. É calculado subtraindo o custo das vendas líquidas.
shopify:gross_profitTotal de Vendas
As vendas totais são iguais às vendas brutas mais frete, impostos, tributos de importação e taxas, menos o valor de descontos e devoluções. Inclui todos os canais de vendas.
shopify:total_sales_valueReembolsos
Número total de itens devolvidos durante o período selecionado.
shopify:refundsTotal de pedidos
O número total de pedidos feitos em todos os canais de vendas.
shopify:total_ordersTaxa de Clientes Recorrentes
A porcentagem de pessoas que fizeram mais de um pedido na loja. A taxa é calculada dividindo-se o número de clientes recorrentes pelo número total de clientes que fizeram um pedido no período selecionado.
shopify:recurring_customers_rateTicket Médio
O valor médio de todos os pedidos (exceto cartões-presente) dividido pelo número total de pedidos com pelo menos um produto que não é um cartão-presente. O valor do pedido exclui ajustes após o pedido, como edições, trocas ou devoluções, bem como tributos de importação, outros tributos, frete e descontos.
shopify:average_ticketDescontos
Valor total dos descontos concedidos durante o período analisado. Esta métrica inclui todos os canais de vendas.
shopify:discountsVendas Brutas
Valor de todos os itens comprados antes do acréscimo de taxas ou outros ajustes, como tributos, frete, descontos ou devoluções. Esta métrica inclui todos os canais de vendas.
shopify:gross_salesTaxa de sell-through
Valor de todos os itens comprados antes do acréscimo de taxas ou outros ajustes, como tributos, frete, descontos ou devoluções. Esta métrica inclui todos os canais de vendas.
shopify:sell_throughMédia de unidades pedidas
Média de unidades de pedidos realizados durante o período de análise.
shopify:average_units_soldPedidos cancelados
Número total de pedidos cancelados durante o período selecionado.
shopify:canceled_ordersPedidos entregues
Número total de pedidos entregues durante o período selecionado.
shopify:delivered_ordersLucro líquido
Lucro total obtido com os produtos durante o período analisado. É calculado subtraindo o custo das vendas líquidas.
shopify:net_profitVendas líquidas
Total de vendas menos o valor dos descontos e devoluções. Inclui todos os canais de venda.
shopify:net_salesVendas pagas
Vendas líquidas considerando apenas pedidos com pagamento confirmado. Pedidos com pagamento pendente ou expirado, como Pix ou boleto não pagos, ficam de fora até serem pagos.
shopify:paid_salesValor dos reembolsos
Valor total dos reembolsos concedidos durante o período analisado. Essa métrica inclui todos os canais de venda.
shopify:refunds_valueValor do Frete
Valor total dos custos de frete durante o período analisado. Essa métrica inclui todos os canais de venda.
shopify:shipping_valueClientes Novos
O número de clientes que fizeram sua primeira compra durante o período analisado.
shopify:new_customersClientes Recorrentes
O número de clientes que já haviam feito compras anteriores e retornaram para comprar durante o período analisado.
shopify:recurring_customersTotal de Vendas de Clientes Novos
Total de vendas da primeira compra dos clientes novos no período analisado. As vendas totais são iguais às vendas brutas mais frete, impostos, tributos de importação e taxas, menos o valor de descontos e devoluções. Inclui todos os canais de vendas.
shopify:new_customers_total_sales
Gráficos
5 métricas
Vendas por canal
Total de vendas do período associado a cada canal de vendas ativo.
shopify:sales_per_channelPedidos ao longo do tempo
Número de pedidos feitos durante o período analisado.
shopify:orders_over_timeProcessamento de pedidos ao longo do tempo
O número cumulativo de pedidos processados e marcados como processados durante o período analisado.
shopify:orders_processing_over_timeTotal de vendas ao longo do tempo
Total de vendas ao longo do período selecionado. Corresponde às vendas brutas mais frete, impostos, tributos de importação e taxas, menos o valor de descontos e devoluções. Inclui todos os canais de vendas.
shopify:sales_over_timeTotal de vendas por hora
Valor total das vendas por hora. Os dados são calculados somando às vendas brutas mais frete, tributos, tributos de importação e taxas, menos o valor de descontos e devoluções. O valor inclui todos os canais de vendas.
shopify:sales_per_hour
Tabelas
7 métricas
Produtos mais vendidos
Resumo do desempenho de vendas de cada produto durante o período analisado. Inclui pedidos feitos em todos os canais de vendas.
shopify:best_selling_productsLucro por produto
Summary of gross profit performance by product for the selected period. Only products whose cost was recorded at the time of sale are listed.The number of sales.
shopify:profit_by_productLucro por variante de produto
Resumo do desempenho do lucro bruto por variante de produto para o período selecionado. Apenas os produtos cujo custo foi registrado no momento da venda estão listados.
shopify:profit_by_product_variantVendas por Referenciador de Tráfego
Vendas totais de cada origem do tráfego durante o período analisado.
shopify:sales_by_referrerVendas por Rede Social de Origem
Total de vendas resultantes de sessões da loja virtual que vieram de origens de referenciadores de redes sociais, como Facebook e Instagram. Essa métrica é válida apenas para o canal de vendas Loja Virtual.
shopify:sales_by_sourceResumo dos pedidos
Resumo dos pedidos do período analisado
shopify:orders_summaryResumo das Vendas
Resumo de desempenho das vendas para o período durante o tempo analisado.
shopify:sales_summary
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
