Entrar

Listar atribuições de campanha

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

Campanhas às quais a venda é atribuída. Responde nos dois sentidos: filtre por order para "a que campanhas essa venda foi atribuída", ou por campaign para "que vendas essa campanha gerou".

Uma venda é atribuída a uma campanha de duas formas: o cliente resgatou saldo dela (cashback, point, coupon), ou o cliente recebeu uma mensagem dela e comprou dentro da janela de atribuição (notification). Campanha que premiou a venda não é atribuição — premiar é consequência da venda, não causa dela.

A mesma venda pode ser atribuída à mesma campanha por mais de uma origem, e por mais de um card resgatado. Cada uma é uma linha separada. Para medir conversão, conte pedidos distintos, não linhas.

Isto espelha o customerCampaignAttribution do loyalty, que é o registro autoritativo — a atribuição por resgate é escrita por um trigger no banco quando o resgate é confirmado. As linhas chegam aqui logo depois, por chamada do loyalty.

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

Name Type Description
q[order] integer Id do pedido no Guper. Retorna todas as campanhas às quais essa venda foi atribuída.
q[campaign] integer Id da campanha no loyalty. Retorna todas as vendas atribuídas a essa campanha.
q[origin] string `cashback`, `point` ou `coupon` (saldo da campanha foi resgatado) ou `notification` (o cliente recebeu uma mensagem dela e comprou dentro da janela). Mesmo vocabulário do `attributionType` do loyalty.
p integer Número da página. Padrão 1.
e integer Linhas por página. Use 0 para não paginar.

Respostas

{
    "list": [
        {
            "order": 6021077,
            "campaign": 457,
            "origin": "notification",
            "assetId": "B1BCBD0518B3F93C9E47A59971C0E304FD7BEA806E01A6A45CC438F692232684",
            "campaignType": "monetary",
            "value": 0,
            "attributedAt": "2026-08-13 16:11:03",
            "notifiedAt": "2026-07-31 23:21:30",
            "windowEndsAt": "2026-09-01 02:59:59",
            "createdAt": "2026-08-13 16:11:03"
        },
        {
            "order": 6021077,
            "campaign": 457,
            "origin": "cashback",
            "assetId": "CD24D2E0AF5DDF020BCCEE84195226DF0813CB7563B2ECFF8A23D6D2A95049C6C3",
            "campaignType": "monetary",
            "value": 76485,
            "attributedAt": "2026-08-13 16:11:02",
            "notifiedAt": null,
            "windowEndsAt": null,
            "createdAt": "2026-08-13 16:11:03"
        }
    ],
    "total": 2,
    "pages": 1,
    "page": 1
}
Copied to clipboard