v1

latestOpenAPI 3.0.02026-07-1346146138.4 KB

metrics

Get metrics with filtering and grouping

Retrieves metrics data with support for filtering, sorting, and pagination. Metrics are grouped by metric name with individual data points. Supports filtering by direct column fields (bool_value, trace_id, etc.), label fields (labels.agent_name, labels.trace_id), and attribute fields (attributes.*).

post/v2/metrics

Request body

from_timestamp_secinteger

Start time in Unix seconds timestamp.

to_timestamp_secinteger

End time in Unix seconds timestamp.

cursorinteger

Pagination cursor for fetching the next page of results. The cursor is returned in the response to the previous request.

environmentsstring[]

List of environments to filter by

limitinteger

Maximum number of metrics to return per page.

logical_operator'AND' | 'OR'

metric_namestring

Metric name to filter by. The metric_name is a metric attribute that is set on the metric object.

metric_sourcestring

Metric source to filter by. The metric_source is a metric attribute that is set on the metric object.

sort_bystring

Field to sort by.

sort_orderstring

Sort order.

Example request

{
  "from_timestamp_sec": 1772905218,
  "to_timestamp_sec": 1772905218,
  "cursor": 1772905218000,
  "environments": [
    "prd",
    "stg",
    "dev"
  ],
  "filters": [
    {
      "field": "labels.agent_name",
      "operator": "equals",
      "value": "Travel Planner Agent",
      "values": [
        "Travel Planner Agent",
        "Calendar Planner Agent"
      ]
    }
  ],
  "limit": 50,
  "metric_name": "answer relevancy",
  "metric_source": "llm_as_a_judge",
  "sort_by": "timestamp",
  "sort_order": "ASC"
}

Response

Grouped metrics with data points

Example response

{
  "metrics": {
    "data": [
      {
        "metric_name": "answer relevancy",
        "points": [
          {
            "labels": {
              "agent_name": "Travel Planner Agent",
              "entity_type": "span",
              "env_project_id": "1111",
              "environment": "dev",
              "evaluator_name": "",
              "insert_time": "1772616490000",
              "metric_source": "word_count",
              "metric_type": "numeric",
              "model": "gpt-4o-2024-08-06",
              "org_id": "12345",
              "run_id": "54321",
              "service_name": "travel-agent-demo",
              "span_id": "e118a1985c9cff23",
              "trace_id": "2c98a42d1225cb786f3395d97ca3014d",
              "unit": "words",
              "vendor": "openai"
            }
          }
        ]
      }
    ]
  }
}