Metrics

List latest metric values

get

List the latest value for each metric in the workspace.

Permissions: authenticated (any role).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Query parameters

sourcestring · enumOptionalDefault: productionPossible values:

scopestring · enumOptionalDefault: aggregatePossible values:

entity_typeany ofOptional

string · max: 64Optional

or

nullOptional

entity_idany ofOptional

string · max: 128Optional

or

nullOptional

service_idany ofOptional

string · max: 64Optional

or

nullOptional

run_idany ofOptional

string · max: 64Optional

or

nullOptional

session_idany ofOptional

string · max: 128Optional

or

nullOptional

limitinteger · min: 1 · max: 500OptionalDefault: 100

offsetintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

422

Validation Error

application/json

429

Rate limited

get

/v1/{workspace_id}/metrics

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/metrics HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "metrics": [
    {
      "metric_key": "text",
      "source": "production",
      "entity_type": "text",
      "entity_id": "text",
      "service_id": "text",
      "run_id": "text",
      "session_id": "text",
      "period_start": "2026-05-12T13:27:07.353Z",
      "period_end": "2026-05-12T13:27:07.353Z",
      "event_count": 1,
      "avg_confidence": 1,
      "unit": "text",
      "computed_at": "2026-05-12T13:27:07.353Z",
      "metric_type": "text",
      "value": 1
    }
  ]
}

List available metrics (builtin + custom)

get

List all available metrics (builtin + custom defined on workspace).

Permissions: authenticated (any role).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

429

Rate limited

get

/v1/{workspace_id}/metrics/catalog

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/metrics/catalog HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "metrics": [
    {
      "key": "text",
      "name": "text",
      "description": "text",
      "metric_type": "numerical",
      "extraction_mode": "static",
      "granularity": "aggregate",
      "model_tier": "free",
      "unit": "text",
      "has_prompt": false,
      "builtin": true
    }
  ]
}

Get values for a specific metric

get

Get values for a specific metric with optional time range.

Permissions: authenticated (any role).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

metric_keystring · min: 1 · max: 64Required

Metric key (lowercase alphanumeric + underscores)

Pattern: ^[a-z][a-z0-9_]*$

Query parameters

sourcestring · enumOptionalDefault: productionPossible values:

scopestring · enumOptionalDefault: aggregatePossible values:

entity_typeany ofOptional

string · max: 64Optional

or

nullOptional

entity_idany ofOptional

string · max: 128Optional

or

nullOptional

service_idany ofOptional

string · max: 64Optional

or

nullOptional

run_idany ofOptional

string · max: 64Optional

or

nullOptional

session_idany ofOptional

string · max: 128Optional

or

nullOptional

date_fromany ofOptional

string · date-timeOptional

or

nullOptional

date_toany ofOptional

string · date-timeOptional

or

nullOptional

limitinteger · min: 1 · max: 365OptionalDefault: 90

Responses

200

Successful Response

application/json

422

Validation Error

application/json

429

Rate limited

get

/v1/{workspace_id}/metrics/{metric_key}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/metrics/{metric_key} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "metrics": [
    {
      "metric_key": "text",
      "source": "production",
      "entity_type": "text",
      "entity_id": "text",
      "service_id": "text",
      "run_id": "text",
      "session_id": "text",
      "period_start": "2026-05-12T13:27:07.353Z",
      "period_end": "2026-05-12T13:27:07.353Z",
      "event_count": 1,
      "avg_confidence": 1,
      "unit": "text",
      "computed_at": "2026-05-12T13:27:07.353Z",
      "metric_type": "text",
      "value": 1
    }
  ]
}

Get time-series trend for a metric

get

Get time-series trend for a specific metric.

Permissions: authenticated (any role).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

metric_keystring · min: 1 · max: 64Required

Metric key (lowercase alphanumeric + underscores)

Pattern: ^[a-z][a-z0-9_]*$

Query parameters

sourcestring · enumOptionalDefault: productionPossible values:

scopestring · enumOptionalDefault: aggregatePossible values:

entity_typeany ofOptional

string · max: 64Optional

or

nullOptional

entity_idany ofOptional

string · max: 128Optional

or

nullOptional

service_idany ofOptional

string · max: 64Optional

or

nullOptional

run_idany ofOptional

string · max: 64Optional

or

nullOptional

session_idany ofOptional

string · max: 128Optional

or

nullOptional

daysinteger · min: 1 · max: 365OptionalDefault: 30

Responses

200

Successful Response

application/json

422

Validation Error

application/json

429

Rate limited

get

/v1/{workspace_id}/metrics/{metric_key}/trend

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/metrics/{metric_key}/trend HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "metrics": [
    {
      "metric_key": "text",
      "source": "production",
      "entity_type": "text",
      "entity_id": "text",
      "service_id": "text",
      "run_id": "text",
      "session_id": "text",
      "period_start": "2026-05-12T13:27:07.353Z",
      "period_end": "2026-05-12T13:27:07.353Z",
      "event_count": 1,
      "avg_confidence": 1,
      "unit": "text",
      "computed_at": "2026-05-12T13:27:07.353Z",
      "metric_type": "text",
      "value": 1
    }
  ]
}

Evaluate a metric once without storing it

post

Execute one metric definition without persisting to UMS.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

metric_keystring · min: 1 · max: 64Required

Metric key (lowercase alphanumeric + underscores)

Pattern: ^[a-z][a-z0-9_]*$

Body

application/json

subject_idstring · min: 1 · max: 128Required

CallSid, call UUID, or simulation session id

as_ofany ofOptional

Optional point-in-time cutoff for selecting the call intelligence snapshot.

string · date-timeOptional

or

nullOptional

persistbooleanOptional

On-demand metric evaluation never writes to metrics.metric_values.

Default: false

Responses

200

Successful Response

application/json

metricone ofRequired

or

or

persistedbooleanOptionalDefault: false

evaluated_atstring · date-timeRequired

404

Metric or call intelligence not found

422

Metric cannot be evaluated on demand

429

Rate limited

502

Metric preview query failed

503

Analytics warehouse not configured

post

/v1/{workspace_id}/metrics/{metric_key}/evaluate

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/metrics/{metric_key}/evaluate HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "subject_id": "text",
  "as_of": "2026-05-12T13:27:07.353Z",
  "persist": false
}

{
  "metric": {
    "metric_key": "text",
    "source": "production",
    "entity_type": "text",
    "entity_id": "text",
    "service_id": "text",
    "run_id": "text",
    "session_id": "text",
    "period_start": "2026-05-12T13:27:07.353Z",
    "period_end": "2026-05-12T13:27:07.353Z",
    "event_count": 1,
    "avg_confidence": 1,
    "unit": "text",
    "computed_at": "2026-05-12T13:27:07.353Z",
    "metric_type": "text",
    "value": 1
  },
  "persisted": false,
  "evaluated_at": "2026-05-12T13:27:07.353Z"
}