Skip to main content
GET
/
v1
/
metric
/
collection-jobs
/
{jobId}
/
metric-values
Get metric values produced by a metric collection job
curl --request GET \
  --url https://api.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "metricDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "metricId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "values": [
        {
          "computedAt": "2023-11-07T05:31:56Z",
          "value": 123,
          "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "chatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "errorMessage": "<string>",
          "valueReasoning": "<string>",
          "confidence": 0.5,
          "policyIds": [
            "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          ],
          "segment": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "text": "<string>",
            "startOffsetMs": 123,
            "endOffsetMs": 123
          },
          "fromSegment": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "text": "<string>",
            "startOffsetMs": 123,
            "endOffsetMs": 123
          },
          "toSegment": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "text": "<string>",
            "startOffsetMs": 123,
            "endOffsetMs": 123
          }
        }
      ],
      "unit": {
        "name": "<string>",
        "symbol": "<string>"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.roark.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

jobId
string
required

Query Parameters

status
enum<string>
default:success

Filter metrics by capture status. success (default) returns only successfully computed metrics; all also returns NOT_APPLICABLE / DATA_MISSING / ERROR rows with the value field omitted.

Available options:
success,
all

Response

Metric values produced by the job, grouped by metric definition

data
object[]
required

Metric values produced by a specific metric collection job. Grouped by metric definition, same shape as the per-call metrics endpoint.