Entrar

Relatório de associados / membros do programa

GET https://{organization}.myguper.com/api/register/report/members

Quem são os associados / membros de um programa de fidelidade, org-wide, numa única chamada — quantos são, a composição por tier e por origem, quantos já compraram e quanto valem ao longo da vida. A resposta para "quantos associados temos", "quantos membros viraram compradores", "qual a base de membros".

Genérico: parametrizado por tierConfig (programa de qualquer org). É register-only — montado de person_membership + person_tier + person_rfm, sem chamar o serviço de order. O total traz members (ativos), buyersLifetime, conversionLifetime e lifetimeValue; byTier, bySource e byMonth (crescimento) quebram.

Leia o lente com atenção:

  • conversionLifetime = membros que já compraram alguma vez (person_rfm) — é lifetime, NÃO conversão num período.
  • lifetimeValue = o gasto total na vida dos membros (bruto, todas as lojas). Valores em centavos. NÃO é faturamento de um período.
  • meta.membershipStartedAt = o 1º mês com adesão. Antes disso não há membro, então comparar "faturamento de associados" contra um período longo tem que ficar dentro da janela que tem membership.

Fora de propósito: faturamento de associados num período — isso é do serviço de order (total_order cortado por data), via order.report.sales e o snapshot order_personMembership (que só existe desde ~28/05/2026). Este relatório é a visão lifetime/estrutural da base de membros.

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

Name Type Description
tierConfig integer The program's `tier_config` id. Optional — defaults to the org's single active program; required (400) if the org has more than one. `400` if the org has no program.

Respostas

{
  "meta": {
    "tierConfig": 1, "program": "The program's name",
    "membershipStartedAt": "2026-03", "unit": "cents"
  },
  "total": {
    "members": 717, "buyersLifetime": 453, "conversionLifetime": 0.6318,
    "lifetimeValue": 130439911, "avgLifetimeValue": 181925
  },
  "byTier": [
    { "levelId": 1, "levelName": "Entry", "members": 618 },
    { "levelId": 2, "levelName": "Mid",   "members": 78 }
  ],
  "bySource": [
    { "source": "optin_hook", "members": 419 },
    { "source": "backfill",   "members": 298 }
  ],
  "byMonth": [
    { "month": "2026-03", "joined": 95, "left": 0, "activeEnd": 95 },
    { "month": "2026-04", "joined": 107, "left": 0, "activeEnd": 202 }
  ]
}

Relacionados

Copied to clipboard