Entrar

Funil das campanhas de notificação: pessoas alcançadas, quem comprou e a conversão

GET https://{organization}.myguper.com/api/loyalty/report/notifications/{dateStart}/{dateEnd}

O funil das campanhas que só mandam mensagem: quantas pessoas a mensagem alcançou e quantas delas compraram. É o denominador que nenhum outro relatório tem — o order.report.sales diz quanto a mensagem gerou, não a que custo de alcance.

Só campanha com type = notification. Essa é a regra da atribuição, não uma conveniência: campanha monetária ou de ponto emite card e é atribuída pelo resgate daquele saldo; a mensagem que ela dispara é um aviso de cashback, não "a mensagem que trouxe o cliente". Sem esse recorte, em 2026-08-14 uma organização tinha 24.035 atribuições por mensagem vindas de campanha monetária contra 41 de campanha de notificação — 99,8% indevidas.

⚠️ Duas datas diferentes, e a resposta mantém as duas separadas em vez de juntá-las numa taxa só:

  • total é a safra: mensagens enviadas dentro da janela (notificationCard.createdAt), e quantas dessas já converteram, em qualquer data. A conversão só significa algo assim — numerador e denominador são a mesma gente. Janela recente é imatura: a maior parte ainda está open, e a conversão dela sobe depois.
  • total.result é o que aconteceu dentro da janela (attributionDate): as atribuições e os pedidos do período. É este bloco que conversa com a receita influenciada do order.report.sales, que também filtra pela data da venda.

A janela de atribuição de cada mensagem é COALESCE(expiresAt, attributionAt, createdAt + 30 dias). ⚠️ attributionAt não é a data em que a compra foi atribuída — ele é gravado no nascimento do card e está deprecado; contar conversão por ele daria 100% sempre. Conversão só existe na tabela de atribuição.

Os três baldes converted / open / expired são excludentes e somam sent, para a tela poder mostrar em que pé está cada mensagem.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Send your user token in the x-guper-authorization header. Endpoints that support a Public mode (e.g. acúmulo and resgate previews) accept the same request without the header — Private mode adds customer data and a confirmation token to the response.

Cabeçalhos

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

Parâmetros do caminho

Name Type Description
dateStart * string Start of the period (YYYY-MM-DD), inclusive.
dateEnd * string End of the period (YYYY-MM-DD), inclusive.

Parâmetros de query

Name Type Description
groupBy string Adds the breakdowns. `campaign` returns `byCampaign` (one row per campaign, with the cohort numbers and its own `result`); `day` returns `byDay`, where `sent` is counted by the day the message went out and `orders` by the day of the purchase. Omitted, only `total` comes back.
campaign string Restrict to these campaigns. Array (`campaign[]=663`) or comma list. Ids that are not notification campaigns simply bring nothing.

Respostas

{
  "meta": {
    "unit": "clients",
    "timezone": "America/Sao_Paulo",
    "window": { "start": "2026-09-01", "end": "2026-09-22" },
    "groupBy": ["campaign", "day"]
  },
  "total": {
    "sent": 23964, "clients": 23694,
    "converted": 124, "convertedClients": 124,
    "open": 22889, "expired": 951,
    "conversionRate": 0.0052,
    "result": { "attributions": 139, "orders": 139, "clients": 124 }
  },
  "byCampaign": [
    {
      "campaign": 664, "campaignName": "09-moda-producto-correo-septiembre-2026",
      "sent": 3948, "clients": 3948,
      "converted": 13, "convertedClients": 13,
      "open": 3800, "expired": 135, "conversionRate": 0.0033,
      "result": { "attributions": 14, "orders": 14, "clients": 13 }
    }
  ],
  "byDay": [
    { "day": "2026-09-01", "sent": 1204, "clients": 1204, "attributions": 6, "orders": 6 }
  ]
}

Notas

Por que a conversão parece baixa

A conversão aqui é pessoas que compraram / pessoas alcançadas, e normalmente é uma fração de um por cento. Esse é o número honesto: uma base que compra de qualquer jeito vai produzir bastante compra dentro de qualquer janela de 30 dias, e contar isso como "influenciado" mede coincidência, não influência.

open é a parte que ainda pode converter. Numa janela que termina hoje ele domina — a conversão de um período recente não é final, e comparar um período fresco com um fechado sempre favorece o fechado.

Relacionados

Copied to clipboard