VoiceGateway

What each alert rule would have fired on in a range

GET
/api/v1/org/{orgId}/project/{projectId}/alert-events

Authorization

cookievg_session<token>

The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.

Path Parameters

orgId*string

Authorised orgId; the server must verify organisation/project ownership before any read.

Length1 <= length
projectId*string

Authorised projectId; the server must verify organisation/project ownership before any read.

Length1 <= length

Query Parameters

from*string

Inclusive UTC start of the range.

Formatdate-time
to*string

Exclusive UTC end of the range.

Formatdate-time

Response Body

Authorised read result. Null means unreported or incomplete, never zero.

application/json
  1. response
from*string

Inclusive range start, UTC.

Formatdate-time
to*string

Exclusive range end, UTC.

Formatdate-time
complete*boolean

false when part of the range is not stored, so a rule may have fired more often than listed.

rules*array<>

One entry per console rule, in the alerts-model.ts order.

Example Request
curl -X GET 'https://example.com/api/v1/org/string/project/string/alert-events?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z'
Example Response
{  "from": "2019-08-24T14:15:22Z",  "to": "2019-08-24T14:15:22Z",  "complete": true,  "rules": [    {      "ruleId": "slow-answer",      "state": "string",      "events": [        {          "at": "2019-08-24T14:15:22Z",          "where": "string",          "detail": "string",          "callId": "string"        }      ]    }  ]}

Was this page helpful?