latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs
signup

Signup Ops Analytics

get/api/v1/admin/signup/ops/analytics

Query parameters

date_fromstring date nullable

Inclusive start date (UTC). Omit for no lower bound on signup created_at.

Inclusive start date (UTC). Omit for no lower bound on signup created_at.

date_tostring date nullable

Inclusive end calendar day (UTC). Omit to use current time as the upper bound.

Inclusive end calendar day (UTC). Omit to use current time as the upper bound.

bucketstring

day, week, or month

day, week, or month

statusesstring[] nullable

Filter by one or more signup statuses

Filter by one or more signup statuses

selected_plan_idsstring[] nullable

Filter by one or more plan ids

Filter by one or more plan ids

importancesstring[] nullable

Filter by one or more importance values

Filter by one or more importance values

tracking_statusesstring[] nullable

Filter by one or more tracking statuses

Filter by one or more tracking statuses

subscription_periodsstring[] nullable

Filter by one or more billing cycles

Filter by one or more billing cycles

plan_subscription_pairsstring[] nullable

Filter by plan + billing cycle pairs (OR). Each value is plan_id:period (e.g. professional:monthly). When set, selected_plan_ids and subscription_periods are ignored.

Filter by plan + billing cycle pairs (OR). Each value is plan_id:period (e.g. professional:monthly). When set, selected_plan_ids and subscription_periods are ignored.

verification_failure_anyboolean nullable

If true, restrict to signups with at least one email_verification_failed event.

If true, restrict to signups with at least one email_verification_failed event.

verification_error_codesstring[] nullable

Restrict to signups whose latest email_verification_failed error_code is one of these (OR). Repeat query param.

Restrict to signups whose latest email_verification_failed error_code is one of these (OR). Repeat query param.

incomplete_segmentsstring[] nullable

Restrict analytics to incomplete buckets matching the Signup Lifecycle chart: users_stuck (non-completed with verification/payment/provisioning failure events), users_opted_out (non-completed without those). Omit or pass both for all non-completed.

Restrict analytics to incomplete buckets matching the Signup Lifecycle chart: users_stuck (non-completed with verification/payment/provisioning failure events), users_opted_out (non-completed without those). Omit or pass both for all non-completed.

exclude_internalboolean

When true (default), omit signups whose email domain is in internal_email_domains or contains internal_email_domain_substring in the domain (see /signup/ops/meta).

When true (default), omit signups whose email domain is in internal_email_domains or contains internal_email_domain_substring in the domain (see /signup/ops/meta).

Response

Successful Response

bucketstring