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

Provide exactly one of simulation_output_id or simulation_output_ids.

simulation_output_id
string
deprecated

Deprecated: a single simulation output ID (22-character ShortUUID) to run the metric against. Prefer simulation_output_ids.

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

Simulation output IDs (22-character ShortUUIDs) to run the metric against; 1–100 per call.

Required array length: 1 - 100 elements
Pattern: ^[a-zA-Z0-9]{22}$
dev_id
string

Optional developer identifier for debugging

Response

All requested test metric executions queued successfully

results
object[]
required

One entry per requested simulation output.

metric_output_ulid
string | null
deprecated

Deprecated: the ULID of the created metric output, used to track the result. Only set for single simulation_output_id requests; null for batch (simulation_output_ids) requests, which should read results instead.

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