query_metric
Query any Roblox experience analytics metric as a time series. Get summary stats, breakdowns, filters, and outlier detection for retention, engagement, and monetization.
Instructions
Query one analytics metric as a time series. This is the core read tool — everything the Analytics Query API exposes is reachable through it.
Returns, per series: summary statistics (first, last, min, max, mean, median, stdDev, sum, percent change, trend per bucket), outlier buckets beyond 2.5 standard deviations, any buckets the API returned no data for, and the raw data points.
Use breakdown to split into one series per dimension value, and filter to narrow the population. The request is validated against the metric's documented capabilities before it is sent, so mistakes come back as a clear message rather than an opaque 400.
Note aggregationHint: for rates, averages, and percentiles the sum of buckets is not a meaningful number — read mean instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Cap on breakdown series, ranked by value. Only valid with granularity 'None' and a breakdown — the documented way to find the top N segments. | |
| filter | No | Narrow results to specific dimension values. | |
| metric | Yes | Exact, case-sensitive metric name. Use list_metrics to find one. | |
| endTime | No | Exclusive end. Defaults to today's UTC midnight so only complete buckets are returned — pass 'now' if you want the partial current day included. | |
| lastDays | No | Shorthand for the last N complete UTC days. Cannot be combined with startTime. | |
| breakdown | No | Dimensions to split by, one series per value, e.g. ['Platform']. Must be supported by the metric — see describe_metric. | |
| startTime | No | Inclusive start. RFC 3339 (2026-01-01T00:00:00Z), a date (2026-01-01), or relative (-30d, -12w, -6mo, -2y, -48h, today, yesterday). | |
| universeId | No | Roblox universe (experience) ID, or a saved alias. Optional when a default universe is configured — use get_server_status to check, or find_universes to look one up. | |
| granularity | No | Time bucket size. Defaults to OneDay, or the metric's coarsest supported option when it has no daily bucket. | |
| maxDataPoints | No | Cap on data points returned per series (most recent kept). Default 400. | |
| skipValidation | No | Send the request even if it fails local validation. Use only if you believe the API supports something the bundled catalog does not list. | |
| includeDataPoints | No | Include raw per-bucket values. Default true. Turn off for a summary-only view. |