/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/analyticsAuthAggregate counts, viral coefficient, top referrers + referrals
Test entries ("Add test signup") are left out unless `include_test=true`.
Path parameters
workspace_id*string · uuidId of the workspace.
waitlist_id*string · uuidId of the waitlist.
Query parameters
include_testbooleanCount test entries ("Add test signup") too. Default `false`: they are left out.
Response · 200 Aggregated analytics payload for the waitlist.
waitlist_id*string · uuidThe waitlist.
total_entries*integerAll entries (test entries only with `include_test=true`).
by_status*objectEntry counts keyed by status (`pending` / `approved` / `rejected` / `unconfirmed`). `unconfirmed` sign-ups are not in any other figure until they confirm.
Example: {"pending":12,"approved":40,"rejected":3,"unconfirmed":2}
signups_today*integerSign-ups since 00:00 UTC today.
signups_this_week*integerSign-ups in the last 7 days.
signups_this_month*integerSign-ups in the last 30 days.
viral_coefficient*numberreferrals / total_entries — the K-factor proxy. 0 when no entries.
referred_count*integerEntries that signed up with a referral code.
top_referrers*arrayMost common `referrer` values, most first.
top_referrals*arrayEntries 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_TOKENimport { Waitlist } from "@productcraft/waitlist";
// Reads PRODUCTCRAFT_API_KEY from the environment
const waitlist = new Waitlist();
const waitlistAnalytics = await waitlist.lists.analytics.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");waitlist.lists.analytics.retrieve(waitlistId, params?, options?): Waitlist.WaitlistAnalytics
Response
{
"waitlist_id": "00000000-0000-0000-0000-000000000000",
"total_entries": 0,
"by_status": {
"pending": 12,
"approved": 40,
"rejected": 3,
"unconfirmed": 2
},
"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
}
]
}