Incident Measurement
Get Incident Measurement
Endpoint to retrieve a single Incident Measurement by ID
post/incident-measurement/{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 Incident Measurement to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"name": true,
"key": true,
"metricName": true,
"startAnchorType": true,
"endAnchorType": 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",
"name": "Time to Detect",
"key": "time-to-detect",
"description": "This is an example of longer text content that might be stored in this field.",
"metricName": "oneuptime.incident.measurement.time-to-detect",
"startAnchorType": "Impact Started At",
"endAnchorType": "State Role Entered",
"startIncidentStateId": "123e4567-e89b-12d3-a456-426614174000",
"endIncidentStateId": "123e4567-e89b-12d3-a456-426614174000",
"startIncidentStateRole": "Acknowledged",
"endIncidentStateRole": "Resolved",
"startStateOccurrence": "First",
"endStateOccurrence": "First",
"unit": "seconds",
"aggregationType": "Avg",
"isEnabled": true,
"showOnIncidentView": true,
"order": 42,
"isSystemDefined": true,
"backfillRequestedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"backfillCursorCreatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"backfillCompletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.