Skip to main content
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.
Calls POST /v1/metric/collection-jobs

​
Options

​
array
Call IDs to collect metrics for. Mutually exclusive with chatIds. Max 500 per request. Repeatable.
​
array
Chat IDs to collect metrics for. Mutually exclusive with callIds. Max 500 per request. Repeatable.
​
array
Metric definitions to collect. Max 20 per request. Required unless policyId is given; with policyId, defaults to every metric that policy collects, and each one listed must be in it.
​
string
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.

​
Example

Every command also takes the global options and sets one of the exit codes.