Group Incidents

1 curl -G https://api.devrev.ai/incidents.group \ 2 -H "Authorization: Bearer <token>" \ 3 -d group_by=group_by

1 { 2 "groups": [ 3 { 4 "incidents": [ 5 { 6 "id": "foo", 7 "title": "foo", 8 "acknowledged_date": "2023-01-01T12:00:00.000Z", 9 "actual_close_date": "2023-01-01T12:00:00.000Z", 10 "applies_to_parts": [ 11 { 12 "display_id": "foo", 13 "id": "foo", 14 "name": "foo", 15 "owned_by": [ 16 null 17 ], 18 "sync_metadata": { 19 "external_reference": "foo", 20 "origin_system": "foo" 21 } 22 } 23 ], 24 "artifacts": [ 25 { 26 "id": "foo", 27 "display_id": "foo", 28 "file": { 29 "type": "foo", 30 "name": "foo", 31 "size": 42 32 } 33 } 34 ], 35 "body": "foo", 36 "created_by": { 37 "display_id": "foo", 38 "id": "foo", 39 "display_name": "foo", 40 "display_picture": { 41 "display_id": "foo", 42 "id": "foo", 43 "file": {} 44 }, 45 "email": "foo", 46 "full_name": "foo", 47 "state": "active" 48 }, 49 "created_date": "2023-01-01T12:00:00.000Z", 50 "custom_fields": {}, 51 "custom_schema_fragments": [ 52 "foo" 53 ], 54 "display_id": "foo", 55 "identified_date": "2023-01-01T12:00:00.000Z", 56 "impact": { 57 "count": { 58 "id": 42, 59 "label": "foo", 60 "ordinal": 42, 61 "value": null 62 }, 63 "customer_ids": [ 64 { 65 "id": "foo", 66 "display_id": "foo", 67 "display_name": "foo" 68 } 69 ] 70 }, 71 "mitigated_date": "2023-01-01T12:00:00.000Z", 72 "modified_by": { 73 "display_id": "foo", 74 "id": "foo", 75 "display_name": "foo", 76 "display_picture": { 77 "display_id": "foo", 78 "id": "foo", 79 "file": {} 80 }, 81 "email": "foo", 82 "full_name": "foo", 83 "state": "active" 84 }, 85 "modified_date": "2023-01-01T12:00:00.000Z", 86 "owned_by": [ 87 { 88 "display_id": "foo", 89 "id": "foo", 90 "display_name": "foo", 91 "display_picture": {}, 92 "email": "foo", 93 "full_name": "foo", 94 "state": "active" 95 } 96 ], 97 "pia": [ 98 { 99 "id": "foo", 100 "article_type": "article", 101 "display_id": "foo", 102 "resource": { 103 "artifacts": [ 104 {} 105 ], 106 "url": "foo" 107 }, 108 "sync_metadata": { 109 "external_reference": "foo", 110 "origin_system": "foo" 111 }, 112 "title": "foo" 113 } 114 ], 115 "playbooks": [ 116 { 117 "id": "foo", 118 "article_type": "article", 119 "display_id": "foo", 120 "resource": { 121 "artifacts": [ 122 {} 123 ], 124 "url": "foo" 125 }, 126 "sync_metadata": { 127 "external_reference": "foo", 128 "origin_system": "foo" 129 }, 130 "title": "foo" 131 } 132 ], 133 "reported_by": { 134 "id": 42, 135 "label": "foo", 136 "ordinal": 42, 137 "value": null 138 }, 139 "severity": { 140 "id": 42, 141 "label": "foo", 142 "ordinal": 42, 143 "value": null 144 }, 145 "source": { 146 "id": 42, 147 "label": "foo", 148 "ordinal": 42, 149 "value": null 150 }, 151 "stage": { 152 "stage": { 153 "id": "foo", 154 "display_id": "foo", 155 "name": "foo" 156 }, 157 "state": { 158 "id": "foo", 159 "display_id": "foo", 160 "is_final": true, 161 "name": "foo" 162 } 163 }, 164 "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id", 165 "subtype": "foo", 166 "sync_metadata": { 167 "external_reference": "foo", 168 "last_sync_in": { 169 "status": "failed", 170 "sync_date": "2023-01-01T12:00:00.000Z", 171 "sync_unit": { 172 "id": "foo", 173 "display_id": "foo", 174 "external_system_type": "adaas", 175 "is_archived": true, 176 "name": "foo", 177 "sync_run": { 178 "mode": "initial", 179 "progress": { 180 "state": "completed" 181 } 182 }, 183 "sync_type": "manual" 184 } 185 }, 186 "last_sync_out": { 187 "status": "failed", 188 "sync_date": "2023-01-01T12:00:00.000Z", 189 "sync_unit": { 190 "id": "foo", 191 "display_id": "foo", 192 "external_system_type": "adaas", 193 "is_archived": true, 194 "name": "foo", 195 "sync_run": { 196 "mode": "initial", 197 "progress": { 198 "state": "completed" 199 } 200 }, 201 "sync_type": "manual" 202 } 203 }, 204 "origin_system": "foo" 205 }, 206 "tags": [ 207 { 208 "tag": { 209 "id": "foo", 210 "name": "foo", 211 "display_id": "foo", 212 "style_new": { 213 "color": "foo" 214 } 215 }, 216 "value": "foo" 217 } 218 ], 219 "target_close_date": "2023-01-01T12:00:00.000Z" 220 } 221 ], 222 "key": { 223 "fields": {} 224 }, 225 "next_cursor": "foo", 226 "prev_cursor": "foo", 227 "total": 42 228 } 229 ], 230 "next_cursor": "foo", 231 "prev_cursor": "foo" 232 }

Lists collections of incidents by groups.

Query parameters

group_bystringRequiredformat: "text"

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.

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

modeenumOptional

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

Allowed values:

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.

sourcelist of longsOptionalDeprecated

Filters for incidents with any of the provided sources.

stagelist of stringsOptional

Filters for incidents in any of the provided stages.

staged_info.is_stagedbooleanOptional

Filters for issues that are staged.

subtypelist of stringsOptional

Filters for incidents with any of the provided subtypes.

sync_metadata.external_referencelist of stringsOptional

Filters for issues with this specific external reference.

sync_metadata.last_sync_in.statuslist of enumsOptional

Filters for works with selected sync statuses.

Allowed values:

sync_metadata.last_sync_in.sync_historylist of stringsOptional

Filters for works modified with selected sync history.

sync_metadata.last_sync_in.sync_unitlist of stringsOptional

Filters for works modified with selected sync units.

sync_metadata.last_sync_out.statuslist of enumsOptional

Filters for works with selected sync statuses.

Allowed values:

sync_metadata.last_sync_out.sync_historylist of stringsOptional

Filters for works modified with selected sync history.

sync_metadata.last_sync_out.sync_unitlist of stringsOptional

Filters for works modified with selected sync units.

sync_metadata.origin_systemlist of stringsOptional

Filters for issues synced from this specific origin system.

titlelist of stringsOptional

Filters for incidents by the provided titles.

Response

Success.

groupslist of objects

The list of groups.

next_cursorstring or nullformat: "text"

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

prev_cursorstring or nullformat: "text"

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

Headers

Query parameters

Response

Errors