--- title: "Get Incident Measurement" method: POST path: "/incident-measurement/{id}/get-item" tags: ["Incident Measurement"] --- # Get Incident Measurement `POST /incident-measurement/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/incident-measurement/{id}/get-item` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to retrieve a single Incident Measurement by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` IncidentMeasurementSelectSchema: Select schema for IncidentMeasurement. Set fields to true to include them in the response. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `name` boolean - `key` boolean - `description` boolean - `metricName` boolean - `startAnchorType` boolean - `endAnchorType` boolean - `startIncidentStateId` boolean - `endIncidentStateId` boolean - `startIncidentStateRole` boolean - `endIncidentStateRole` boolean - `startStateOccurrence` boolean - `endStateOccurrence` boolean - `unit` boolean - `aggregationType` boolean - `isEnabled` boolean - `showOnIncidentView` boolean - `order` boolean - `isSystemDefined` boolean - `backfillRequestedAt` boolean - `backfillCursorCreatedAt` boolean - `backfillCompletedAt` boolean - `createdByUserId` boolean ## Response `200` Successful response - object - `data` IncidentMeasurement - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `version` number: Object version - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [No access - you don't have permission for this operation] - `name` string, required: Human readable name of this measurement, such as Time to Acknowledge. This is what charts call it. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `key` string: Stable, machine readable identifier for this measurement, unique within the project: lowercase letters, numbers and hyphens. Leave it out and it is made from the name - Time to Detect becomes time-to-detect, with -2, -3 and so on added when another measurement already has it. It cannot be changed once the measurement is created, because it is used to build the metric name that every recorded point is written under; to rename a measurement, change the Name instead. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [No access - you don't have permission for this operation] - `description` string: Description of what this measurement means to your team. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `metricName` string, required: The metric name every recorded point of this measurement is written under. Derived from the key as oneuptime.incident.measurement. and maintained for you. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [No access - you don't have permission for this operation] - `startAnchorType` 'Impact Started At' | 'Declared At' | 'Created At' | 'Timeline Start' | 'State Entered' | 'State Role Entered' | 'Postmortem Posted At' | 'First Paged At', required: Where this measurement starts. One of: Impact Started At, Declared At, Created At, Timeline Start, State Entered, State Role Entered, Postmortem Posted At, First Paged At. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `endAnchorType` 'Impact Started At' | 'Declared At' | 'Created At' | 'Timeline Start' | 'State Entered' | 'State Role Entered' | 'Postmortem Posted At' | 'First Paged At', required: Where this measurement ends. One of: Impact Started At, Declared At, Created At, Timeline Start, State Entered, State Role Entered, Postmortem Posted At, First Paged At. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `startIncidentStateId` string, uuid: ID of the incident state this measurement starts at. Required only when the Start Anchor Type is State Entered. Cleared if that state is deleted, at which point the measurement reports Not Applicable rather than a wrong number. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `endIncidentStateId` string, uuid: ID of the incident state this measurement ends at. Required only when the End Anchor Type is State Entered. Cleared if that state is deleted, at which point the measurement reports Not Applicable rather than a wrong number. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `startIncidentStateRole` 'Created' | 'Acknowledged' | 'Resolved': The role of the state this measurement starts at - Created, Acknowledged or Resolved. Used when the Start Anchor Type is State Role Entered. Resolving by role keeps the measurement working when a project renames or replaces the state that plays that part. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `endIncidentStateRole` 'Created' | 'Acknowledged' | 'Resolved': The role of the state this measurement ends at - Created, Acknowledged or Resolved. Used when the End Anchor Type is State Role Entered. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `startStateOccurrence` 'First' | 'Last': Which entry to use when the start state is entered more than once - First or Last. First matches the built-in incident metrics; Last follows a reopened incident to its final pass through that state. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `endStateOccurrence` 'First' | 'Last': Which entry to use when the end state is entered more than once - First or Last. First matches the built-in incident metrics; Last follows a reopened incident to its final pass through that state. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `unit` string: The unit this measurement's charts are in: seconds (the default), minutes, hours or days. Every value is worked out in seconds and stored that way on the incident; each chart point is written in this unit, so a chart in hours reads 1.5 for an hour and a half. With seconds, charts show seconds, minutes, hours or days as the numbers grow. Changing it rewrites the measurement's chart points in the new unit. A value that is not a time unit charts in seconds. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `aggregationType` 'Avg' | 'Max' | 'Min' | 'P50' | 'P90' | 'P95' | 'P99': How this measurement's chart sums up many incidents by default - Avg (the default), P50, P90, P95, P99, Max or Min. View Chart in the dashboard opens the chart this way. Sum is deliberately absent: adding durations up across incidents produces a number with no meaning. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `isEnabled` boolean, required: Whether this measurement is computed for new and updated incidents. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `showOnIncidentView` boolean, required: Whether this measurement is shown on the incident page alongside the incident's other timings. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `order` number: Where this measurement appears in the list of measurements, lowest number first. A new measurement is added to the end of the list. Setting a number another one already has puts it in that place, and the ones in the way move one place along to make room. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Create Incident Measurement], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [Project Owner, Project Admin, Edit Incident Measurement] - `isSystemDefined` boolean, required: Whether this measurement was seeded by OneUptime rather than created by your team. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [No access - you don't have permission for this operation] - `backfillRequestedAt` object: When a backfill of this measurement over existing incidents was requested. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [No access - you don't have permission for this operation] - `backfillCursorCreatedAt` object: How far the backfill has walked this project, so a restart resumes instead of starting over. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [No access - you don't have permission for this operation] - `backfillCompletedAt` object: When the backfill of this measurement over existing incidents finished. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [No access - you don't have permission for this operation] - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Measurement], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)