List an app's online evaluations
Lists the online evaluations configured on an app, most recently created first. Each online evaluation attaches a metric to the app and scores a sampled share of its live traces.
Authorization
personalAccessToken Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.
In: header
Path Parameters
App UUID.
Query Parameters
Page number (1-based).
Number of items per page. Values below the minimum or above the maximum are clamped to the nearest bound.
Comma-separated sort fields. Prefix a field with - for descending order, e.g. sort=-started_at.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/evaluations"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",
"metric_id": "e3216117-28d7-4548-9b5f-7e08a760b2c7",
"metric_version_id": "6a8aaa42-ffc3-428f-ac36-ffb02e6fb61b",
"enabled": true,
"sample_rate": 0,
"input_transformer": {
"path": "string",
"selector": {
"property1": "string",
"property2": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"avatar_url": "string"
},
"updated_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"avatar_url": "string"
}
}
],
"pagination": {
"page": 0,
"page_size": 0,
"page_count": 0,
"total_count": 0
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"error": {
"code": "not_found",
"message": "Not Found"
}
}Download evaluation results
Streams the full evaluation results as a downloadable JSON file (`Content-Disposition: attachment; filename="evaluation-<evaluation_id>-results.json"`). The body is a JSON object with the `evaluation` and a `results` array of the same per-item result objects returned by the results endpoint.
Create an online evaluation
Attaches a metric to an app so its live traces are scored continuously — the API behind the **Evaluations** tab on the App page. `metric_id` and `metric_version_id` select the scorer; `sample_rate` (0–1) is the fraction of incoming traces to score; `enabled` toggles sampling; and the optional `input_transformer` builds the metric's input from the trace. While enabled, every trace the app records afterwards (failed ones included) is sampled and, when selected, gets one evaluation run. Earlier traces are never backfilled. Send `enabled` and `sample_rate` explicitly: omitted, they default to `false` and `0`, which creates an evaluation that never scores anything. The metric must belong to the app's project.