Entrar

Relatório de tempo até o resgate do cashback: dias ou semanas até usar o saldo (distribuição, mediana, p90)

GET https://{organization}.myguper.com/api/loyalty/report/redemption-latency/{dateStart}/{dateEnd}

Distribuição do tempo até o card de cashback ser resgatado — quantos usos de card aconteceram no primeiro dia, no segundo dia e assim por diante (ou por semana). É a distribuição, não a média: a média esconde justamente o que interessa, que é a concentração nos primeiros dias contra a cauda perto do vencimento. median e p90 saem da mesma distribuição.

basis diz de onde o relógio começa:

  • available (padrão): quando o card ficou utilizável (startsAt, depois da carência da campanha). Use para calibrar a vigência.
  • issued: quando o card foi emitido. Inclui a carência.

Os buckets são períodos completos (24 horas ou 7 dias) entre a base e o débito do checkout; o bucket 0 é o primeiro dia/semana. Só contam resgates liquidados. A granularidade é o uso de card: um resgate que usou dois cards conta duas latências (uses); redemptions é a contagem de resgates distintos no bucket. share é uses / total (razão).

Mesmos filtros do loyalty.report.redemptions: cohort (redemption = débitos no período, padrão; issuance = cards emitidos no período), campaign (lista), originStore, redeemStore. Valores em centavos.

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
buckets string Bucket size. Default `day`.
basis string Where the clock starts: card availability (default) or card issuance.
cohort string Which date the period applies to. `redemption` (default) or `issuance`.
campaign string Only cards of these campaigns. Array or comma list; up to 200 ids.
originStore integer Only cards issued by this store.
redeemStore integer Only redemptions made in this store.
rewardType string Which wallet. Default `monetary`.

Respostas

{
  "meta": { "unit": "days", "basis": "cardAvailableAt", "cohort": "issuance", "timezone": "Etc/GMT+6" },
  "total": 767,
  "median": 2,
  "p90": 8,
  "rows": [
    { "bucket": 0, "uses": 172, "redemptions": 166, "redeemedValue": 7788667, "share": 0.2243 },
    { "bucket": 1, "uses": 121, "redemptions": 117, "redeemedValue": 4434159, "share": 0.1578 },
    { "bucket": 2, "uses": 100, "redemptions": 100, "redeemedValue": 3856692, "share": 0.1304 }
  ]
}

Relacionados

Copied to clipboard