...
GET https://youruptime/api/v1/elements/<id>/metrics/<metric>?StartDateTime=<startdatetime>&EndDateTime=<enddatetime>
Either or both StartDatetime StartDateTime and EndDatetime EndDateTime can be included. If both are included, only data points between and equal to the supplied datetimes are included. If only StateDatetime StartDateTime is included, only values from that point forward are included. If only EndDatetime EndDateTime is included, only values prior to and including are included.
...
Other response codes that may occur include the following:
| Response Code | Code Description | HTTP Status Code | Details |
|---|---|---|---|
| OK | 200 | Information retrieved successfully. | |
| UT-1000 | Element Does Not Exist | 404 | A specifically referenced Element ID does not exist. In such a case, referencing:
returns the following:
The Element ID endpoint may be omitted, was inputted incorrectly, or is ignored in up.time. |
| UT-1010 | Element Filter Expired | 410 | The referenced filter is expired. Created filters persist, by default, for five minutes. |
| UT-1012 | Element Group Filter Expired | 410 | The referenced group filter is expired. Created filters persist, by default, for five minutes. |
| UT-1013 | Invalid Element Filter | 400 | The JSON used to create an Element filter is invalid, and cannot be parsed. Check to ensure you are posting well-formed JSON. |
| UT-1015 | Invalid Element Group Filter | 400 | The JSON used to create an Element group filter is invalid, and cannot be parsed. Check to ensure you are posting well-formed JSON. |
| UT-1028 | URL ID Body Mismatch | 400 | The Element ID in the URL and the JSON object do not match. |
...
| Field | Type | Description |
|---|---|---|
| description | String | description of this service monitor |
| elementId | Integer | ID for this service monitor's parent Element; can return a null value for unassigned monitors |
| id | Integer | ID for this Element |
| isHidden | Boolean | hidden monitors are internal monitors that up.time uses, and can generally be ignored |
| isMonitored | Boolean | monitoring status for this Element |
| isHostCheck | Boolean | returns true if this service monitor is the host check for its parent Element |
| name | String | display name of the service monitor |
| type | String | the service monitor type, typically as seen in the up.time UI |
...
Other response codes that may occur include the following:
| Response Code | Code Description | HTTP Status Code | Details |
|---|---|---|---|
| OK | 200 | Information retrieved successfully. | |
| UT-1011 | Monitor Filter Expired | 410 | The referenced filter is expired. Created filters persist, by default, for five minutes. |
| UT-1014 | Invalid Monitor Filter | 400 | The referenced Element filter does not exist. |
...
| Field | Type | Description |
|---|---|---|
| description | String | description of this service monitor |
| elementId | Integer | ID for this service monitor's parent Element; can return a null value for unassigned monitors |
| id | Integer | ID for this Element |
| isHidden | Boolean | hidden monitors are internal monitors that up.time uses, and can generally be ignored |
| isMonitored | Boolean | monitoring status for this Element |
| isHostCheck | Boolean | returns true if this service monitor is the host check for its parent Element |
| isHidden | Boolean | hidden monitors are internal monitors that up.time uses, and can generally be ignored |
| name | String | display name of the service monitor |
| type | String | the service monitor type, typically as seen in the up.time UI |
...
Other response codes that may occur include the following:
| Response Code | Code Description | HTTP Status Code | Details |
|---|---|---|---|
| OK | 200 | Information retrieved successfully. | |
| UT-1001 | Monitor Does Not Exist | 404 | A specifically referenced service monitor ID does not exist. In such a case, referencing
|
| UT-1011 | Monitor Filter Expired | 410 | The referenced filter is expired. Created filters persist, by default, for five minutes. |
| UT-1014 | Invalid Monitor Filter | 400 | The referenced Element filter does not exist. |
...
| Field | Type | Description |
|---|---|---|
| elementId | Integer | ID for this service monitor's parent Element; can be null for unassigned monitors |
| elementStatus | Object | an object listing the status of the parent Element for this monitor (see Element Status Object below for more detail) |
| id | Integer | ID for this service monitor |
| isMonitored | Boolean | monitoring Status for this service monitor |
| isHidden | Boolean | hidden monitors are internal monitors that up.time uses, and can generally be ignored |
| isHostCheck | Boolean | returns true if this service monitor is the host check for its parent Element |
| lastCheckTime | String - Date Time | the last time this service monitor was executed successfully |
| lastTransitionTime | String - Date Time | the last time this service monitor changed status, which can be used to determine time in its current status |
| message | String | output message produced the last time the service monitor was executed |
| name | String | name of this service monitor |
| status | String | last known status of this service monitor |
...
Other response codes that may occur include the following:
| Response Code | Code Description | HTTP Status Code | Details |
|---|---|---|---|
| OK | 200 | Information retrieved successfully. | |
| UT-1001 | Monitor Does Not Exist | 404 | A specifically referenced service monitor ID does not exist. In such a case, referencing
|
| UT-1011 | Monitor Filter Expired | 410 | The referenced filter is expired. Created filters persist, by default, for five minutes. |
| UT-1014 | Invalid Monitor Filter | 400 | The referenced Element filter does not exist. |
...