---
title: "Queries time series metric data for a universe."
method: POST
path: "/analytics-query-api/v1/universes/{universeId}/metrics"
tags: ["Analytics"]
---

# Queries time series metric data for a universe.

`POST /analytics-query-api/v1/universes/{universeId}/metrics`

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

## Path parameters

- `universeId` integer, required

## Request body

- AnalyticsQueryPublicApiQueryRequest — A request to query time series metric data.
  - `metric` string, required — The metric to query.
  - `granularity` 'OneMinute' | 'HalfHour' | 'OneHour' | 'OneDay' | 'OneWeek' | 'OneMonth' | 'None', required — The time granularity of metric data points in a query.
  - `startTime` string, date-time, required — The inclusive start of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
  - `endTime` string, date-time, required — The exclusive end of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
  - `breakdown` string[] — The dimensions to group results by. Each entry is a single dimension name.
  - `filter` AnalyticsQueryPublicApiQueryFilter[] — Filters to apply to the query.
    - `dimension` string, required — The dimension name to filter on.
    - `values` string[] — The values to filter by.
    - `operation` 'In' | 'NotIn' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'Match', required — The operation to apply to a query filter.
  - `limit` integer — The maximum number of breakdown series to return.

## Response `200`

OK

- QueryOperationResult — A completed long-running query operation with results.
  - `path` string, nullable — The server-assigned resource path.
  - `done` boolean — If false, the operation is still in progress. If true, the operation is completed.
  - `response` AnalyticsQueryPublicApiQueryResponse — The response for a metric query.
    - `values` AnalyticsQueryPublicApiMetricValue[] — The metric values returned by the query.
      - `breakdowns` AnalyticsQueryPublicApiBreakdownValue[] — The breakdown values for this series.
        - `dimension` string, required — The dimension name.
        - `value` string, required — The dimension value.
        - `displayValue` string, nullable — A human-readable display value when the dimension is a unique ID.
      - `dataPoints` AnalyticsQueryPublicApiDataPoint[] — The data points for this series.
        - `time` string, date-time, required — The timestamp of the data point in UTC.
        - `value` number, double, required — The numeric value of the data point.
        - `stringValues` string[], nullable — String values associated with the data point, when applicable.
        - `status` 'Valid' | 'Projected' | 'NotStatisticallySignificant' — The status of a data point in a query result.
  - `metadata` AnalyticsQueryPublicApiOperationMetadata — The metadata associated with a long-running operation.
    - `createdTime` string, date-time, nullable — The time the operation was created.

## Other responses

- `202` — Accepted
- `400` — Bad Request
- `403` — Forbidden
- `429` — Too Many Requests
- `500` — Internal Server Error
- `503` — Service Unavailable
- `504` — Gateway Timeout

---

[API](https://skmtc.net/roblox/apis/roblox-api.md) · [All operations](https://skmtc.net/roblox/apis/roblox-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/roblox/roblox-api/revisions/958b2b40425d/schema)