Return per-user request and cost analytics for a required time range. This is usage-by-user, not population metrics; use get_users_analytics for active-user or cohort trends. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.
AI agents call get_user_stats to retrieve information from Portkey Admin without modifying anything — typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.
| Parameter | Type | Required | Description |
|---|---|---|---|
cost_max | number | — | Maximum cost in cents to filter by |
cost_min | number | — | Minimum cost in cents to filter by |
page_size | number | — | Number of results per page (for pagination) |
status_code | string | — | Filter by specific HTTP status codes (comma-separated) |
virtual_keys | string | — | Filter by specific virtual key slugs (comma-separated) |
total_units_max | number | — | Maximum number of total tokens to filter by |
total_units_min | number | — | Minimum number of total tokens to filter by |
time_of_generation_max | string | Yes | End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z') |
time_of_generation_min | string | Yes | Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z') |
Parameters from the server's own tool schema.
Even though get_user_stats only reads data, uncontrolled read access leaks sensitive information and racks up API costs — an agent caught in a retry loop can make thousands of calls a minute without anyone noticing.
Attacks that exploit this kind of access
Return per-user request and cost analytics for a required time range. This is usage-by-user, not population metrics; use get_users_analytics for active-user or cohort trends. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans. It is categorised as a Read tool in the Portkey Admin MCP Server, which means it retrieves data without modifying state.
get_user_stats accepts 9 parameters: cost_max, cost_min, page_size, status_code, virtual_keys, total_units_max, total_units_min, time_of_generation_max, time_of_generation_min. Required: time_of_generation_max, time_of_generation_min. The full parameter table on this page comes from the server's own tool schema.
Register the Portkey Admin MCP server in PolicyLayer and add a rule for get_user_stats: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Portkey Admin. Nothing to install.
get_user_stats is a Read tool with low risk. Read-only tools are generally safe to allow by default.
Yes. Add a rate_limit block to the get_user_stats rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.
Set action: deny in the PolicyLayer policy for get_user_stats. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.
get_user_stats is provided by the Portkey Admin MCP server (CodesWhat/portkey-admin-mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.