VocalDocscontracts 1.65.0

Change the analytics alert settings

PATCH /v1/analytics/alert-settings

PropertyValue
Operationupdate_alert_settings
GroupCall trace and analytics
Scopeanalytics:write
Route classcontrol
IdempotencyNo Idempotency-Key
AuditAudited alert_settings.update (mutation)
Released in1.57.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Writes the next revision of the alert settings at the revision If-Match names (1.57.0), audited with the values before and after. Session only: the api refuses the route to every API key, and to a Member who is not an owner or admin, with 403 forbidden and the detail owner_or_admin_required.

Request

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

curl -X PATCH "$VOCAL_API/v1/analytics/alert-settings" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Content-Type: application/json" \
  -d '{}'

Parameters

NameInTypeRequiredDescription
if-matchheaderstringyesThe revision the change was made against, quoted as the ETag returns it, or * to overwrite.

Request body

Content type application/json, required: AlertSettingsUpdateRequest.

FieldTypeRequiredDescription
latency_regressionLatencyRegressionSettingsInputno
spendSpendAlertSettingsInputno

Responses

StatusContent typeShapeError codes
200application/jsonAlertSettings
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden, org_suspended
412application/jsonErrorEnveloperevision_mismatch
422application/jsonErrorEnvelopevalidation_failed
428application/jsonErrorEnvelopeprecondition_required
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is AlertSettings.

FieldTypeRequiredDescription
latency_regressionLatencyRegressionSettingsyes
object"alert_settings"yes
revisionintegeryesCounts the changes; 0 for the defaults. Returned as the ETag and required in If-Match.
spendSpendAlertSettingsyes
updated_atTimestamp or nullyes
updated_byActorRef or nullyes