bayesline.api.IncidentsServiceApi.get_incident_summary

abstract IncidentsServiceApi.get_incident_summary(start_date: str | date | datetime | None = None, end_date: str | date | datetime | None = None, start_idx: int = 0, end_idx: int = 999999999) → IncidentSummary

Obtains incident summaries for the given date and index range.

Parameters

start_dateDateLike | None, optional

The start date of the range. If None, the last 24 hours are used.

end_dateDateLike | None, optional

The end date of the range. If None, now is used.

start_idxint, optional

The start index of the range, 0 being first. Default is 0.

end_idxint, optional

The end index of the range, -1 being last. Default is 999999999.

Returns

IncidentSummary

The incident summary.