breakdown_metric_by_segments
Slice a metric across all supported dimensions to identify underperforming segments, flagging values that deviate significantly from the overall average.
Instructions
Slice one metric by every dimension it supports — platform, country, age group, new vs returning, payer status, device, locale, place version, and so on — in a single call, ranked within each dimension.
This is the fastest way to answer 'who is this bad for?'. A crash rate or retention figure that looks acceptable overall is often far worse on one platform or in one country, and this surfaces that without guessing which dimension to try. For rate-like metrics it flags segments running at least 1.5x or at most 0.67x the overall value.
Costs one query per dimension, so restrict dimensions if you only care about a few.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter | No | Narrow results to specific dimension values. | |
| metric | Yes | Exact, case-sensitive metric name. | |
| 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. | |
| 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). | |
| dimensions | No | Dimensions to slice by. Defaults to every dimension the metric supports. | |
| 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. | |
| limitPerDimension | No | Cap segments per dimension, ranked by value. Useful for Country and ProductKey. |