v2

latestSwagger 2.02026-07-26109144190.4 KB
Reporting

Get/search incident history

Retrieve incident history for your company, searching over date ranges and with filtering options.

This API may be called a maximum of once a minute.

Incident requests are paginated with a offset and limit query string parameters. The query for incidents is run and offset records are skipped, after which limit records will be returned.

The default offset is 0 and the default limit is 20. The maximum value allowed for limit is 100.

Unless specified otherwise with the parameter currentPhase, the response will only contain resolved incidents.

On return, the total number of records available for that query will be returned in the payload as 'total'.

get/api-reporting/v2/incidents

Query parameters

offsetnumber

The offset within the set of matching incidents

limitnumber

The maximum number of matching incidents to return (100 max)

entityIdstring

The entity ID involved This is the unique identifier for the entity causing the incident.

incidentNumberstring

The incident number as shown in VictorOps Multiple values and ranges are allowed: 4,5,20:50

startedAfterstring

Return incidents started after this timestamp Specify the timestamp in ISO8601 format

startedBeforestring

Find incidents started before this timestamp Specify the timestamp in ISO8601 format

hoststring

The host involved in the incident Multiple values can be separated with commas.

servicestring

The service involved in the incident (if any) Multiple values can be separated with commas.

currentPhasestring

The current phase of the incident "resolved", "triggered" or "acknowledged". Multiple values can be separated with commas. By default, response contains only "resolved" incidents

routingKeystring

The original routing of the incident

Headers

X-VO-Api-Idstring required

Your API ID

X-VO-Api-Keystring required

Your API Key

Response

The list of incidents matching the request filters

offsetinteger

The pagination offset

limitinteger

The maximum number of incidents to fetch

totalinteger

The total incidents matching the supplied parameters