Alert Episode
Get Alert Episode
Endpoint to retrieve a single Alert Episode by ID
post/alert-episode/{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 Episode to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"episodeNumberWithPrefix": 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,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"title": "This is an example of longer text content that might be stored in this field.",
"description": "# Heading\n\nThis is **markdown** content",
"episodeNumber": 42,
"episodeNumberWithPrefix": "Example short text",
"currentAlertStateId": "123e4567-e89b-12d3-a456-426614174000",
"alertSeverityId": "123e4567-e89b-12d3-a456-426614174000",
"rootCause": "# Heading\n\nThis is **markdown** content",
"lastAlertAddedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"resolvedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"allAlertsResolvedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"firstPagedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"assignedToUserId": "123e4567-e89b-12d3-a456-426614174000",
"assignedToTeamId": "123e4567-e89b-12d3-a456-426614174000",
"alertGroupingRuleId": "123e4567-e89b-12d3-a456-426614174000",
"onCallDutyPolicies": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"isOnCallPolicyExecuted": true,
"alertCount": 42,
"titleTemplate": "This is an example of longer text content that might be stored in this field.",
"descriptionTemplate": "This is an example of longer text content that might be stored in this field.",
"isManuallyCreated": true,
"labels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"isOwnerNotifiedOfEpisodeCreation": true,
"groupingKey": "This is an example of longer text content that might be stored in this field.",
"remediationNotes": "# Heading\n\nThis is **markdown** content",
"postUpdatesToWorkspaceChannels": {
"key": "value",
"nested": {
"data": 123
}
},
"isPrivate": true
}
}Changes
No recorded changes to this operation across all 1 revision of this API.