Skip to main content
GET
/
v1
/
simulations
/
{simulation_id}
/
metrics
List metrics
curl --request GET \
  --url https://api.coval.dev/v1/simulations/{simulation_id}/metrics \
  --header 'X-API-Key: <api-key>'
{
  "metrics": [
    {
      "metric_output_id": "01JCQR8Z9PQSTNVWXY12345678",
      "metric_id": "abc123xyz789",
      "status": "COMPLETED",
      "value": 0.85,
      "subvalues_by_timestamp": [
        {
          "start_offset": 0,
          "end_offset": 2.5,
          "output_type": "float",
          "float_value": 0.85,
          "string_value": "",
          "role": "assistant",
          "message_index": 3
        }
      ]
    }
  ],
  "next_page_token": "eyJvZmZzZXQiOiA1MH0="
}

Documentation Index

Fetch the complete documentation index at: https://docs.coval.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API key for authentication.

Path Parameters

​
simulation_id
string
required

The simulation ID

Required string length: 22 - 27

Query Parameters

​
filter
string

Filter expression syntax.

Supported fields: status, metric_id, metric_name, value, create_time, start_time, end_time

Operators: =, !=, >, <, >=, <=, AND, OR

Values may be unquoted or double-quoted. Values containing spaces must be quoted (e.g., status="IN PROGRESS").

​
page_size
integer
default:50

Maximum number of results per page

Required range: 1 <= x <= 1000
​
page_token
string

Opaque pagination token from previous response

​
order_by
string
default:metric_name

Sort order specification.

Format: field or -field (descending)

Supported fields: metric_name, create_time, value, start_time, end_time

Response

List of metric outputs

​
metrics
object[]
required

Array of simplified metric outputs

​
next_page_token
string

Token for fetching next page of results (if more exist)

Example:

"eyJvZmZzZXQiOiA1MH0="