Skip to main content
Glama

get_analytics_group_metadata

Read-onlyIdempotent

Break down analytics by a metadata key to retrieve paginated group counts and metadata groups for custom per-environment or per-feature analysis. Requires an Enterprise plan.

Instructions

Get a paginated metadata breakdown with total_groups, group_count, and a metadata_groups array grouped by the required metadata_key. Use this for custom breakdowns like per-environment or per-feature analysis; pass metadata_key in addition to the time window. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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.
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_sizeNoResults per page (max 100)
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 page number; the first page is 0
metadata_keyYesThe metadata key to group by (e.g., 'env', 'app', 'client_id')
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.
deployment_idsNoStructured alias for deployment_id. Use an array of deployment UUIDs; normalized to the comma-separated Portkey query param.
workspace_slugNoFilter by specific workspace
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)
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')

Output Schema

TableJSON 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. 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"
      +}
  2. Changed19 schema fields changedv0.11.5
    • 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
  3. Changed2 schema fields changedv0.5.0
    • addedInput schema / properties / current_page / maximum
      Added value: +9007199254740991
    • changedInput schema / properties / current_page / type
      Previous value: -"number"New value: +"integer"
  4. Changed1 schema field changedv1.0.2
    • changedInput schema / required
      Previous value: -[
      -  "time_of_generation_min",
      -  "time_of_generation_max",
      -  "api_key_ids",
      -  "metadata_key"
      -]New value: +[
      +  "time_of_generation_min",
      +  "time_of_generation_max",
      +  "metadata_key"
      +]
  5. Addedv1.0.1

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), but the description adds context beyond them: 'Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.' That plan/auth prerequisite and the explicit error code are genuinely useful behavioral disclosure the annotations do not convey.

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

Conciseness4/5

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

Front-loaded with the return shape, followed by usage, then gating. Three tight sentences with no filler; each carries information. Could be marginally trimmed by trimming the enumerated return fields, which the output schema already provides.

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?

An output schema exists, so the return values needn't be spelled out, and the description covers purpose, usage, and the Enterprise gating constraint. For a 34-param analytics tool this is largely complete, though the omission of how the group-by dimension relates to the fixed-dimension siblings leaves a small gap.

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%, so the baseline is 3. The description reiterates that metadata_key is required and to pass it with the time window, but this restates what the schema's required array already declares and adds little syntax or format guidance across the 34 parameters.

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?

States a specific verb+resource ('Get a paginated metadata breakdown') and names the return shape (total_groups, group_count, metadata_groups). The phrase 'custom breakdowns like per-environment or per-feature analysis' implicitly distinguishes it from fixed-dimension siblings (group_users, group_models, group_providers), though no sibling is named outright.

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?

'Use this for custom breakdowns like per-environment or per-feature analysis' gives clear when-to-use context, and it tells the caller to pass metadata_key alongside the time window. It stops short of naming the fixed-dimension alternatives or stating when NOT to use it, so it does not reach the exclusions bar.

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