Entrar

Relatório de receita por campanha

GET https://{organization}.myguper.com/api/order/report/campaign/{campaignId}

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.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Parâmetros do caminho

Name Type Description
campaignId * integer Id da campanha no loyalty.
dateStart string Início do período, `AAAA-MM-DD`, filtrando pela data do pedido. Exige `dateEnd`.
dateEnd string Fim do período, `AAAA-MM-DD`, inclusive. Exige `dateStart`.

Respostas

{
    "meta": {
        "unit": "cents",
        "attribution": {
            "rule": "Venda atribuida a campanha cujo saldo foi resgatado (cashback/point/coupon), ou cuja mensagem o cliente recebeu e comprou dentro da janela (notification). Campanha que apenas premiou a venda NAO entra.",
            "caveat": "Atribuicao nao e incrementalidade: a venda pode ter acontecido de qualquer forma. Ler como receita INFLUENCIADA, nao gerada. Medir impacto real exige grupo de controle."
        },
        "notes": {
            "revenueGross": "total_order dos pedidos atribuidos. Bruto: o resgate NAO esta descontado.",
            "revenueNet": "revenueGross - redeemed. O que entrou como dinheiro.",
            "returnOnBenefit": "revenueGross / redeemed. Sobre o RESGATADO, nao o creditado.",
            "baseline": "Pedidos NAO atribuidos a esta campanha, mesma janela e organizacao.",
            "byOrigin": "Nao soma com total: pedido atribuido por mais de uma origem conta uma vez em cada."
        }
    },
    "campaign": 361,
    "period": {
        "start": "2025-12-06",
        "end": "2026-08-17",
        "explicit": false
    },
    "total": {
        "orders": 10254,
        "clients": 8538,
        "revenueGross": 1904183642,
        "redeemed": 333571751,
        "revenueNet": 1570611891,
        "averageTicket": 185702,
        "avgDiscount": 0.1752,
        "averageTicketGross": 185702,
        "averageTicketNet": 153171,
        "returnOnBenefit": 5.71
    },
    "baseline": {
        "orders": 185201,
        "averageTicket": 280407,
        "ticketDeltaPct": -33.8,
        "computedAt": "2026-08-17 18:02:09"
    },
    "repeat": {
        "clients": 8538,
        "repeatClients": 1330,
        "repeatRate": 15.6,
        "ordersPerClient": 1.2
    },
    "byOrigin": [
        {
            "origin": "cashback",
            "orders": 10254,
            "revenueGross": 1904183642,
            "averageTicket": 185702
        }
    ]
}
Copied to clipboard