Incidents Group

GET

Lists collections of incidents by groups.

Query parameters

group_bystringRequired

The field to group the incidents by.

applies_to_partsstringOptional

Filters for incidents that apply to any of the provided parts.

created_bystringOptional

Filters for incidents created by any of the provided users.

cursorstringOptional

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

limitintegerOptional

The maximum number of groups to return. If not set, then the default is ‘10’.

limit_per_groupintegerOptional

The maximum number of incidents to return for an individual group. The default is ‘50’.

mode"after" or "before"Optional

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore
owned_bystringOptional

Filters for incidents owned by any of the provided users.

piastringOptional

Filters for incidents with any of the provided PIAs.

playbookstringOptional

Filters for incidents with any of the provided playbooks.

related_docsstringOptional

Filters for incidents with any of the provided related docs.

reported_bylongOptional

Filters for incidents with any of the provided reporters.

severitylongOptional

Filters for incidents containing any of the provided severities.

sort_bystringOptional

Comma-separated fields to sort the incidents by.

sourcelongOptional

Filters for incidents with any of the provided sources.

stagestringOptional

Filters for incidents in any of the provided stages.

subtypestringOptional

Filters for incidents with any of the provided subtypes.

titlestringOptional

Filters for incidents by the provided titles.

Response

This endpoint returns an object.
groupslist of objects

The list of groups.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.