Away 10:08 PM

2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

AnalyticsQueryPublicApi.QueryRequest — openapi

A request to query time series metric data.

Properties

NameTypeRequiredDescription
metricstringtrueThe metric to query.
granularity#/components/schemas/AnalyticsQueryPublicApi.MetricGranularitytrue
startTimestringtrueThe inclusive start of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
endTimestringtrueThe exclusive end of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
breakdownarrayfalseThe dimensions to group results by. Each entry is a single dimension name.
filterarrayfalseFilters to apply to the query.
limitintegerfalseThe maximum number of breakdown series to return.

Complete Schema

{
  "required": [
    "endTime",
    "granularity",
    "metric",
    "startTime"
  ],
  "type": "object",
  "properties": {
    "metric": {
      "type": "string",
      "description": "The metric to query."
    },
    "granularity": {
      "$ref": "#/components/schemas/AnalyticsQueryPublicApi.MetricGranularity"
    },
    "startTime": {
      "type": "string",
      "description": "The inclusive start of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.",
      "format": "date-time"
    },
    "endTime": {
      "type": "string",
      "description": "The exclusive end of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.",
      "format": "date-time"
    },
    "breakdown": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The dimensions to group results by. Each entry is a single dimension name."
    },
    "filter": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AnalyticsQueryPublicApi.QueryFilter"
      },
      "description": "Filters to apply to the query."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of breakdown series to return.",
      "format": "int32"
    }
  },
  "additionalProperties": false,
  "description": "A request to query time series metric data."
}