Skip to main content
POST
Trigger test metric execution

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

metric_id
string
required

The metric ID (22-character ShortUUID)

Pattern: ^[a-zA-Z0-9]{22}$

Body

application/json
simulation_output_id
string
required

The simulation output ID (22-character ShortUUID) to run the metric against

Pattern: ^[a-zA-Z0-9]{22}$
dev_id
string

Optional developer identifier for debugging

Response

Test metric execution queued successfully

metric_output_ulid
string

The ULID of the created metric output, used to track result

Required string length: 26
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$