Entrar

Audiência endereçada por período

GET https://{organization}.myguper.com/api/loyalty/report/audience/{start}/{end}

A quem as campanhas foram endereçadas numa janela de data — o denominador de "de quem a gente mirou, quantos realmente receberam".

O relatório de cards diz quantas recompensas nasceram. Não diz quantas pessoas a campanha tentou alcançar para chegar lá. Este endpoint é a outra metade: divida uma pela outra e você tem a resposta.

O trabalho que ele faz por você é que a audiência mora em três tabelas diferentes, uma por gatilho, com três unidades diferentes. Tudo volta em pessoas:

Gatilho Fonte Uma linha é
audience-list a audiência da campanha uma pessoa
reactivate-reward a fila de reativação um cliente
last-chance a fila de última chance um card × campanha

A última chance é a armadilha: a fila dela é por card que está expirando, não por pessoa, então um cliente com três cards vencendo gera três linhas. Contar linha ali infla a audiência em mais que o dobro e corta pela metade qualquer taxa construída em cima. Este endpoint deduplica para você.

Voltam dois números, e só um deles é denominador:

  • targeted — pessoas distintas dentro de cada campanha, somadas. É o que casa com recompensa concedida, porque a recompensa também nasce por (campanha, pessoa): quem está em duas campanhas conta duas vezes nos dois lados da divisão.
  • clients — pessoas distintas no gatilho. Responde "quanta gente a gente alcançou", e nunca deve virar denominador.

Gatilho sem audiência não aparece aqui, de propósito. form-submission e external-events nascem de um ato do cliente — ninguém foi endereçado. Somar as recompensas deles a um denominador que não existe derruba a taxa sem motivo. O meta.triggers diz o que está coberto.

Não existe gatilho birthday. Campanha de aniversário existe, mas é montada como lista de audiência e volta nesse balde.

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
start * string First day of the window, `YYYY-MM-DD`, inclusive.
end * string Last day of the window, `YYYY-MM-DD`, inclusive. The window runs on when the person entered the list or queue.

Parâmetros de query

Name Type Description
type string Campaign type. **Pass `monetary` for any rate**: a `notification` campaign can use an audience list — it addresses people and never creates a reward, by design.
campaign string Comma-separated campaign ids. Omit for every campaign in the window.
groupBy string Which breakdowns to return: `trigger`, `campaign`, or both (the default).

Respostas

Relacionados

Copied to clipboard