ROroblox
Analytics

Queries dimension values for a universe.

Changed on

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}/dimension-values

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/analytics-query-api/v1/universes/{universeId}/dimension-values
  • 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 universe ID to query dimension values for.

Request body

metricstring required

The metric that provides context for resolving dimension namespaces.

dimensionsstring[]

The dimensions to retrieve values for. Each entry is a single dimension name.

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.

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

The time granularity of metric data points in a query.

limitinteger

The maximum number of values to return per dimension.

Response

OK

pathstring nullable

The server-assigned resource path.

doneboolean

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

Changes