v1

latestOpenAPI 3.0.32026-07-2647114182.1 KB
orders

Analytics de Vendas

Analise vendas por canal de aquisição, campanha ou origem de tráfego. Compare a performance de campanhas usando métricas financeiras agregadas.

get/public_api/orders/analytics/

Query parameters

start_datestring required

Data inicial do período (formato DD-MM-YYYY).

end_datestring required

Data final do período (formato DD-MM-YYYY).

group_by'utm_source' | 'utm_medium' | 'utm_campaign'

Dimensão de análise. Valores possíveis são utm_source, utm_medium, utm_campaign. Padrão é utm_source.

statusstring

Filtra por status do pedido (múltiplos valores separados por vírgula).

productstring

Filtra por Id ou nome do produto.

offerstring

Filtra por Id da oferta.

paymentMethodstring

Filtra por método de pagamento.

offer_typestring

Filtra por tipo da oferta (main, upsell, downsell, orderbump).

typestring

Filtra por tipo do produto (unique, subscription).

Response

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

group_bystring required

Dimensão utilizada para agrupar os resultados