get_experience_overview
Get a Roblox experience's health snapshot: key engagement and monetization metrics compared with the prior period to flag significant shifts.
Instructions
One-call health check for an experience. Pulls the headline KPIs — DAU, MAU, stickiness, visits, peak CCU, session length, playtime, D1/D7/D30 retention, revenue, ARPU, ARPPU, paying users and conversion — for a period, compares each against the immediately preceding period of equal length, and flags the ones that moved sharply.
Start here when asked how a game is doing, then drill in with breakdown_metric_by_segments or get_metric_report.
Each KPI reports how it was aggregated: api-period-total values come from a whole-period query, so user counts are distinct users rather than summed daily figures. This issues roughly two queries per metric against a 30-per-minute budget, so a full comparison run takes about a minute.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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. | |
| metrics | No | Override the KPI set. Defaults to: DailyActiveUsers, MonthlyActiveUsers, DauMauStickiness, UniqueUsersWithPlaySessions, Visits, PeakConcurrentPlayers, AverageSessionLengthMinutes, AveragePlayTimeMinutesPerDAU, TotalPlayTimeHours, ForwardD1Retention, ForwardD7Retention, ForwardD30Retention, DailyRevenue, AverageRevenuePerUser, AverageRevenuePerPayingUser, PayingUsers, PayingUsersCVR. | |
| lastDays | No | Shorthand for the last N complete UTC days. Cannot be combined with startTime. | |
| 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. | |
| includeDailySeries | No | Also return the daily time series per KPI. Adds one query per metric. | |
| compareToPreviousPeriod | No | Compare against the preceding equal-length window. Default true. Doubles query count. |