Sign in

Program members / associates report

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

Who the members / associates of a loyalty program are, org-wide, in a single call — how many there are, their tier and source mix, how many have ever bought, and what they are worth over their lifetime. The answer to "how many associates do we have", "how many members converted into buyers", "what is the member base".

Generic: parameterized by tierConfig (any org's program). It is register-only — built from person_membership + person_tier + person_rfm, no call to the order service. total carries members (active), buyersLifetime, conversionLifetime and lifetimeValue; byTier, bySource and byMonth (member growth) break it down.

Read the lens carefully:

  • conversionLifetime = members who have ever bought (person_rfm) — it is lifetime, NOT conversion in a period.
  • lifetimeValue = the members' total lifetime spend (gross, all stores). Values in cents. It is not revenue in a period.
  • meta.membershipStartedAt = the first month with a join. Before that there are no members, so comparing "revenue from members" against a long period must stay inside the window that has membership.

Not here on purpose: revenue from members in a period — that belongs to the order service (total_order cut by date), via order.report.sales and the order_personMembership snapshot (which exists only from ~2026-05-28). This report is the lifetime/structural view of the member base.

Try-it values populated from environment ACME (Demo)


Authentication

Token

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

Headers

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.

Query parameters

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.

Responses

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

Related

Copied to clipboard