Sign in

v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB
Analytics

Queries time series metric data for a universe.

See the <a href="https://create.roblox.com/docs/cloud/guides/analytics">Analytics guide</a> for more information.

post/analytics-query-api/v1/universes/{universeId}/metrics

Path parameters

universeIdinteger required

The universe ID to query metrics for.

Request body

metricstring required

The metric to query.

granularity'OneMinute' | 'HalfHour' | 'OneHour' | 'OneDay' | 'OneWeek' | 'OneMonth' | 'None' required

The time granularity of metric data points in a query.

startTimestring date-time required

The inclusive start of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.

endTimestring date-time required

The exclusive end of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.

breakdownstring[]

The dimensions to group results by. Each entry is a single dimension name.

limitinteger

The maximum number of breakdown series to return.

Response

OK

pathstring nullable

The server-assigned resource path.

doneboolean

If false, the operation is still in progress. If true, the operation is completed.