> ## Documentation Index
> Fetch the complete documentation index at: https://unkey.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Unkey is two separate products. Compute builds, deploys, and runs apps behind a gateway. API Management issues API keys, enforces rate limits, manages identities and permissions, and reports usage. Say which product a page belongs to; a reader can use either without the other.
> Every Unkey API endpoint is an HTTP POST to https://api.unkey.com/v2/{service}.{procedure} with a root key in the Authorization: Bearer header. Root keys are workspace scoped.
> Error codes have the form err:{system}:{category}:{specific} and each has a page at /errors/{system}/{category}/{specific}.
> The word environment means production or preview in Compute. Rate limiting has four meanings on this site; the glossary lists them.

# unkey api analytics get-gateway-requests

> Run a SQL query against the gateway request logs of your workspace.

<Note>
  You need a root key with the permissions listed on this page. Create one in the dashboard under **Settings > Root Keys**. See [Permission reference](/docs/platform/root-keys/permissions-legacy) for every permission.
</Note>

Run a SQL query against the requests your gateway handled. Query the `gateway_requests_v1` table. CTEs, subqueries, `UNION`, and `EXCEPT` all work.

You only see data from the root key's workspace. To narrow it to one project, <Tooltip tip="A Compute app: a deployable service inside a project. Not your application in general.">app</Tooltip>, or <Tooltip tip="A production or preview environment of a Compute app, not the dashboard label on a key.">environment</Tooltip>, filter on `project_id`, `app_id`, or `environment_id`. Your plan's log query range limits how far back a query can reach, and analytics query quotas apply. See [Limits](/docs/platform/billing/limits).

## Usage

```bash theme={"system"}
unkey api analytics get-gateway-requests --query=<sql>
```

## Flags

<ParamField body="--query" type="string" required>
  SQL query to run against `gateway_requests_v1`.
</ParamField>

### Shared flags

Every `unkey api` command accepts these; [CLI output and shared flags](/docs/platform/cli/output-and-flags) describes them in full.

<ParamField body="--body" type="string">
  A JSON document sent as the request body instead of building it from the flags above. It is mutually exclusive with the request-building flags, and unknown fields are rejected locally. See [Send a raw body](/docs/platform/cli/output-and-flags#send-a-raw-body).
</ParamField>

<ParamField body="--root-key" type="string">
  Root key for the request. Falls back to `UNKEY_ROOT_KEY`, then to the config file written by `unkey auth login`. See [CLI authentication](/docs/platform/cli/authentication).
</ParamField>

<ParamField body="--api-url" type="string" default="https://api.unkey.com">
  Base URL of the API. Falls back to `UNKEY_API_BASE_URL`. You don't normally need to set it.
</ParamField>

<ParamField body="--config" type="string" default="~/.unkey/config.toml">
  Path of the TOML file that `unkey auth login` writes. Falls back to `UNKEY_CONFIG`.
</ParamField>

<ParamField body="--output" type="string">
  Output format. Falls back to `UNKEY_OUTPUT`. Set `json` to print the full response envelope (`meta` and `data`) for piping; any other value prints the request ID followed by `data`.
</ParamField>

## Required permissions

Your root key needs `project.*.read_gateway_requests`. A grant for one project, such as `project.<project_id>.read_gateway_requests`, doesn't work here.

Without a matching permission the API answers 403 and the CLI prints `Permission denied:` followed by the detail. See [Root key permissions](/docs/platform/root-keys/permissions) for the full catalog.

## Examples

Count requests per project:

```bash theme={"system"}
unkey api analytics get-gateway-requests --query="SELECT project_id, COUNT(*) AS total FROM gateway_requests_v1 GROUP BY project_id"
```

Recent requests of one environment:

```bash theme={"system"}
unkey api analytics get-gateway-requests --query="SELECT time, response_status, total_latency FROM gateway_requests_v1 WHERE environment_id = 'env_1234abcd' ORDER BY time DESC LIMIT 100"
```

Send the request body as JSON:

```bash theme={"system"}
unkey api analytics get-gateway-requests --body='{"query":"SELECT COUNT(*) AS total FROM gateway_requests_v1"}' --output=json
```

## API endpoint

The command calls [`POST /v2/analytics.getGatewayRequests`](/docs/compute/api-reference/analytics/query-gateway-request-data) and prints its response. The request fields carry the same names as the flags in camelCase, which is the shape `--body` expects.

## Related

<Columns cols={1}>
  <Card title="Analytics tables" href="/docs/compute/observe/analytics-api">
    Column reference for gateway request and runtime log analytics.
  </Card>
</Columns>