portkey-admin-mcp

get_analytics_group_users

Read-onlyIdempotent

Retrieve a paginated per-user breakdown of request counts, costs, and token usage for billing, audits, or top-consumer analysis. Enterprise-gated; returns 403 on non-Enterprise plans.

Instructions

Get a paginated per-user breakdown with total_groups, group_count, and a users array containing request count, cost, and token usage. Use this for billing, audits, or top-consumer analysis; use get_users_analytics for aggregate active and new user trends. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Input Schema

TableJSON Schema

Name	Required	Description
`configs`	No	Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
`span_id`	No	Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
`cost_max`	No	Maximum cost in cents to filter by
`cost_min`	No	Minimum cost in cents to filter by
`metadata`	No	Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
`span_ids`	No	Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
`trace_id`	No	Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
`page_size`	No	Results per page (max 100)
`trace_ids`	No	Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
`api_key_ids`	No	Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
`prompt_slug`	No	Filter by prompt slug
`status_code`	No	Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
`ai_org_model`	No	Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
`config_slugs`	No	Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
`current_page`	No	Zero-based page number; the first page is 0
`status_codes`	No	Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
`virtual_keys`	No	Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
`deployment_id`	No	Comma-separated list of deployment IDs (UUIDs) to filter by. Prefer deployment_ids for structured inputs.
`deployment_ids`	No	Structured alias for deployment_id. Use an array of deployment UUIDs; normalized to the comma-separated Portkey query param.
`workspace_slug`	No	Filter by specific workspace
`metadata_filter`	No	Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
`provider_models`	No	Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
`total_units_max`	No	Maximum number of total tokens to filter by
`total_units_min`	No	Minimum number of total tokens to filter by
`prompt_token_max`	No	Maximum number of prompt tokens
`prompt_token_min`	No	Minimum number of prompt tokens
`virtual_key_slugs`	No	Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
`completion_token_max`	No	Maximum number of completion tokens
`completion_token_min`	No	Minimum number of completion tokens
`weighted_feedback_max`	No	Maximum weighted feedback score (-10 to 10)
`weighted_feedback_min`	No	Minimum weighted feedback score (-10 to 10)
`time_of_generation_max`	Yes	End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
`time_of_generation_min`	Yes	Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')

Output Schema

TableJSON Schema

Name	Required	Description
`ok`	Yes	Whether the tool call succeeded and returned structured data
`data`	No	Structured success payload when ok is true
`error`	No	Structured error payload when ok is false

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv0.13.0Oct 3, 2026

addedInput schema / properties / deployment_id

Added value: +{
+  "description": "Comma-separated list of deployment IDs (UUIDs) to filter by. Prefer deployment_ids for structured inputs.",
+  "type": "string"
+}

addedInput schema / properties / deployment_ids

Added value: +{
+  "description": "Structured alias for deployment_id. Use an array of deployment UUIDs; normalized to the comma-separated Portkey query param.",
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}

Changed19 schema fields changedv0.11.5Sep 8, 2026
- removedInput schema / properties / completion_token_max / exclusiveMinimum
```
Removed value: -0
```
- addedInput schema / properties / completion_token_max / minimum
```
Added value: +0
```
- removedInput schema / properties / completion_token_min / exclusiveMinimum
```
Removed value: -0
```
- addedInput schema / properties / completion_token_min / minimum
```
Added value: +0
```
- removedInput schema / properties / cost_max / exclusiveMinimum
```
Removed value: -0
```
- addedInput schema / properties / cost_max / minimum
```
Added value: +0
```
- removedInput schema / properties / cost_min / exclusiveMinimum
```
Removed value: -0
```
- addedInput schema / properties / cost_min / minimum
```
Added value: +0
```
- changedInput schema / properties / current_page / description
```
Previous value: -"Page number for pagination"New value: +"Zero-based page number; the first page is 0"
```
- removedInput schema / properties / current_page / exclusiveMinimum
```
Removed value: -0
```
- addedInput schema / properties / current_page / minimum
```
Added value: +0
```
- removedInput schema / properties / prompt_token_max / exclusiveMinimum
```
Removed value: -0
```
- addedInput schema / properties / prompt_token_max / minimum
```
Added value: +0
```
- removedInput schema / properties / prompt_token_min / exclusiveMinimum
```
Removed value: -0
```
- addedInput schema / properties / prompt_token_min / minimum
```
Added value: +0
```
- removedInput schema / properties / total_units_max / exclusiveMinimum
```
Removed value: -0
```
- addedInput schema / properties / total_units_max / minimum
```
Added value: +0
```
- removedInput schema / properties / total_units_min / exclusiveMinimum
```
Removed value: -0
```
- addedInput schema / properties / total_units_min / minimum
```
Added value: +0
```
Changed2 schema fields changedv0.5.0Jul 14, 2026
- addedInput schema / properties / current_page / maximum
```
Added value: +9007199254740991
```
- changedInput schema / properties / current_page / type
```
Previous value: -"number"New value: +"integer"
```

Changed1 schema field changedv1.0.2Jul 4, 2026

changedInput schema / required

Previous value: -[
-  "time_of_generation_min",
-  "time_of_generation_max",
-  "api_key_ids"
-]New value: +[
+  "time_of_generation_min",
+  "time_of_generation_max"
+]

Addedv1.0.1May 7, 2026

TDQS

A4.5/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true, so the safety profile is covered. The description adds meaningful context beyond annotations: it is paginated, Enterprise-gated, and returns 403 on non-Enterprise plans. It doesn't detail rate limits or authentication mechanism beyond the Enterprise plan gate, so it is not exhaustive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, each earning its place: the first defines output and scope, the second gives usage and the alternative sibling, the third states the Enterprise gate and error behavior. The purpose is front-loaded and nothing is redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given a 33-parameter schema, a separate output schema, and rich annotations, the description supplies everything an agent needs: what the tool returns, when to use it versus the sibling, and the critical Enterprise gating constraint. Return values are not over-explained because the output schema exists, yet the key fields are still summarized for quick decision-making.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% across all 33 parameters, so the schema already documents every filter, alias, and pagination field. The description adds no parameter-level meaning beyond what the schema provides, matching the baseline of 3 for fully documented schemas.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('Get a paginated per-user breakdown') and enumerates the returned fields (total_groups, group_count, users array with request count, cost, token usage). It explicitly distinguishes itself from the sibling get_users_analytics, so an agent can select between them without opening schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It names concrete use cases (billing, audits, top-consumer analysis) and explicitly routes the agent to get_users_analytics for a different need (aggregate active and new user trends). It also states the Enterprise gating condition and the failure mode (403 on non-Enterprise plans), leaving no ambiguity about when the tool is applicable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server