VocalDocscontracts 1.65.0

List the built-in analytics alerts

GET /v1/analytics/alerts

PropertyValue
Operationlist_analytics_alerts
GroupCall trace and analytics
Scopeanalytics:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A metadata read; an alert carries kinds, ids and numbers only.
Released in1.57.0
Phase 0 hostServed (the hosted api pins 1.65.0)

The spend threshold, spend forecast and latency regression alerts of the Organization, newest first by opened_at (1.57.0), evaluated hourly by the rollup job; numbers and ids only.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the analytics:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/analytics/alerts" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
kindqueryAnalyticsAlertKindno
statusqueryAnalyticsAlertStatusno

Responses

StatusContent typeShapeError codes
200application/jsonAnalyticsAlertList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is AnalyticsAlertList.

FieldTypeRequiredDescription
dataarray of AnalyticsAlertyesThe analytics alerts of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes