get_summary
Retrieve median, margin of error, count, p95, and p98 for any RUM timer on a given day, with optional filters to drill down by browser, country, or device.
Instructions
Aggregate summary stats for one timer (median, margin-of-error, count, p95, p98).
mPulse query-type: summary. Data is per-minute aggregated over a single
calendar day in the given timezone (default UTC).
Time selection (exactly one required):
date— a single calendar day,YYYY-MM-DD.date_comparator— a relative window, e.g.Last24Hours,LastHour. A date range is not supported per call; split it into per-day calls.
Timer: timer (built-in, default PageLoad) OR custom_timer (a custom
timer name). percentile is 1–99 (default 50).
Drilldowns filter the data (e.g. page_group, browser, country,
device_type, ab_test). Unsupported combinations return empty data with a
note rather than an error.
Set raw=True to get mPulse's untouched JSON. Numeric values are never
rounded or summarized.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| os | No | ||
| app | No | ||
| raw | No | ||
| date | No | ||
| timer | No | ||
| region | No | ||
| ab_test | No | ||
| browser | No | ||
| country | No | ||
| timezone | No | ||
| page_group | No | ||
| percentile | No | ||
| beacon_type | No | ||
| device_type | No | ||
| custom_timer | No | ||
| browser_family | No | ||
| connection_type | No | ||
| date_comparator | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||