VoiceGateway

List alert incidents and their deliveries in a range

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

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

Incidents in the range. Null means unreported, 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 more than 500 incidents are in the range.

items*array<>

Incidents, newest first.

Example Request
curl -X GET 'https://example.com/api/v1/org/string/project/string/alert-incidents?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,  "items": [    {      "id": "string",      "ruleId": "slow-answer",      "subject": "string",      "state": "firing",      "openedAt": "2019-08-24T14:15:22Z",      "resolvedAt": "2019-08-24T14:15:22Z",      "resolvedBy": "condition",      "occurrences": 1,      "lastOccurrence": {        "at": "2019-08-24T14:15:22Z",        "where": "string",        "detail": "string",        "callId": "string"      },      "holdReason": "string",      "silentSince": "2019-08-24T14:15:22Z",      "deliveries": [        {          "id": "string",          "channel": "email",          "change": "firing",          "state": "pending",          "attempts": 0,          "nextAttemptAt": "2019-08-24T14:15:22Z",          "status": "string",          "message": "string",          "deliveredAt": "2019-08-24T14:15:22Z",          "createdAt": "2019-08-24T14:15:22Z"        }      ]    }  ]}

Was this page helpful?