get_user_stats

Retrieve user activity analytics, including request counts and costs, within a specified time range. Filter by cost, units, status codes, or virtual keys to monitor and manage API usage effectively.

Instructions

Retrieve detailed analytics data about user activity within a specified time range, including request counts and costs

Input Schema

Name	Required	Description
`cost_max`	No	Maximum cost in cents to filter by
`cost_min`	No	Minimum cost in cents to filter by
`page_size`	No	Number of results per page (for pagination)
`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
`virtual_keys`	No	Filter by specific virtual key slugs (comma-separated)

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "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"
    },
    "page_size": {
      "description": "Number of results per page (for pagination)",
      "exclusiveMinimum": 0,
      "type": "number"
    },
    "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"
    },
    "virtual_keys": {
      "description": "Filter by specific virtual key slugs (comma-separated)",
      "type": "string"
    }
  },
  "required": [
    "time_of_generation_min",
    "time_of_generation_max"
  ],
  "type": "object"
}

Portkey MCP Server

get_user_stats

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Portkey MCP Server

Related Tools