Signup Ops Analytics

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

Request

Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
URL: https://carbonarc.ai/api/v1/admin/signup/ops/analytics
Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Query parameters

date_fromstring date nullable

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.

bucketstring

day, week, or month

statusesstring[] nullable

Filter by one or more signup statuses

selected_plan_idsstring[] nullable

Filter by one or more plan ids

importancesstring[] nullable

Filter by one or more importance values

tracking_statusesstring[] nullable

Filter by one or more tracking statuses

subscription_periodsstring[] nullable

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.

verification_failure_anyboolean nullable

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.

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.

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).

Response

Successful Response

bucketstring

Changes

No recorded changes to this operation across all 4 revisions of this API.