Waitlist API reference

Waitlist API · Analytics

get/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/analyticsAuth

Aggregate counts, viral coefficient, top referrers + referrals

Test entries ("Add test signup") are left out unless `include_test=true`.

Path parameters

workspace_id*string · uuid

Id of the workspace.

waitlist_id*string · uuid

Id of the waitlist.

Query parameters

include_testboolean

Count test entries ("Add test signup") too. Default `false`: they are left out.

Response · 200 Aggregated analytics payload for the waitlist.

waitlist_id*string · uuid

The waitlist.

total_entries*integer

All entries (test entries only with `include_test=true`).

by_status*object

Entry counts keyed by status (`pending` / `approved` / `rejected`).

Example: {"pending":12,"approved":40,"rejected":3}

signups_today*integer

Sign-ups since 00:00 UTC today.

signups_this_week*integer

Sign-ups in the last 7 days.

signups_this_month*integer

Sign-ups in the last 30 days.

viral_coefficient*number

referrals / total_entries — the K-factor proxy. 0 when no entries.

referred_count*integer

Entries that signed up with a referral code.

top_referrers*array

Most common `referrer` values, most first.

top_referrals*array

Entries with the most honoured referrals, most first.

Example

Request

GET https://api.waitlist.productcraft.co/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/analytics
Authorization: Bearer YOUR_TOKEN

Response

{
  "waitlist_id": "00000000-0000-0000-0000-000000000000",
  "total_entries": 0,
  "by_status": {
    "pending": 12,
    "approved": 40,
    "rejected": 3
  },
  "signups_today": 0,
  "signups_this_week": 0,
  "signups_this_month": 0,
  "viral_coefficient": 0,
  "referred_count": 0,
  "top_referrers": [
    {
      "referrer": "string",
      "count": 0
    }
  ],
  "top_referrals": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "string",
      "name": "string",
      "referral_code": "string",
      "referral_count": 0,
      "position": 0,
      "effective_position": 0
    }
  ]
}