Skip to main content
GET
cURL

Escopo

O que é este endpoint?

Este endpoint mostra o desempenho das suas vendas agrupado por canal de aquisição, campanha ou origem de tráfego. Em vez de olhar pedido por pedido, você recebe métricas financeiras agregadas que revelam onde seu dinheiro de marketing está rendendo mais.
Valores financeiros são retornados como strings para preservar a precisão decimal. Pedidos sem UTM preenchido aparecem agrupados como "(unclassified)".

Por que analisar canais de venda?

Essa visão permite direcionar investimentos, cortar desperdícios e escalar o que funciona.

Descobrir o que funciona

Identifique quais canais (Google, Facebook, Instagram, orgânico etc.) trazem mais pedidos e receita líquida.

Otimizar investimentos

Reduza gastos em canais com baixo retorno e aumente o budget nas origens que realmente convertem.

Comparar campanhas

Avalie o desempenho financeiro de campanhas específicas e descubra quais mensagens e criativos geram mais resultado.

Construir relatórios

Alimente dashboards e apresentações com dados consolidados de performance por origem de tráfego.

Casos de uso

Descubra se o tráfego pago do Facebook está gerando mais receita líquida do que o tráfego orgânico do Google. Use o parâmetro group_by=utm_source para comparar canais lado a lado.
Lançou três campanhas diferentes este mês? Use group_by=utm_campaign para ver qual delas trouxe mais pedidos, maior ticket médio e melhor margem líquida.
Meça o resultado real dos seus anúncios. Filtre por período (start_date e end_date) e compare semanas com e sem investimento em tráfego pago para calcular o ROI.
Acompanhe semanal ou mensalmente como cada canal performa. Identifique picos de vendas em datas específicas (Black Friday, lançamentos etc.) e replique estratégias vencedoras.
Quer saber se o curso novo está vendendo mais pelo Instagram ou pelo YouTube? Filtre por product ou offer e agrupe por utm_source para descobrir.

Insights que podem ser obtidos

O volume de pedidos não conta toda a história. Um canal com menos vendas pode ter ticket médio maior e menos taxas, resultando em maior receita líquida. Analise gross_volume, net_value e total_fees juntos.
O campo total_discount mostra quanto você está abrindo mão em cada canal. Se um canal depende muito de cupons para vender, a receita líquida pode ser menor do que parece.
Combine net_value e order_count com seus gastos em anúncios para calcular o CAC (Custo de Aquisição de Cliente) de cada canal. Isso revela onde cada real investido rende mais.
Canais classificados como "(unclassified)" indicam vendas sem UTM. Isso pode ser tráfego direto, indicação ou campanhas mal configuradas. Corrigir o rastreamento pode revelar de onde vem sua melhor conversão.

Dimensão de análise

Use o parâmetro group_by para segmentar e comparar resultados. Escolha a dimensão que faz mais sentido para a sua pergunta de negócio: Exemplo: ?start_date=01-01-2025&end_date=31-12-2025&group_by=utm_medium Retorna a performance financeira agrupada por tipo de mídia (cpc, email, social etc) durante todo o ano de 2025.

Filtros adicionais

Filtros podem ser combinados com a dimensão de análise para refinar os resultados. Quanto mais específico, mais acionável é o insight.
  • status — Status do pedido (múltiplos valores separados por vírgula)
Para analisar apenas vendas concluídas, use status=paid.
Exemplo: ?status=paid — Considera apenas pedidos pagos na agregação, ignorando pendentes, cancelados ou reembolsados.
  • product — Id ou nome do produto
  • products — Id dos produtos (múltiplos valores suportados)
  • offer — Id da oferta
  • paymentMethod — Método de pagamento
Exemplo: ?product=123&status=paid — Vendas pagas de um produto específico, útil para entender a performance de um lançamento.
  • offer_type — Tipo da oferta (main, upsell, downsell, orderbump)
  • type — Tipo do produto (unique, subscription)
  • installments — Número de parcelas
Exemplo: ?offer_type=upsell&group_by=utm_source — Descubra qual canal traz mais vendas adicionais (upsell).

Como interpretar a resposta

A resposta contém três elementos principais:

Métricas de cada linha

A diferença entre gross_volume e net_value mostra o impacto real dos descontos e taxas. Um canal com alto gross_volume mas baixo net_value pode estar mascarando uma margem fraca.

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Response

Métricas financeiras agregadas por origem de tráfego, canal ou campanha.

group_by
string
required

Dimensão utilizada para agrupar os resultados

results
object[]
required

Lista de métricas agregadas por dimensão

totals
object
required