| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Scope
live-subscriptions:write
Body Response - Example
{
"queries": [
{
"id": "7b8deafb74bf490288220fd3543b76af",
"metadata": {
"name": "arrived_contacts"
},
"params": {},
"filters": {
"ring_groups": [
"agents"
],
"range": {
"type": "interval",
"interval": 86400
}
}
}
]
}Body Response - Schema
200 (query from subscription)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | subscription entry unique identifier | no |
| _links | object | "_links" subdivides into: 1 - "stream" (object) 2 - "self" (object) | no |
| _embedded | object | "_embedded" subdivides into: 1 - "entries" (array[object]) 1.1 - "params" (object) - set of parameters for the query. 1.2 - "metadata" (object) - metadata related with the use of the query on the customer's end. 1.3 - "id" (string) - subscription entry unique identifier. 1.4 - "query_id" (string) - query unique identifier. 1.5 - "filters" (object) - set of filters for the query. 1.6 - "_links" (object) | no |
400 (bad request), 401 (unauthorized access), 403 (forbidden access), 404 (subscription not found), 415 (unsupported media type)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
TroubleshootingIf you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.
Body Request ParametersThe body of the request consists of a parameter called
queries, an array of objects that subdivides intoid,metadata,paramsandfilters.queriesconsists of a list of desired queries (i.e., metrics) which the customer wants to subscribe to.