Skip to main content
Glama

get_feedback_weighted_analytics

Read-onlyIdempotent

Retrieve weighted feedback-score time-series using weights captured at feedback creation to produce calibrated quality metrics. Use for weighted quality trends; requires Enterprise access (403 otherwise).

Instructions

Get weighted feedback-score time-series data using the weight recorded at feedback creation. Use this for calibrated quality metrics; use get_feedback_scores_analytics for the raw unweighted distribution. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "time_of_generation_min": "<time_of_generation_min>",
      "time_of_generation_max": "<time_of_generation_max>"
    },
    "name": "get_feedback_weighted_analytics"
  }
}

Input 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.
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.
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 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
okYesCall succeeded
dataNoSuccess payload
errorNoFailure details

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.16.5
    • changedOutput schema / properties / data / description
      Previous value: -"Structured success payload when ok is true"New value: +"Success payload"
    • changedOutput schema / properties / error / description
      Previous value: -"Structured error payload when ok is false"New value: +"Failure details"
    • changedOutput schema / properties / error / properties / details / description
      Previous value: -"Optional structured error details"New value: +"Extra error details"
    • changedOutput schema / properties / error / properties / message / description
      Previous value: -"Human-readable error message"New value: +"Error message"
    • changedOutput schema / properties / ok / description
      Previous value: -"Whether the tool call succeeded and returned structured data"New value: +"Call succeeded"
  2. Changed5 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: -"Filter by specific workspace"New value: +"Filter by one workspace. Takes precedence over include_all_workspaces and exclude_workspace_slugs when provided."
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. 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"
      +}
  4. Changed16 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
    • 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
  5. Changed1 schema field changedv1.0.2
    • 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"
      +]
  6. Addedv1.0.1

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is fully covered upstream. The description's genuine additions are the Enterprise plan gating and the concrete 403 failure mode, which are useful operational context. It says nothing about how the time-series is bucketed or aggregated, which is the main behavioral unknown left for a series-returning endpoint.

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 short sentences: what it does first, the alternative second, the access constraint third. Every sentence carries distinct information and nothing is restated from the title or schema.

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 33-parameter, nested-object analytics endpoint, the description covers purpose, sibling disambiguation, gating, and error behavior, while an output schema exists to explain the return shape and the input schema is fully documented. The remaining gap is aggregation/granularity semantics for the time-series, which an agent would plausibly want before calling.

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?

With 33 parameters and 100% schema description coverage, the schema already documents every filter, including weighted_feedback_min/max ranges and the legacy-vs-structured alias pairs. The description adds no parameter-level guidance of its own, so the baseline 3 applies.

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?

States a specific verb and resource ('Get weighted feedback-score time-series data') and immediately explains the defining mechanism: weighting uses the value recorded at feedback creation time. That mechanism is exactly what separates it from the sibling listed, so an agent can distinguish the two without inspecting either schema.

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?

Explicitly routes the agent: 'Use this for calibrated quality metrics; use get_feedback_scores_analytics for the raw unweighted distribution.' It also states the operating precondition (Enterprise-gated) and the failure mode (403 on non-Enterprise plans), so the agent knows both when to pick it and when it will fail.

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