Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
http_referer | Optional[str] | :heavy_minus_sign: | The app identifier should be your app’s URL and is used as the primary identifier for rankings. This is used to track API usage per application. | |
x_open_router_title | Optional[str] | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter’s dashboard. | |
x_open_router_categories | Optional[str] | :heavy_minus_sign: | Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings. | |
date_ | Optional[str] | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 |
api_key_hash | Optional[str] | :heavy_minus_sign: | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456… |
user_id | Optional[str] | :heavy_minus_sign: | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 |
group_by | Optional[operations.GroupBy] | :heavy_minus_sign: | Set to ‘workspace’ to split each row per workspace and include workspace_id on every item. Omitted by default, in which case rows are aggregated across workspaces (by date, model, and endpoint) and workspace_id is not returned — preserving the historical response shape. | workspace |
workspace_id | Optional[str] | :heavy_minus_sign: | Filter by workspace ID (UUID). Returns only activity attributed to that workspace. The workspace must belong to the authenticated account. | 550e8400-e29b-41d4-a716-446655440000 |