---
title: "Query rate limit data"
method: POST
path: "/v2/analytics.getRatelimits"
tags: ["analytics"]
---

# Query rate limit data

`POST /v2/analytics.getRatelimits`

Queries may reference only the five public rate limit analytics aliases: `ratelimits_v1`, `ratelimits_per_minute_v1`, `ratelimits_per_hour_v1`, `ratelimits_per_day_v1`, or `ratelimits_per_month_v1`. CTEs, subqueries, UNION, and EXCEPT are supported.
Queries are always restricted to the authenticated workspace. Wildcard analytics permission can read every namespace in that workspace; namespace-scoped permissions automatically restrict results to the permitted namespace IDs.
Workspace retention and query limits apply.

## Request body

- V2AnalyticsGetRatelimitsRequestBody
  - `query` string, required — SQL query to execute against your rate limit analytics data. Queries may reference only the five public aliases: `ratelimits_v1`, `ratelimits_per_minute_v1`, `ratelimits_per_hour_v1`, `ratelimits_per_day_v1`, or `ratelimits_per_month_v1`. Physical `default.*` table names are unsupported. CTEs, subqueries, UNION, and EXCEPT are supported. Queries are always restricted to the authenticated workspace. Wildcard analytics permission can read every namespace in that workspace; namespace-scoped permissions automatically restrict results to the permitted namespace IDs. Workspace retention and query limits apply.

## Response `200`

Query executed successfully

- V2AnalyticsGetRatelimitsResponseBody
  - `meta` Meta, required — Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
    - `requestId` string, required — A unique id for this request. Always include this ID when contacting support about a specific API request. This identifier allows Unkey's support team to trace the exact request through logs and diagnostic systems to provide faster assistance.
  - `data` object[], required — Array of rate limit rows returned by the query. Fields vary based on the SQL SELECT clause.

## Other responses

- `400` — Invalid SQL query, blocked operation, or missing required authentication
- `401` — Invalid authentication credentials
- `403` — Insufficient permissions
- `412` — Analytics is not configured for the workspace
- `422` — Query exceeds workspace query limits
- `429` — Query quota exceeded
- `500` — Query execution failed
- `503` — Connection to the database failed

---

[API](https://skmtc.net/unkeyed/apis/unkey-api.md) · [All operations](https://skmtc.net/unkeyed/apis/unkey-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unkeyed/unkey-api/versions/fa78aafac89c/schema)