ROroblox
Analytics

Returns daily benchmark percentiles for a metric, comparing a universe against other experiences on Roblox.

Changed on

See Analytics Guide for more information.

post/analytics-benchmark/v1/universes/{universeId}/benchmarks

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/analytics-benchmark/v1/universes/{universeId}/benchmarks
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: universe.analytics:read

Path parameters

universeIdinteger required

The ID of the universe to compare against benchmarks.

Request body

metricstring

The metric to benchmark, such as ForwardD1Retention, using the same metric names as the Analytics Query API. Metrics without benchmark data return no data points.

startTimestring

The start of the date range, inclusive. Required. Each benchmark value has a midnight UTC date, so a start time later in the day excludes that day.

endTimestring

The end of the date range, inclusive. Required. For /v1/universes/{universe_id}/benchmarks, it must not be earlier than start_time, and must be at most 400 days after it.

benchmarkType'BENCHMARK_TYPE_INVALID' | 'BENCHMARK_TYPE_GENRE' | 'BENCHMARK_TYPE_SIMILARITY' | 'BENCHMARK_TYPE_TOP_EXPERIENCES' string

BenchmarkType is to store the type of benchmark. BENCHMARK_TYPE_SIMILARITY compares against experiences with similar players. BENCHMARK_TYPE_GENRE compares against experiences in the same genre, or against all experiences when the universe has no genre or its genre doesn't qualify for genre benchmarks. BENCHMARK_TYPE_TOP_EXPERIENCES compares against the top experiences on Roblox, and is the only type for DailyActiveUsers, DailyRevenue, MonthlyActiveUsers, PayingUsers, TotalPlayTimeHours, UniqueAbuseReportSubmittersPer1000PlaytimeHours, and Visits.

percentilesinteger[]

The percentiles to return, each between 0 and 100, with at most 10 values. Defaults to 50 and 90, or 10 and 50 when lower values are favorable. Percentiles without benchmark data return no data points. Ignored for BENCHMARK_TYPE_TOP_EXPERIENCES benchmarks, which return a single percentile chosen from the universe's own average over the last 30 days, or a fixed percentile for some metrics.

benchmarkVariantIdstring

The metric variant to benchmark. The only supported value is l7_average, which benchmarks the 7-day rolling average of metric. Not every metric has this variant, and the API rejects requests for metrics without it. Omit to benchmark metric itself.

Response

OK

availableTypesBenchmarkType[]

The benchmark types available for this universe and metric. Request one with benchmark_type.

objective'BENCHMARK_OBJECTIVE_INVALID' | 'BENCHMARK_OBJECTIVE_MAXIMIZE' | 'BENCHMARK_OBJECTIVE_MINIMIZE' string

BenchmarkObjective describes which direction is favorable for a metric.

Changes