Dynamiq
Metrics

List metrics

Lists the metrics of a project, ordered by name by default. The project_id query parameter is required.

GET
/v1/metrics

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

Query Parameters

project_id*string

Project UUID to list metrics for.

page?integer

Page number (1-based).

page_size?integer

Number of items per page. Values below the minimum or above the maximum are clamped to the nearest bound.

sort?string

Comma-separated sort fields. Prefix a field with - for descending order, e.g. sort=-started_at.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/metrics?project_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
      "type": "llm_as_a_judge",
      "config": {},
      "latest_version_id": "8562ca50-d99e-4ec5-9529-9c17b0fd462e",
      "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": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

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.

Create a metric

Creates an evaluation metric in a project. The `config` shape depends on `type`: an LLM-as-a-judge prompt, a predefined evaluator plus its settings, or custom scoring code. Creating a metric also records its first version.