Skip to main content
GET
List metrics

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

view
enum<string>
default:FULL

Response detail level. FULL preserves the historical response including structured result and runtime_metadata; BASIC omits those heavy fields while retaining value, status, explanation, and bounded subvalues.

Available options:
BASIC,
FULL
include_superseded
boolean
default:false

Include outputs that a later re-score of the same metric has superseded.

When false (default) each metric contributes only its most recent output. When true every output is returned, so one metric may appear multiple times; recency is determined by creation time, with the metric_output_id ULID breaking ties, and the response order still follows order_by.

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 | null

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

Example:

"eyJvZmZzZXQiOiA1MH0="