For the complete documentation index, see llms.txt. This page is also available as Markdown.

Metrics

List latest metric values

get

List metric values. By default, the newest period of each metric series.

A categorical or boolean series folds its newest period into one row: distribution counts each value and value is the most frequent. Pages cover the first 10,000 values; narrow the filters or dates to read past them.

Permissions: authenticated (any role).

Authorizations
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
sort_bystring[]Optional

Order of the page, e.g. -period_start (the default, newest first) or +metric_key.

Default: []
sourcestring · enumOptionalDefault: productionPossible values:
scopestring · enumOptionalDefault: aggregatePossible values:
entity_typestring · max: 64 · nullableOptional
entity_idstring · max: 128 · nullableOptional
service_idstring · uuid · nullableOptional
run_idstring · uuid · nullableOptional
session_idstring · max: 128 · nullableOptional
date_fromstring · date-time · nullableOptional
date_tostring · date-time · nullableOptional
latest_onlybooleanOptional

Return each series' newest period only, a categorical or boolean period folded into one row.

Default: true
limitinteger · max: 500OptionalDefault: 100
continuation_tokenanyOptional
Responses
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokenanyOptional
get/v1/{workspace_id}/metrics
GET /v1/{workspace_id}/metrics HTTP/1.1
Host: platform.api-us.concurrence.com
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-01-01T00:00:00.000Z",
      "period_end": "2026-01-01T00:00:00.000Z",
      "event_count": 1,
      "avg_confidence": 1,
      "unit": "text",
      "computed_at": "2026-01-01T00:00:00.000Z",
      "metric_type": "text",
      "value": 1
    }
  ],
  "has_more": true,
  "continuation_token": null
}

List available metrics (builtin + custom)

get

List the workspace's active metrics: builtins plus custom definitions.

Resolved from the workspace's metric settings, so a builtin turned off there is not listed.

Permissions: authenticated (any role).

Authorizations
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
get/v1/{workspace_id}/metrics/catalog
GET /v1/{workspace_id}/metrics/catalog HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "metrics": [
    {
      "key": "text",
      "name": "text",
      "description": "text",
      "metric_type": "numerical",
      "source": "call_intelligence",
      "custom_source_key": "text",
      "extraction_mode": "static",
      "granularity": "aggregate",
      "period_granularity": "daily",
      "latency_tier": "batch",
      "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, newest period first.

Permissions: authenticated (any role).

Authorizations
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_typestring · max: 64 · nullableOptional
entity_idstring · max: 128 · nullableOptional
service_idstring · uuid · nullableOptional
run_idstring · uuid · nullableOptional
session_idstring · max: 128 · nullableOptional
date_fromstring · date-time · nullableOptional
date_tostring · date-time · nullableOptional
limitinteger · min: 1 · max: 365OptionalDefault: 90
Responses
200

Successful Response

application/json
get/v1/{workspace_id}/metrics/{metric_key}
GET /v1/{workspace_id}/metrics/{metric_key} HTTP/1.1
Host: platform.api-us.concurrence.com
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-01-01T00:00:00.000Z",
      "period_end": "2026-01-01T00:00:00.000Z",
      "event_count": 1,
      "avg_confidence": 1,
      "unit": "text",
      "computed_at": "2026-01-01T00:00:00.000Z",
      "metric_type": "text",
      "value": 1
    }
  ]
}

Get time-series trend for a metric

get

Get every value a metric recorded in the last days days, newest period first.

Permissions: authenticated (any role).

Authorizations
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_typestring · max: 64 · nullableOptional
entity_idstring · max: 128 · nullableOptional
service_idstring · uuid · nullableOptional
run_idstring · uuid · nullableOptional
session_idstring · max: 128 · nullableOptional
daysinteger · min: 1 · max: 365OptionalDefault: 30
Responses
200

Successful Response

application/json
get/v1/{workspace_id}/metrics/{metric_key}/trend
GET /v1/{workspace_id}/metrics/{metric_key}/trend HTTP/1.1
Host: platform.api-us.concurrence.com
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-01-01T00:00:00.000Z",
      "period_end": "2026-01-01T00:00:00.000Z",
      "event_count": 1,
      "avg_confidence": 1,
      "unit": "text",
      "computed_at": "2026-01-01T00:00:00.000Z",
      "metric_type": "text",
      "value": 1
    }
  ]
}

Last updated

Was this helpful?