get_cost_analytics

Retrieve detailed cost analytics data over time, including total costs and averages per request. Filter by AI provider, API keys, tokens, costs, metadata, and time period to analyze usage and expenses effectively.

Instructions

Retrieve detailed cost analytics data over time, including total costs and averages per request

Input Schema

Name	Required	Description
`ai_org_model`	No	Filter by AI provider and model (comma-separated, use __ as separator)
`api_key_ids`	No	Filter by specific API key UUIDs (comma-separated)
`completion_token_max`	No	Maximum number of completion tokens
`completion_token_min`	No	Minimum number of completion tokens
`configs`	No	Filter by specific config slugs (comma-separated)
`cost_max`	No	Maximum cost in cents to filter by
`cost_min`	No	Minimum cost in cents to filter by
`metadata`	No	Filter by metadata (stringified JSON object)
`prompt_token_max`	No	Maximum number of prompt tokens
`prompt_token_min`	No	Minimum number of prompt tokens
`span_id`	No	Filter by span IDs (comma-separated)
`status_code`	No	Filter by specific HTTP status codes (comma-separated)
`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')
`total_units_max`	No	Maximum number of total tokens to filter by
`total_units_min`	No	Minimum number of total tokens to filter by
`trace_id`	No	Filter by trace IDs (comma-separated)
`virtual_keys`	No	Filter by specific virtual key slugs (comma-separated)
`weighted_feedback_max`	No	Maximum weighted feedback score (-10 to 10)
`weighted_feedback_min`	No	Minimum weighted feedback score (-10 to 10)
`workspace_slug`	No	Filter by specific workspace

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "ai_org_model": {
      "description": "Filter by AI provider and model (comma-separated, use __ as separator)",
      "type": "string"
    },
    "api_key_ids": {
      "description": "Filter by specific API key UUIDs (comma-separated)",
      "type": "string"
    },
    "completion_token_max": {
      "description": "Maximum number of completion tokens",
      "exclusiveMinimum": 0,
      "type": "number"
    },
    "completion_token_min": {
      "description": "Minimum number of completion tokens",
      "exclusiveMinimum": 0,
      "type": "number"
    },
    "configs": {
      "description": "Filter by specific config slugs (comma-separated)",
      "type": "string"
    },
    "cost_max": {
      "description": "Maximum cost in cents to filter by",
      "exclusiveMinimum": 0,
      "type": "number"
    },
    "cost_min": {
      "description": "Minimum cost in cents to filter by",
      "exclusiveMinimum": 0,
      "type": "number"
    },
    "metadata": {
      "description": "Filter by metadata (stringified JSON object)",
      "type": "string"
    },
    "prompt_token_max": {
      "description": "Maximum number of prompt tokens",
      "exclusiveMinimum": 0,
      "type": "number"
    },
    "prompt_token_min": {
      "description": "Minimum number of prompt tokens",
      "exclusiveMinimum": 0,
      "type": "number"
    },
    "span_id": {
      "description": "Filter by span IDs (comma-separated)",
      "type": "string"
    },
    "status_code": {
      "description": "Filter by specific HTTP status codes (comma-separated)",
      "type": "string"
    },
    "time_of_generation_max": {
      "description": "End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')",
      "type": "string"
    },
    "time_of_generation_min": {
      "description": "Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')",
      "type": "string"
    },
    "total_units_max": {
      "description": "Maximum number of total tokens to filter by",
      "exclusiveMinimum": 0,
      "type": "number"
    },
    "total_units_min": {
      "description": "Minimum number of total tokens to filter by",
      "exclusiveMinimum": 0,
      "type": "number"
    },
    "trace_id": {
      "description": "Filter by trace IDs (comma-separated)",
      "type": "string"
    },
    "virtual_keys": {
      "description": "Filter by specific virtual key slugs (comma-separated)",
      "type": "string"
    },
    "weighted_feedback_max": {
      "description": "Maximum weighted feedback score (-10 to 10)",
      "maximum": 10,
      "minimum": -10,
      "type": "number"
    },
    "weighted_feedback_min": {
      "description": "Minimum weighted feedback score (-10 to 10)",
      "maximum": 10,
      "minimum": -10,
      "type": "number"
    },
    "workspace_slug": {
      "description": "Filter by specific workspace",
      "type": "string"
    }
  },
  "required": [
    "time_of_generation_min",
    "time_of_generation_max"
  ],
  "type": "object"
}

Portkey MCP Server

get_cost_analytics

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Portkey MCP Server

Related Tools