Group Incidents (POST)

POST

Lists collections of incidents by groups.

Request

This endpoint expects an object.
acknowledged_dateobjectRequired

Provides ways to specify date ranges on objects.

actual_close_dateobjectRequired

Provides ways to specify date ranges on objects.

created_dateobjectRequired

Provides ways to specify date ranges on objects.

group_bystringRequiredformat: "text"

The field to group the incidents by.

identified_dateobjectRequired

Provides ways to specify date ranges on objects.

mitigated_dateobjectRequired

Provides ways to specify date ranges on objects.

modeenumRequired
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_dateobjectRequired

Provides ways to specify date ranges on objects.

staged_infoobjectRequired
sync_metadataobjectRequired
target_close_dateobjectRequired

Provides ways to specify date ranges on objects.

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.

cursorstringOptionalformat: "text"

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

custom_fieldsobjectOptional

Filters for custom fields.

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’.

owned_bylist of stringsOptional

Filters for incidents owned by any of the provided users.

pialist of stringsOptional

Filters for incidents with any of the provided PIAs.

playbookslist of stringsOptional

Filters for incidents with any of the provided playbooks.

related_docslist of stringsOptional

Filters for incidents with any of the provided related docs.

reported_bylist of longsOptional

Filters for incidents with any of the provided reporters.

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.

subtypelist of stringsOptional

Filters for incidents with any of the provided subtypes.

titlelist of stringsOptional

Filters for incidents by the provided titles.

sourcelist of longsOptionalDeprecated

Filters for incidents with any of the provided sources.

Response

Success.

groupslist of objects

The list of groups.

next_cursorstringOptionalformat: "text"

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

prev_cursorstringOptionalformat: "text"

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

Built with