Dynamiq
Evaluations

Update an online evaluation

Updates an online evaluation's runtime settings — name, description, enabled, sample_rate, input_transformer, and the metric version (metric_version_id). The target metric itself is immutable; the new version must belong to the same metric.

PUT
/v1/app-evaluations/{evaluation_id}

Authorization

personalAccessToken
AuthorizationBearer <token>

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

evaluation_id*string

Evaluation UUID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Update an online evaluation's runtime settings and metric version. The target metric cannot be changed; the new version must belong to the same metric.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/app-evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "metric_version_id": "6a8aaa42-ffc3-428f-ac36-ffb02e6fb61b"  }'
{
  "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"
    }
  }
}
{
  "error": {
    "code": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Delete an online evaluation

Deletes an online evaluation along with the runs it has recorded.

List online evaluation runs

Lists the runs recorded by an online evaluation, most recent first. Each run corresponds to one sampled app trace and carries its `status`, `score`, and the `trace_id` it scored. Filter by status with the `status` query parameter.