Status200
Ресурс

Incident Grouping Rule

Configure rules for automatically grouping related incidents into episodes

Модель Incident Grouping Rule

Свойства

  • Имя
    _id
    Тип
    Object ID
    Описание

    ID of this object

  • Имя
    createdAt
    Тип
    Date
    Описание

    Date and Time when the object was created.

  • Имя
    updatedAt
    Тип
    Date
    Описание

    Date and Time when the object was updated.

  • Имя
    project
    Тип
    Project
    Описание

    Relation to Project Resource in which this object belongs

  • Имя
    projectId
    Тип
    Object IDОбязательно
    Описание

    ID of your Project in which this object belongs

  • Имя
    name
    Тип
    TextОбязательно
    Описание

    Name of this incident grouping rule

  • Имя
    description
    Тип
    Long Text
    Описание

    Description of this incident grouping rule

  • Имя
    priority
    Тип
    NumberОбязательно
    Описание

    Priority of this rule. Lower number = higher priority. Rules are evaluated in priority order.

  • Имя
    isEnabled
    Тип
    BooleanОбязательно
    Описание

    Whether this rule is enabled

  • Имя
    matchCriteria
    Тип
    JSON
    Описание

    JSON object defining the criteria for matching incidents to this rule

  • Имя
    monitors
    Тип
    Monitor
    Описание

    Only group incidents from these monitors. Leave empty to match incidents from any monitor.

  • Имя
    incidentSeverities
    Тип
    Incident Severity
    Описание

    Only group incidents with these severities. Leave empty to match incidents of any severity.

  • Имя
    incidentLabels
    Тип
    Label
    Описание

    Only group incidents that have at least one of these labels. Leave empty to match incidents regardless of incident labels.

  • Имя
    monitorLabels
    Тип
    Label
    Описание

    Only group incidents from monitors that have at least one of these labels. Leave empty to match incidents regardless of monitor labels.

  • Имя
    incidentTitlePattern
    Тип
    Long Text
    Описание

    Regular expression pattern to match incident titles. Leave empty to match any title. Example: 'CPU.*high' matches titles containing 'CPU' followed by 'high'.

  • Имя
    incidentDescriptionPattern
    Тип
    Long Text
    Описание

    Regular expression pattern to match incident descriptions. Leave empty to match any description.

  • Имя
    monitorNamePattern
    Тип
    Long Text
    Описание

    Regular expression pattern to match monitor names. Leave empty to match any monitor name. Example: 'prod-.*' matches monitors starting with 'prod-'.

  • Имя
    monitorDescriptionPattern
    Тип
    Long Text
    Описание

    Regular expression pattern to match monitor descriptions. Leave empty to match any monitor description.

  • Имя
    groupByMonitor
    Тип
    Boolean
    Описание

    When enabled, incidents from different monitors will be grouped into separate episodes. When disabled, incidents from any monitor can be grouped together.

  • Имя
    groupBySeverity
    Тип
    Boolean
    Описание

    When enabled, incidents with different severities will be grouped into separate episodes. When disabled, incidents of any severity can be grouped together.

  • Имя
    groupByIncidentTitle
    Тип
    Boolean
    Описание

    When enabled, incidents with different titles will be grouped into separate episodes. When disabled, incidents with any title can be grouped together.

  • Имя
    groupByService
    Тип
    Boolean
    Описание

    When enabled, incidents from monitors belonging to different services will be grouped into separate episodes. When disabled, incidents can be grouped together regardless of which service the monitor belongs to.

  • Имя
    enableTimeWindow
    Тип
    Boolean
    Описание

    Enable time-based grouping. When enabled, incidents are grouped within the specified time window. When disabled, all matching incidents are grouped into a single ongoing episode regardless of time.

  • Имя
    timeWindowMinutes
    Тип
    Number
    Описание

    Rolling time window in minutes. Incidents are grouped if they arrive within this gap from the last incident.

  • Имя
    groupByFields
    Тип
    JSON
    Описание

    JSON object defining the fields to group incidents by (e.g., monitorId, severity)

  • Имя
    episodeTitleTemplate
    Тип
    Long Text
    Описание

    Template for generating episode titles. Supports placeholders like {{incidentSeverity}}, {{monitorName}}, {{incidentTitle}}, {{incidentDescription}}

  • Имя
    episodeDescriptionTemplate
    Тип
    Long Text
    Описание

    Template for generating episode descriptions. Supports placeholders like {{incidentSeverity}}, {{monitorName}}, {{incidentTitle}}, {{incidentDescription}}

  • Имя
    enableResolveDelay
    Тип
    Boolean
    Описание

    Enable grace period before auto-resolving episode after all incidents resolve. Helps prevent rapid state changes during incident flapping.

  • Имя
    resolveDelayMinutes
    Тип
    Number
    Описание

    Grace period in minutes before auto-resolving an episode after all incidents are resolved

  • Имя
    enableReopenWindow
    Тип
    Boolean
    Описание

    Enable reopening recently resolved episodes instead of creating new ones. Useful when related issues recur shortly after resolution.

  • Имя
    reopenWindowMinutes
    Тип
    Number
    Описание

    Time window in minutes to reopen a recently resolved episode instead of creating a new one

  • Имя
    enableInactivityTimeout
    Тип
    Boolean
    Описание

    Enable auto-resolving episodes after a period of inactivity. Helps automatically close episodes when no new incidents arrive.

  • Имя
    inactivityTimeoutMinutes
    Тип
    Number
    Описание

    Time in minutes after which an inactive episode will be auto-resolved

  • Имя
    onCallDutyPolicies
    Тип
    On-Call Policy
    Описание

    List of on-call duty policies to execute for episodes created by this rule.

  • Имя
    defaultAssignToUser
    Тип
    User
    Описание

    Default user to assign episodes created by this rule

  • Имя
    defaultAssignToUserId
    Тип
    Object ID
    Описание

    Default User ID to assign episodes created by this rule

  • Имя
    defaultAssignToTeam
    Тип
    Team
    Описание

    Default team to assign episodes created by this rule

  • Имя
    defaultAssignToTeamId
    Тип
    Object ID
    Описание

    Default Team ID to assign episodes created by this rule

  • Имя
    episodeLabels
    Тип
    Label
    Описание

    Labels to automatically apply to episodes created by this rule.

  • Имя
    episodeOwnerUsers
    Тип
    User
    Описание

    Users to automatically add as owners to episodes created by this rule.

  • Имя
    episodeOwnerTeams
    Тип
    Team
    Описание

    Teams to automatically add as owners to episodes created by this rule.

  • Имя
    episodeMemberRoles
    Тип
    Incident Role
    Описание

    Incident roles to display in the episode members form. Select the roles that can be assigned to episode members.

  • Имя
    episodeMemberRoleAssignments
    Тип
    JSON
    Описание

    Users with specific incident roles to automatically add as members to episodes created by this rule. Each assignment includes a user ID and an incident role ID.

  • Имя
    createdByUser
    Тип
    User
    Описание

    Relation to User who created this object (if this object was created by a User)

  • Имя
    createdByUserId
    Тип
    Object ID
    Описание

    User ID who created this object (if this object was created by a User)

  • Имя
    showEpisodeOnStatusPage
    Тип
    BooleanОбязательно
    Описание

    Should episodes created by this rule be shown on the status page?

GETorPOST/api/incident-grouping-rule/get-list

Список

Этот метод возвращает постраничный список ваших объектов «Incident Grouping Rule». По умолчанию на странице до десяти записей.

Необязательные query-параметры

  • limit
    число
    Сколько объектов вернуть. По умолчанию 10, максимум 100
  • skip
    число
    Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

Запрос списка

POST
/api/incident-grouping-rule/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "isEnabled": true,
    "name": true,
    "priority": true,
    "projectId": true,
    "showEpisodeOnStatusPage": true
  },
  "query": {
    "name": "Example name"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "3770ce60-28fe-11f1-b591-3fdcef396aba",
      "isEnabled": true,
      "name": "Example name",
      "priority": 100,
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "showEpisodeOnStatusPage": true
    },
    {
      "_id": "3770ce61-28fe-11f1-b591-3fdcef396aba",
      "isEnabled": true,
      "name": "Example name",
      "priority": 100,
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "showEpisodeOnStatusPage": true
    },
    {
      "_id": "3770ce62-28fe-11f1-b591-3fdcef396aba",
      "isEnabled": true,
      "name": "Example name",
      "priority": 100,
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "showEpisodeOnStatusPage": true
    }
  ]
}
GETorPOST/api/incident-grouping-rule/:id/get-item

Получить по ID

Возвращает объект «Incident Grouping Rule» по идентификатору.

  • id
    строка
    ID объекта

Необязательное тело запроса

  • select
    По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST
/api/incident-grouping-rule/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "isEnabled": true,
    "name": true,
    "priority": true,
    "projectId": true,
    "showEpisodeOnStatusPage": true
  }
}

Ответ

{
  "_id": "3770ce60-28fe-11f1-b591-3fdcef396aba",
  "isEnabled": true,
  "name": "Example name",
  "priority": 100,
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "showEpisodeOnStatusPage": true
}
POST/api/incident-grouping-rule/count

Количество

Возвращает количество ваших объектов «Incident Grouping Rule».

Необязательное тело запроса

Запрос количества

POST
/api/incident-grouping-rule/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "name": "Example name"
  }
}

Ответ

{
  "count": 107
}
POST/api/incident-grouping-rule

Создать Incident Grouping Rule

Создаёт новый объект.

Запрос создания

POST
/api/incident-grouping-rule
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "isEnabled": true,
    "name": "Example name",
    "priority": 100,
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "showEpisodeOnStatusPage": true
  }
}

Ответ

{
  "_id": "3770ce60-28fe-11f1-b591-3fdcef396aba",
  "isEnabled": true,
  "name": "Example name",
  "priority": 100,
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "showEpisodeOnStatusPage": true
}
PUT/api/incident-grouping-rule/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/incident-grouping-rule/:id/update-item
GET/api/incident-grouping-rule/:id/update-item

Запрос обновления

PUT
/api/incident-grouping-rule/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "isEnabled": true,
    "name": "Example name",
    "priority": 100
  }
}

Ответ

{}
DELETE/api/incident-grouping-rule/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/incident-grouping-rule/:id/delete-item
GET/api/incident-grouping-rule/:id/delete-item

Запрос удаления

DELETE
/api/incident-grouping-rule/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения Incident Grouping Rule

  • Project Owner
  • Project Admin
  • Project Member
  • Read Incident Grouping Rule
  • Read All Project Resources

Права на создание

Нужны для создания Incident Grouping Rule

  • Project Owner
  • Project Admin
  • Create Incident Grouping Rule

Права на обновление

Нужны для обновления Incident Grouping Rule

  • Project Owner
  • Project Admin
  • Edit Incident Grouping Rule

Права на удаление

Нужны для удаления Incident Grouping Rule

  • Project Owner
  • Project Admin
  • Delete Incident Grouping Rule