Relatório de receita por campanha
Quantas vendas a campanha atribuiu e quanto elas valeram.
Atribuição significa que o cliente resgatou saldo da campanha (cashback, point,
coupon), ou recebeu uma mensagem dela e comprou dentro da janela de atribuição
(notification). Vendas que a campanha apenas premiou não entram — premiar é
consequência da venda, não causa dela.
Atribuição não é incrementalidade. Essas vendas podem ter acontecido de qualquer forma — o cliente tinha saldo e usou, mas talvez comprasse igual. Leia como receita influenciada, não gerada. Medir impacto real exige grupo de controle.
revenueGross é o total do pedido antes de tirar o saldo resgatado; revenueNet
desconta e é o que entrou como dinheiro. avgDiscount é redeemed / revenueGross
(razão), averageTicketGross é revenueGross / orders e averageTicketNet é
revenueNet / orders, sempre sobre pedidos distintos; a diferença entre os dois
tickets é o saldo médio aplicado por pedido.
baseline é a régua: pedidos não atribuídos a esta campanha, na mesma janela e
organização. Sem ela, um número absoluto de receita sempre parece bom. Ele é cacheado (a
query é cara e o valor muda devagar), então carrega o próprio computedAt e não é do
mesmo instante que o resto da resposta.
Sem período informado, a janela vai do primeiro ao último pedido atribuído — comparar
contra "sempre" encheria a régua de períodos em que a campanha nem existia.
period.explicit diz qual dos dois aconteceu.
Isso vive no order porque o valor da venda vive aqui. O relatório de campanha do loyalty mede o benefício (creditado, resgatado, saldo em aberto); este mede a receita. Eles respondem perguntas diferentes e não vão bater.
byOrigin não fecha com total, e isso é de propósito. Uma venda atribuída por mais
de uma origem conta uma vez em cada. O total conta pedidos distintos, então é sempre
menor ou igual à soma de byOrigin.
Pedidos cancelados ficam de fora — receita de venda revertida não é receita.
Todos os valores monetários são inteiros em centavos, na moeda da organização.
O período é tudo-ou-nada. Informar só um dos dois retorna 404 — a rota não casa com uma
data só. Meia janela ignorada em silêncio devolveria número de "sempre" com cara de número
do período pedido.
Try-it values populated from environment ACME (Demo)
Autenticação
Token
Send your user token in the x-guper-authorization header.