Incidents Group Post

POST
Lists collections of incidents by groups.

Request

This endpoint expects an object.
group_bystringRequired
The field to group the incidents by.
applies_to_partslist of stringsOptional
Filters for incidents that apply to any of the provided parts.
created_bylist of stringsOptional
Filters for incidents created by any of the provided users.
created_dateobjectOptional
Provides ways to specify date ranges on objects.
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
Allowed values: afterbefore
The iteration mode to use. If "after", then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If "before", then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.
modified_dateobjectOptional
Provides ways to specify date ranges on objects.
owned_bylist of stringsOptional
Filters for incidents owned by any of the provided users.
severitylist of longsOptional
Filters for incidents containing any of the provided severities.
sort_bylist of stringsOptional
Comma-separated fields to sort the incidents by.
stagelist of stringsOptional
Filters for incidents in any of the provided stages.
titlelist of stringsOptional
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.