ROroarkhq
Metric Collection Job

Create and run a metric collection job

Changed on

Creates a metric collection job for the specified calls or chats and metrics, then triggers processing. Provide exactly one of callIds or chatIds. Pass policyId to score with a metric policy’s settings (for example to re-score past calls after changing which properties Property Verification checks); metrics then defaults to every metric that policy collects.

post/v1/metric/collection-jobs

Request

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

Request body

callIdsstring[]

Call IDs to collect metrics for. Mutually exclusive with chatIds. Max 500 per request.

chatIdsstring[]

Chat IDs to collect metrics for. Mutually exclusive with callIds. Max 500 per request.

policyIdstring uuid

Optional. A metric policy (collector) whose settings to score with: each metric runs at the version that policy runs it at, with its per-collector setting (such as the properties Property Verification checks), instead of the metric's default. A metric the policy runs at its default runs at its default here too. The policy's conditions are not applied: the listed conversations are scored as given. Use it to re-score past conversations after changing a policy's settings.

Response

The created metric collection job

Changes

  • 2bb78f0ffcdcRevision changes
    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the non-success response with the status

  • b4a59c7057caRevision changes
    • info

      added the non-success response with the status