Entrar

Reporte de asociados / miembros del programa

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

Quiénes son los asociados / miembros de un programa de lealtad, org-wide, en una sola llamada — cuántos son, la composición por tier y por origen, cuántos ya compraron y cuánto valen a lo largo de su vida. La respuesta a "cuántos asociados tenemos", "cuántos miembros se convirtieron en compradores", "cuál es la base de miembros".

Genérico: parametrizado por tierConfig (programa de cualquier org). Es register-only — armado de person_membership + person_tier + person_rfm, sin llamar al servicio de order. El total trae members (activos), buyersLifetime, conversionLifetime y lifetimeValue; byTier, bySource y byMonth (crecimiento) desglosan.

Lee el lente con atención:

  • conversionLifetime = miembros que ya compraron alguna vez (person_rfm) — es lifetime, NO conversión en un período.
  • lifetimeValue = el gasto total en la vida de los miembros (bruto, todas las tiendas). Valores en centavos. NO es facturación de un período.
  • meta.membershipStartedAt = el 1er mes con alta. Antes de eso no hay miembros, así que comparar "facturación de asociados" contra un período largo debe quedarse dentro de la ventana que tiene membership.

Fuera de propósito: facturación de asociados en un período — eso es del servicio de order (total_order cortado por fecha), vía order.report.sales y el snapshot order_personMembership (que solo existe desde ~28/05/2026). Este reporte es la vista lifetime/estructural de la base de miembros.

Try-it values populated from environment ACME (Demo)


Autenticación

Token

Send your user token in the x-guper-authorization header.

Encabezados

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.

Respuestas

{
  "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