Platform Impact

Incidents [Paginated]

post

/impact/incidents

This endpoint provides a list of incidents (as well as basic information --see field definitions in the IncidentsData schema) per report date.

You can filter for specific incident statuses, datasets, and report dates. See IncidentsRequest schema for an exhaustive list of filter and aggregation options.

NOTE: In some rare cases, incidents are not attached to any monitors, in that case we cannot check wich dataset they are attached to. These incidents are therefore ignored from the output.

Usage

Use to build reports about the number of incidents at any given time on your Soda Cloud account.

Returns

An object of type IncidentsResult containing an array of IncidentsData.

Find details about the response objects in the Schemas section or by unfurling the response details.

Authorizations

AuthorizationstringRequired

Body

Incidents request JSON Body.

pageinteger · min: 1Optional

Page number

Default: 1

sizeinteger · min: 1 · max: 1000Optional

Page size

Default: 400

dataset_idsstring[]Optional

Dataset IDs (UUIDs from the Soda Cloud platform) to use as filter.

statusstringOptional

String representing the status of issues you want to retrieve. Currently you can retrieve either:

• all 'resolved' issues or
• all 'unresolved' issues

Default: unresolved

from_datetimestring · date-timeOptional

ISO timestamp from which you want to retrieve incidents. Defaults to last 31 days.

Default: 2023-10-09T09:18:16.255021

to_datetimestring · date-timeOptional

ISO timestamp up to which you want to retrieve incidents. Defaults to today.

Default: 2023-11-09T09:18:16.255029

Responses

200

Successful Response

application/json

Array of IncidentsData.

totalintegerRequired

pageintegerRequired

sizeintegerRequired

202

Successful request but no data was returned

application/json

422

Validation Error

application/json

post/impact/incidents

POST /v1/impact/incidents HTTP/1.1
Host: reporting.cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "page": 1,
  "size": 400,
  "dataset_ids": [
    "text"
  ],
  "status": "unresolved",
  "from_datetime": "2023-10-09T09:18:16.255021",
  "to_datetime": "2023-11-09T09:18:16.255029"
}

{
  "total": 1,
  "page": 1,
  "size": 1,
  "data": [
    {
      "incident_id_report_date_id": "text",
      "incident_id": "text",
      "organization_id": "text",
      "created_at": "2026-01-01T00:00:00.000Z",
      "last_updated": "2026-01-01T00:00:00.000Z",
      "check_id": "text",
      "check_result_id": "text",
      "dataset_id": "text",
      "title": "text",
      "check_name": "text",
      "severity": "text",
      "description_notes": "text",
      "resolution_notes": "text",
      "lead_id": "text",
      "lead_email": "text",
      "reporter_id": "text",
      "reporter_email": "text",
      "report_date": "2026-01-01",
      "resolved_at": "2026-01-01T00:00:00.000Z",
      "status": "text"
    }
  ]
}