Entrar

RFM por safra de aquisição — novos clientes / cadastros por dia (cohort)

GET https://{organization}.myguper.com/api/register/report/rfm-cohort/{dateStart}/{dateEnd}

RFM dos clientes agregado por safra de aquisição — quantos clientes foram adquiridos em cada mês (ou em cada loja) e quanto valem ao longo da vida — numa única chamada. É a base de RFM, agrupada: em vez de paginar centenas de milhares de linhas por-cliente e agrupar no cliente, devolve o rollup da safra de uma vez.

A safra é cortada pela data da 1ª compra (firstPurchaseDate). Agrupe por month (mês de aquisição), firstStore (loja de aquisição), ou os dois. Por safra você tem clients, lifetimeValue e avgValue (gasto), avgOrders (frequência), avgCadenceDays (intervalo de recompra, só entre clientes com 2+ compras) e avgDaysWithoutPurchase (recência hoje).

Valores em centavos. O mês é cortado no fuso da organização, então as safras batem com o relatório de vendas por (mês, loja). O total reconcilia com a soma das linhas por construção.

Leia a semântica com atenção: loja é a loja de aquisição e lifetimeValue é o gasto lifetime org-wide do cliente (em todas as lojas), não as vendas da loja — "clientes adquiridos na loja X e quanto gastaram no total". Para vendas por loja use order.report.sales; não misture.

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 do caminho

Name Type Description
dateStart * string Start of the acquisition window (YYYY-MM-DD), inclusive — customers whose first purchase falls on/after this date.
dateEnd * string End of the acquisition window (YYYY-MM-DD), inclusive.

Parâmetros de query

Name Type Description
groupBy string How to break the cohorts down. One of `month` (acquisition month), `firstStore` (acquisition store), or a comma list. Default: `month`.

Respostas

{
  "meta": {
    "unit": "cents", "timezone": "Etc/GMT+6",
    "groupBy": ["month"],
    "window": { "dateStart": "2025-01-01", "dateEnd": "2025-06-30" }
  },
  "rows": [
    { "month": "2025-01", "clients": 16131, "lifetimeValue": 4676422124, "avgValue": 289903,
      "avgOrders": 1.50, "avgCadenceDays": 98.1, "avgDaysWithoutPurchase": 435 },
    { "month": "2025-02", "clients": 8890, "lifetimeValue": 2766238779, "avgValue": 311163,
      "avgOrders": 1.49, "avgCadenceDays": 94.2, "avgDaysWithoutPurchase": 410 }
  ],
  "total": {
    "clients": 74775, "lifetimeValue": 24488794816, "avgValue": 327500,
    "avgOrders": 2.49, "avgCadenceDays": 78, "avgDaysWithoutPurchase": 366
  }
}

Relacionados

Copied to clipboard