Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Body

application/json

Input for creating and running a metric collection job. Limits: ≤500 conversations, ≤20 metrics, ≤5000 total items per request.

metrics
object[]
required

Metric definitions to collect. Max 20 per request.

Required array length: 1 - 20 elements
callIds
string<uuid>[]

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

Required array length: 1 - 500 elements
chatIds
string<uuid>[]

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

Required array length: 1 - 500 elements

Response

The created metric collection job

data
object
required

A metric collection job that processes metrics for calls or chats