Group Incidents (POST)
Lists collections of incidents by groups.
All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN>
as a header to every API request.
How do I find my token?
In: header
Provides ways to specify date ranges on objects.
Filters for objects created after the provided timestamp (inclusive).
date-time
Filters for objects created before the provided timestamp (inclusive).
date-time
Provides preset types for date filter.
The range starts from the current timestamp and continues for the past n days.
0 <= value <= 4294967295
The range starts from the current timestamp and continues for the next n days.
0 <= value <= 4294967295
Provides ways to specify date ranges on objects.
Filters for objects created after the provided timestamp (inclusive).
date-time
Filters for objects created before the provided timestamp (inclusive).
date-time
Provides preset types for date filter.
The range starts from the current timestamp and continues for the past n days.
0 <= value <= 4294967295
The range starts from the current timestamp and continues for the next n days.
0 <= value <= 4294967295
Filters for incidents that apply to any of the provided parts.
Filters for incidents created by any of the provided users.
Provides ways to specify date ranges on objects.
Filters for objects created after the provided timestamp (inclusive).
date-time
Filters for objects created before the provided timestamp (inclusive).
date-time
Provides preset types for date filter.
The range starts from the current timestamp and continues for the past n days.
0 <= value <= 4294967295
The range starts from the current timestamp and continues for the next n days.
0 <= value <= 4294967295
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
text
Filters for custom fields.
Empty Object
The field to group the incidents by.
text
Provides ways to specify date ranges on objects.
Filters for objects created after the provided timestamp (inclusive).
date-time
Filters for objects created before the provided timestamp (inclusive).
date-time
Provides preset types for date filter.
The range starts from the current timestamp and continues for the past n days.
0 <= value <= 4294967295
The range starts from the current timestamp and continues for the next n days.
0 <= value <= 4294967295
The maximum number of groups to return. If not set, then the default is '10'.
int32
The maximum number of incidents to return for an individual group. The default is '50'.
int32
Provides ways to specify date ranges on objects.
Filters for objects created after the provided timestamp (inclusive).
date-time
Filters for objects created before the provided timestamp (inclusive).
date-time
Provides preset types for date filter.
The range starts from the current timestamp and continues for the past n days.
0 <= value <= 4294967295
The range starts from the current timestamp and continues for the next n days.
0 <= value <= 4294967295
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.
"after" | "before"
Provides ways to specify date ranges on objects.
Filters for objects created after the provided timestamp (inclusive).
date-time
Filters for objects created before the provided timestamp (inclusive).
date-time
Provides preset types for date filter.
The range starts from the current timestamp and continues for the past n days.
0 <= value <= 4294967295
The range starts from the current timestamp and continues for the next n days.
0 <= value <= 4294967295
Filters for incidents owned by any of the provided users.
Filters for incidents with any of the provided PIAs.
Filters for incidents with any of the provided playbooks.
Filters for incidents with any of the provided related docs.
Filters for incidents with any of the provided reporters.
Filters for incidents containing any of the provided severities.
Comma-separated fields to sort the incidents by.
Filters for incidents with any of the provided sources.
Filters for incidents in any of the provided stages.
Filters for incidents with any of the provided subtypes.
Provides ways to specify date ranges on objects.
Filters for objects created after the provided timestamp (inclusive).
date-time
Filters for objects created before the provided timestamp (inclusive).
date-time
Provides preset types for date filter.
The range starts from the current timestamp and continues for the past n days.
0 <= value <= 4294967295
The range starts from the current timestamp and continues for the next n days.
0 <= value <= 4294967295
Filters for incidents by the provided titles.
Response Body
curl -X POST "https://api.devrev.ai/incidents.group" \ -H "Content-Type: application/json" \ -d '{ "group_by": "string" }'
{
"groups": [
{
"incidents": [
{
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"acknowledged_date": "2023-01-01T12:00:00.000Z",
"actual_close_date": "2023-01-01T12:00:00.000Z",
"applies_to_parts": [
{
"type": "capability",
"display_id": "string",
"id": "string",
"name": "string",
"owned_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"sync_metadata": {
"external_reference": "string",
"origin_system": "string"
}
}
],
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"body": "string",
"custom_fields": {},
"custom_schema_fragments": [
"don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
],
"identified_date": "2023-01-01T12:00:00.000Z",
"impact": {
"count": {
"id": 0,
"label": "string",
"ordinal": 0,
"value": null
},
"customer_ids": [
{
"display_id": "string",
"id": "string",
"display_name": "string"
}
]
},
"mitigated_date": "2023-01-01T12:00:00.000Z",
"owned_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"pia": [
{
"display_id": "string",
"id": "string",
"article_type": "article",
"resource": {
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"url": "string"
},
"sync_metadata": {
"external_reference": "string",
"origin_system": "string"
},
"title": "string"
}
],
"playbooks": [
{
"display_id": "string",
"id": "string",
"article_type": "article",
"resource": {
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"url": "string"
},
"sync_metadata": {
"external_reference": "string",
"origin_system": "string"
},
"title": "string"
}
],
"reported_by": {
"id": 0,
"label": "string",
"ordinal": 0,
"value": null
},
"severity": {
"id": 0,
"label": "string",
"ordinal": 0,
"value": null
},
"source": {
"id": 0,
"label": "string",
"ordinal": 0,
"value": null
},
"stage": {
"stage": {
"display_id": "string",
"id": "string",
"name": "string"
},
"state": {
"display_id": "string",
"id": "string",
"is_final": true,
"name": "string"
}
},
"stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
"subtype": "string",
"sync_metadata": {
"external_reference": "string",
"last_sync_in": {
"status": "failed",
"sync_date": "2023-01-01T12:00:00.000Z",
"sync_unit": {
"display_id": "string",
"id": "string",
"external_system_type": "adaas",
"is_archived": true,
"name": "string",
"sync_run": {
"mode": "initial",
"progress": {
"state": "completed"
}
},
"sync_type": "manual"
}
},
"last_sync_out": {
"status": "failed",
"sync_date": "2023-01-01T12:00:00.000Z",
"sync_unit": {
"display_id": "string",
"id": "string",
"external_system_type": "adaas",
"is_archived": true,
"name": "string",
"sync_run": {
"mode": "initial",
"progress": {
"state": "completed"
}
},
"sync_type": "manual"
}
},
"origin_system": "string"
},
"tags": [
{
"tag": {
"display_id": "string",
"id": "string",
"name": "string",
"style_new": {
"color": "string"
}
},
"value": "string"
}
],
"target_close_date": "2023-01-01T12:00:00.000Z",
"title": "string"
}
],
"key": {
"type": "bool",
"value": true
},
"next_cursor": "string",
"prev_cursor": "string",
"total": 0
}
],
"next_cursor": "string",
"prev_cursor": "string"
}
{
"detail": "string",
"message": "string",
"type": "artifact_already_attached_to_a_parent",
"existing_parent": "string",
"is_same": true
}
{
"detail": "string",
"message": "string",
"type": "unauthenticated"
}
{
"detail": "string",
"message": "string",
"type": "forbidden"
}
{
"detail": "string",
"message": "string",
"type": "too_many_requests",
"retry_after": 0
}
{
"detail": "string",
"message": "string",
"type": "internal_error",
"reference_id": "string"
}
{
"detail": "string",
"message": "string",
"type": "service_unavailable"
}