ROroarkhq
Metric Collection Job

Get metric values produced by a metric collection job

Changed on

Returns the metric values produced by the specified job, grouped by metric definition. Unlike GET /v1/call/:callId/metrics (which returns the latest values on a call, regardless of which job computed them), this endpoint returns exactly the values this job produced — including for calls whose live values have since been overwritten by a later job. By default returns only SUCCESS rows; pass ?status=all to also include NOT_APPLICABLE / DATA_MISSING / ERROR.

get/v1/metric/collection-jobs/{jobId}/metric-values

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values
  • Auth
    HTTP bearer

Path parameters

jobIdstring required

Query parameters

status'success' | 'all'

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.

Response

Metric values produced by the job, grouped by metric definition

Changes

  • e32b31fc8f98Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • 7ea77678ccedRevision changes
    • warning

      added the new TRANSCRIPTION_ERROR enum value to the /////// response property for the response status