You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys. See Permission reference for every permission.
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, , or , 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.
Usage
Flags
string
required
SQL query to run against
gateway_requests_v1.Shared flags
Everyunkey api command accepts these; CLI output and shared flags describes them in full.
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.
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.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.string
default:"~/.unkey/config.toml"
Path of the TOML file that
unkey auth login writes. Falls back to UNKEY_CONFIG.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.Required permissions
Your root key needsproject.*.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 for the full catalog.
Examples
Count requests per project:API endpoint
The command callsPOST /v2/analytics.getGatewayRequests and prints its response. The request fields carry the same names as the flags in camelCase, which is the shape --body expects.
Related
Analytics tables
Column reference for gateway request and runtime log analytics.