overview

Get Overview Cohort Event Rate

Per-bucket treated/control event-rate counts, bucketed by granularity (daily/weekly — the same window controls as the lift line chart). audience picks the population: new_signups (default) rows the signup cohorts created within the last window_days (per-cohort n); everyone rows the whole current base by activity day over the same window, each arm's n its constant census. outcome_id is an event_definition_id. measure selects the event value plotted per bar (a value measure → value_sum / n; the boolean default → the did / n conversion share) so the chart follows the same toggle as the header. percentile_p (value measures only) swaps each bar's value for the cell's percentile_cont(percentile_p) — the Rank statistic. Rate-limited per (org, user); the Overview drives it on mount and on outcome/window change.

get/overview/cohort-event-rate

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/cohort-event-rate
  • 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
granularity'minutely' | 'hourly' | 'daily' | 'weekly' | 'monthly' required
audience'new_signups' | 'everyone'

Which population the cohort-event-rate grid measures.

new_signups keeps the signup-cohort semantics — each row a signup bucket, n the cohort size. everyone measures the whole current base by activity day — each row an activity bucket, n the arm's constant census.

measure'value_sum' | 'converted_contacts' | 'average' | 'average_per_member'
contacted_window_daysinteger nullable
percentile_pnumber nullable
region_idstring uuid nullable

Headers

X-Viewer-Timezonestring nullable

Response

Successful Response

not_yet_enabledboolean required

Changes

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