Skip to main content
Glama

get_analytics_group_providers

Read-onlyIdempotent

Retrieve provider-grouped analytics for one workspace or organization-wide over a time range, with selectable metrics, ordering, pagination, and optional totals to compare provider traffic and reliability.

Instructions

Enterprise-gated. Get provider-grouped analytics for one workspace or organisation-wide and a time range with selectable metrics, ordering, pagination, and optional total count. Choose workspace_slug, include_all_workspaces=true, or exclude_workspace_slugs. Use this when comparing provider traffic or reliability; requested metric fields are preserved in each provider row. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Input Schema

NameRequiredDescriptionDefault
columnsNoProvider metrics to include in each grouped row
configsNoLegacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
span_idNoLegacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
cost_maxNoMaximum cost in cents to filter by
cost_minNoMinimum cost in cents to filter by
metadataNoLegacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
order_byNoMetric or field used to order groups
span_idsNoStructured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
trace_idNoLegacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
page_sizeNoNumber of provider groups per page
trace_idsNoStructured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
api_key_idsNoLegacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
prompt_slugNoFilter by prompt slug
status_codeNoLegacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
ai_org_modelNoLegacy 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_slugsNoStructured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
current_pageNoZero-based result page
status_codesNoStructured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
virtual_keysNoLegacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
deployment_idNoComma-separated list of deployment IDs (UUIDs) to filter by. Prefer deployment_ids for structured inputs.
include_totalNoRequest the total provider-group count
order_by_typeNoSort direction accepted by Portkey, such as asc or desc
deployment_idsNoStructured alias for deployment_id. Use an array of deployment UUIDs; normalized to the comma-separated Portkey query param.
workspace_slugNoFilter by one workspace. Takes precedence over include_all_workspaces and exclude_workspace_slugs when provided.
metadata_filterNoStructured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
provider_modelsNoStructured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
total_units_maxNoMaximum number of total tokens to filter by
total_units_minNoMinimum number of total tokens to filter by
prompt_token_maxNoMaximum number of prompt tokens
prompt_token_minNoMinimum number of prompt tokens
virtual_key_slugsNoStructured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
completion_token_maxNoMaximum number of completion tokens
completion_token_minNoMinimum number of completion tokens
weighted_feedback_maxNoMaximum weighted feedback score (-10 to 10)
weighted_feedback_minNoMinimum weighted feedback score (-10 to 10)
include_all_workspacesNoAggregate across all organisation workspaces with an organisation API key. Ignored for workspace API keys or when workspace_slug is provided. Supply workspace_slug, include_all_workspaces=true, or exclude_workspace_slugs to choose a scope.
time_of_generation_maxYesEnd time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minYesStart time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
exclude_workspace_slugsNoComma-separated workspace slugs to exclude from organisation-wide analytics, for example ws-legacy,ws-archived. Only applies to organisation API keys; workspace_slug takes precedence.

Output Schema

NameRequiredDescriptionDefault
okYesWhether the tool call succeeded and returned structured data
dataNoStructured success payload when ok is true
errorNoStructured error payload when ok is false

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv1.0.9
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / properties / exclude_workspace_slugs
      Added value: +{
      +  "description": "Comma-separated workspace slugs to exclude from organisation-wide analytics, for example ws-legacy,ws-archived. Only applies to organisation API keys; workspace_slug takes precedence.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / include_all_workspaces
      Added value: +{
      +  "description": "Aggregate across all organisation workspaces with an organisation API key. Ignored for workspace API keys or when workspace_slug is provided. Supply workspace_slug, include_all_workspaces=true, or exclude_workspace_slugs to choose a scope.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / workspace_slug / description
      Previous value: -"Workspace slug to analyze"New value: +"Filter by one workspace. Takes precedence over include_all_workspaces and exclude_workspace_slugs when provided."
    • changedInput schema / required
      Previous value: -[
      -  "time_of_generation_min",
      -  "time_of_generation_max",
      -  "workspace_slug"
      -]New value: +[
      +  "time_of_generation_min",
      +  "time_of_generation_max"
      +]
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Changed2 schema fields changedv0.13.0
    • 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"
      +}
  3. Addedv0.11.5

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the description's job is to add gating and response-shape context. It does that well by flagging the Enterprise requirement and the 403 failure mode on non-Enterprise Portkey plans, plus the precedence rules among scope selectors, though the 'Enterprise-gated' phrase is duplicated rather than expanding on what each scope returns.

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

Conciseness3/5

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

The scope-selection and when-to-use guidance is front-loaded and earns its place, but 'Enterprise-gated.' appears twice in a four-sentence description, a clear redundancy that wastes space. The 403 tail also repeats the same gating fact rather than adding new information.

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

Completeness4/5

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

For a 39-parameter read tool with a full output schema and complete annotations, the description covers the essentials: what it aggregates, how scope is chosen, that metric columns carry into each row, and the Enterprise paywall. An agent can call it correctly without further reading, though the overlapping scope selectors could be spelled out a bit more sharply.

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 39 properties, and the schema already documents the scope precedence rules, legacy-versus-structured aliases, and all filter units. The description adds only a light summary ('selectable metrics, ordering, pagination, optional total count') plus the note that requested metric fields are preserved in each provider row, so the baseline 3 is appropriate.

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

Purpose4/5

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

It states a specific verb and resource — 'Get provider-grouped analytics' — scoped to one workspace or organisation-wide over a time range. 'Provider-grouped' implicitly separates it from siblings like get_analytics_group_models, get_analytics_group_users, and get_analytics_group_metadata, but no sibling is named explicitly.

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

Usage Guidelines4/5

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

It gives a concrete triggering condition ('Use this when comparing provider traffic or reliability') and lays out the three mutually exclusive scope selectors: workspace_slug, include_all_workspaces=true, or exclude_workspace_slugs. It stops short of naming the sibling group-by tools an agent should pick instead for user- or model-level breakdowns.

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

Deploy Server

Other Tools