OverviewPlatformsAPI Reference
Alerts

Update a channel

Changes a channel's label and account events, and a webhook's URL and headers. headers and events replace the old values.

PATCH
/v1/channels/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from POST /v1/api-keys. Keys start with ref_.

In: header

Path Parameters

id*string

The channel's id (dest_...).

Length1 <= length

Request Body

application/json

Fields you leave out stay as they are.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/channels/dest_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "label": "string",  "stats": {    "alerts": 0,    "activeAlerts": 0,    "lastDeliveryAt": "string",    "last7d": {      "total": 0,      "failed": 0    }  },  "createdAt": "string",  "kind": "slack",  "config": {    "channelId": "string",    "channelName": "string",    "events": [      "mention.spike"    ]  }}
Was this page helpful?

Update an alert

Changes an alert. `filter` and `channelIds` replace the old values. Queued digests are cancelled, as are queued sends to a removed channel or from a disabled alert.

Get a mention breakdown

`by` sets the rows (platform, keyword, sentiment, intent, status, hour as weekday and hour, or person), and each row has matched, relevant and sentiment counts. Pick the period with `range` (7d, 30d, 90d or 365d up to today) or with `from` and `to`. Days follow `timezone`, UTC by default. `keywordIds` and `platforms` narrow the data, and `compare=true` adds the equally long period just before. Dates are publish dates.