overview

Get Overview Distribution

Per-arm value-by-percentile curves of a measured event, pooled across cohorts. outcome_id is an event_definition_id (event outcomes only — conversions have no value distribution); each contact's SUM(events.value) over the last window_days (0 when it fired nothing) is sampled at a shared set of percentiles so the Polymorph (treated) and Global-control curves overlay on one axis. Presence-only definitions (PostHog, count-only Supabase configs) are rejected with a 400. Rate-limited per (org, user); the Overview drives it when a card switches to the distribution view mode.

get/overview/distribution

Request

  • Base URL: https://api.usepolymorph.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.usepolymorph.com/overview/distribution
  • Auth: none declared

Query parameters

kind'event' | 'conversion' required

The two outcome kinds pinned on the Overview lift strip.

Values match the kind discriminator literal on :data:OutcomeSpec (Pydantic discriminated unions require a Literal); this enum is the typed form the cohort-rate route's query param uses instead of a bare string.

outcome_idstring uuid required
window_daysinteger required

Response

Successful Response

percentilesnumber[] required
treatednumber[] required
controlnumber[] required
treated_ninteger
control_ninteger

Changes

No recorded changes to this operation across all 1 revision of this API.