Entrar

Reporte de ingresos por campaña

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

Cuántas ventas atribuyó la campaña y cuánto valieron.

Atribución significa que el cliente canjeó saldo de la campaña (cashback, point, coupon), o recibió un mensaje de ella y compró dentro de la ventana de atribución (notification). Las ventas que la campaña sólo premió no cuentan — premiar es consecuencia de la venta, no su causa.

Atribución no es incrementalidad. Esas ventas pudieron haber ocurrido de todos modos — el cliente tenía saldo y lo usó, pero quizá habría comprado igual. Léalo como ingreso influenciado, no generado. Medir impacto real exige grupo de control.

revenueGross es el total del pedido antes de descontar el saldo canjeado; revenueNet lo resta y es lo que entró como dinero. avgDiscount es redeemed / revenueGross (razón), averageTicketGross es revenueGross / orders y averageTicketNet es revenueNet / orders, siempre sobre pedidos distintos; la diferencia entre los dos tickets es el saldo promedio aplicado por pedido.

baseline es la regla: pedidos no atribuidos a esta campaña, en la misma ventana y organización. Sin ella, un número absoluto de ingresos siempre parece bueno. Está cacheado (la consulta es cara y el valor cambia despacio), así que lleva su propio computedAt y no es del mismo instante que el resto de la respuesta.

Sin período informado, la ventana va del primer al último pedido atribuido — comparar contra "siempre" llenaría la regla de períodos en que la campaña ni existía. period.explicit dice cuál de los dos ocurrió.

Esto vive en order porque el valor de la venta vive aquí. El reporte de campaña de loyalty mide el beneficio (acreditado, canjeado, saldo pendiente); este mide los ingresos. Responden preguntas distintas y no van a coincidir.

byOrigin no cuadra con total, y es a propósito. Una venta atribuida por más de un origen cuenta una vez en cada uno. El total cuenta pedidos distintos, así que siempre es menor o igual que la suma de byOrigin.

Los pedidos cancelados quedan fuera — ingreso de una venta revertida no es ingreso.

Todos los valores monetarios son enteros en centavos, en la moneda de la organización.

El período es todo o nada. Informar sólo uno de los dos devuelve 404 — la ruta no casa con una sola fecha. Media ventana ignorada en silencio devolvería números de "siempre" con cara de números del período pedido.

Try-it values populated from environment ACME (Demo)


Autenticación

Token

Send your user token in the x-guper-authorization header.

Encabezados

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 de ruta

Name Type Description
campaignId * integer Id de la campaña en loyalty.
dateStart string Inicio del período, `AAAA-MM-DD`, filtrando por la fecha del pedido. Requiere `dateEnd`.
dateEnd string Fin del período, `AAAA-MM-DD`, inclusive. Requiere `dateStart`.

Respuestas

{
    "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