v47

OpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-011562132.1 KB
definition

Query available filters for a specific metric

Returns a list of available filters that can be applied to a specific metric within an API type, including their operators and value constraints.

get/environments/{envId}/analytics/definition/metrics/{metricName}/filters

Path parameters

envIdstring required

The unique ID of your environment

metricName'HTTP_REQUESTS' | 'HTTP_ERRORS' | 'HTTP_ERROR_RATE' | 'HTTP_REQUEST_CONTENT_LENGTH' | 'HTTP_RESPONSE_CONTENT_LENGTH' | 'HTTP_ENDPOINT_RESPONSE_TIME' | 'HTTP_GATEWAY_RESPONSE_TIME' | 'HTTP_GATEWAY_LATENCY' | 'LLM_PROMPT_TOKEN_SENT' | 'LLM_PROMPT_TOKEN_RECEIVED' | 'LLM_PROMPT_TOKEN_SENT_COST' | 'LLM_PROMPT_TOKEN_RECEIVED_COST' | 'LLM_PROMPT_TOTAL_TOKEN' | 'LLM_PROMPT_TOKEN_TOTAL_COST' | 'MESSAGE_PAYLOAD_SIZE' | 'MESSAGES' | 'MESSAGE_ERRORS' | 'MESSAGE_GATEWAY_LATENCY' | 'EDGE_DETECTION_COUNT' | 'EDGE_TOKENS_IN' | 'EDGE_TOKENS_OUT' | 'EDGE_HEARTBEAT_COUNT' | 'NATIVE_CONNECTIONS_SUMMARY' required

Available metric names for analytics queries

The metric identifier for which to retrieve filter specifications

Response

The response contains a list of available filters for the specified metric, including their supported operators, types, and optional enum values or ranges.

Example response

{
  "data": [
    {
      "name": "API",
      "label": "API",
      "type": "KEYWORD",
      "operators": [
        "EQ",
        "IN"
      ]
    },
    {
      "name": "HTTP_METHOD",
      "label": "HTTP Method",
      "type": "ENUM",
      "operators": [
        "EQ",
        "IN"
      ],
      "enumValues": [
        "GET",
        "POST",
        "PUT"
      ]
    },
    {
      "name": "HTTP_STATUS",
      "label": "Status Code",
      "type": "NUMBER",
      "operators": [
        "EQ",
        "LTE",
        "GTE"
      ],
      "range": {
        "min": 100,
        "max": 600
      }
    }
  ]
}