Entrar

Audiencia dirigida por período

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

A quién se dirigieron las campañas en una ventana de fechas — el denominador de "de las personas a las que apuntamos, cuántas realmente recibieron".

El reporte de cards dice cuántas recompensas nacieron. No dice a cuántas personas intentó alcanzar la campaña para llegar ahí. Este endpoint es la otra mitad: divide una entre la otra y tienes la respuesta.

El trabajo que hace por ti es que la audiencia vive en tres tablas distintas, una por disparador, con tres unidades distintas. Todo regresa en personas:

Disparador Fuente Una fila es
audience-list la audiencia de la campaña una persona
reactivate-reward la cola de reactivación un cliente
last-chance la cola de última oportunidad un card × campaña

Última oportunidad es la trampa: su cola va por el card que está por vencer, no por la persona, así que un cliente con tres cards por vencer genera tres filas. Contar filas ahí infla la audiencia a más del doble y parte a la mitad cualquier tasa construida encima. Este endpoint lo deduplica por ti.

Regresan dos números, y solo uno es denominador:

  • targeted — personas distintas dentro de cada campaña, sumadas. Es lo que empareja con recompensa otorgada, porque la recompensa también nace por (campaña, persona): quien está en dos campañas cuenta dos veces en ambos lados de la división.
  • clients — personas distintas en el disparador. Responde "a cuánta gente alcanzamos", y nunca debe volverse denominador.

Un disparador sin audiencia no aparece aquí, a propósito. form-submission y external-events nacen de un acto del cliente — nadie fue dirigido. Sumar sus recompensas a un denominador que no existe tumba la tasa sin motivo. meta.triggers dice qué está cubierto.

No existe el disparador birthday. Las campañas de cumpleaños existen, pero se arman como lista de audiencia y regresan en ese bucket.

Try-it values populated from environment ACME (Demo)


Autenticación

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.

Encabezados

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

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).

Respuestas

Relacionados

Copied to clipboard