Skip to Content
List Incidents
get

Returns a list of incidents.

Request path & query params
limit
integer
(default: 25)

Number of items to include in the response

page
integer
(default: 1)

Offset by this many pages, of the size of limit

order_by
string
Possible values: "negative_impact""value""views""field"

Value to order the results by

order_direction
string
Possible values: "asc""desc"

Sort order.

status
string
Possible values: "open""closed""expired"

Status to filter incidents by

severity
string
Possible values: "warning""alert"

Severity to filter incidents by

get
200
/data/v1/incidents
Response
(application/json)
{
  "data": [
    {
      "affected_views": 71,
      "affected_views_per_hour": 29,
      "affected_views_per_hour_on_open": 75,
      "breakdowns": [
        {
          "id": "abcdef",
          "name": "error_type_id",
          "value": "697070"
        }
      ],
      "description": "Something is broken",
      "error_description": "No seriously, something is really really broken :(",
      "id": "4u13td",
      "impact": "*71 views* were affected at a rate of *29 per hour*",
      "incident_key": "5312a7c0bbb5d8353bd88602f01fe58eb15e9febac8fd2f0d8ce8f1cb138145c",
      "measured_value": 5.9,
      "measured_value_on_close": 0.1,
      "measurement": "error_rate",
      "notification_rules": [],
      "notifications": [
        {
          "attempted_at": "2021-01-05T09:52:15.119040Z",
          "id": 103014,
          "queued_at": "2021-01-05T09:52:14.945157Z"
        },
        {
          "attempted_at": "2021-01-05T11:31:08.244462Z",
          "id": 102025,
          "queued_at": "2021-01-05T11:31:08.061924Z"
        }
      ],
      "resolved_at": "2021-01-05T11:31:04.000000Z",
      "sample_size": 1000,
      "sample_size_unit": "views",
      "severity": "alert",
      "started_at": "2021-01-05T09:04:46.000000Z",
      "status": "closed",
      "threshold": 5
    },
    {
      "affected_views": 132,
      "affected_views_per_hour": 11,
      "affected_views_per_hour_on_open": 65,
      "breakdowns": [
        {
          "id": "abcdef",
          "name": "video_title",
          "value": "Layla the dog video 1337"
        },
        {
          "id": "abcdef",
          "name": "error_type_id",
          "value": "697065"
        }
      ],
      "description": "Something else is broken",
      "error_description": "Detailed error: On no!",
      "id": "rd9579",
      "impact": "*132 views* were affected at a rate of *11 per hour*",
      "incident_key": "fd9add7a85a013d768f4039f9e726133eddb476c2f16b22ebfe56f18f7c03b27",
      "measured_value": 97,
      "measured_value_on_close": 1,
      "measurement": "error_rate",
      "notification_rules": [],
      "notifications": [
        {
          "attempted_at": "2020-12-31T09:26:19.416919Z",
          "id": 102198,
          "queued_at": "2020-12-31T09:26:18.987717Z"
        },
        {
          "attempted_at": "2020-12-31T20:23:57.279325Z",
          "id": 101269,
          "queued_at": "2020-12-31T20:23:56.997068Z"
        }
      ],
      "resolved_at": "2020-12-31T20:22:54.000000Z",
      "sample_size": 100,
      "sample_size_unit": "views",
      "severity": "alert",
      "started_at": "2020-12-31T07:56:22.000000Z",
      "status": "closed",
      "threshold": 96
    }
  ],
  "timeframe": [
    1610035979,
    1610122379
  ],
  "total_row_count": 2
}