Alert Grouping Rule
Get Alert Grouping Rule
Endpoint to retrieve a single Alert Grouping Rule by ID
post/alert-grouping-rule/{id}/get-item
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Alert Grouping Rule to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"name": true
}
}Response
Successful response
Example response
{
"data": {
"_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"version": 42,
"criteria": {
"key": "value",
"nested": {
"data": 123
}
},
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"name": "Example short text",
"description": "This is an example of longer text content that might be stored in this field.",
"priority": 42,
"isEnabled": true,
"matchCriteria": {
"key": "value",
"nested": {
"data": 123
}
},
"monitors": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"alertSeverities": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"alertLabels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"monitorLabels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"alertTitlePattern": "This is an example of longer text content that might be stored in this field.",
"alertDescriptionPattern": "This is an example of longer text content that might be stored in this field.",
"monitorNamePattern": "This is an example of longer text content that might be stored in this field.",
"monitorDescriptionPattern": "This is an example of longer text content that might be stored in this field.",
"groupByMonitor": true,
"groupBySeverity": true,
"groupByAlertTitle": true,
"groupByAlertLabels": true,
"groupByMonitorLabels": true,
"enableTimeWindow": true,
"timeWindowMinutes": 42,
"groupByFields": {
"key": "value",
"nested": {
"data": 123
}
},
"episodeTitleTemplate": "This is an example of longer text content that might be stored in this field.",
"episodeDescriptionTemplate": "This is an example of longer text content that might be stored in this field.",
"enableResolveDelay": true,
"resolveDelayMinutes": 42,
"enableReopenWindow": true,
"reopenWindowMinutes": 42,
"enableInactivityTimeout": true,
"inactivityTimeoutMinutes": 42,
"onCallDutyPolicies": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"defaultAssignToUserId": "123e4567-e89b-12d3-a456-426614174000",
"defaultAssignToTeamId": "123e4567-e89b-12d3-a456-426614174000",
"episodeLabels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"episodeOwnerUsers": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"episodeOwnerTeams": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.