...
Lists all metrics visible to the authenticated user account. Using the standard API format, the metrics task can be called against one Element at a time, based on ID:
GET https://youruptime/api/v1/elements/<id>/metrics/<metric>
Multiple Elements can first be filtered by the date and time of the results returned based on start and end timestamp:
GET https://youruptime/api/v1/elements/<id>/metrics/<metric>?StartDateTime=<startdatetime>&EndDateTime=<enddatetime>
...
Anchor getElementsIdMetricsMetricDataArray getElementsIdMetricsMetricDataArray
Metric Data Array
| getElementsIdMetricsMetricDataArray | |
| getElementsIdMetricsMetricDataArray |
Themetric The metric data array returns the following attributes for each retained metric grouped by the name of the metric:
...
| 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:
would return 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 you are referencing has expired. Created filters persist, by default, for 5 five minutes. |
| UT-1012 | Element Group Filter Expired | 410 | The referenced group filter you are referencing has expired. Created filters persist, by default, for 5 five minutes. |
| UT-1013 | Invalid Element Filter | 400 | The JSON used to create an Element filter is invalid, and could not 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 could not 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. |
Example
GET https://youruptime/api/v1/elements/1/metrics/1?metricType=2&startDateTime=01012015000000&endDateTime=01012015001000
| Code Block |
|---|
{
"metricData": {
"Response time": [
{"dateTime": "01012015000010", "value": "35"},
{"dateTime": "01012015000020", "value": "120"}
],
"Major": [
{"dateTime": "01012015000010", "value": "7"},
{"dateTime": "01012015000020", "value": "7"}
]
}
} |
...
| Response Code | Code Description | HTTP Status Code | Details |
|---|---|---|---|
| OK | 200 | Information retrieved successfully. | |
| UT-1011 | Monitor Filter Expired | 410 | The referenced filter you are referencing has expired. Created filters persist, by default, for 5 five minutes. |
| UT-1014 | Invalid Monitor Filter | 400 | The referenced Element filter you are referencing does not exist. |
Example
To list all service monitors:
GET https://youruptime/api/v1/monitors/
| Code Block |
|---|
[
{
"description": "Collects basic performance data",
"elementId": 1,
"id": 3,
"isHidden": true,
"isHostCheck": false,
"isMonitored": true,
"name": "Platform Performance Gatherer",
"type": "ERDCwindows"
},
{
"description": "",
"elementId": 1,
"id": 331,
"isHidden": false,
"isHostCheck": false,
"isMonitored": true,
"name": "FS-monitor-warning win-dleith",
"type": "File System Capacity"
},
{
"description": "Default uptime check for win-dleith",
"elementId": 1,
"id": 1,
"isHidden": false,
"isHostCheck": false,
"isMonitored": true,
"name": "UPTIME-win-dleith",
"type": "up.time Agent"
},
{
"description": "Collects general configuration changes",
"elementId": 1,
"id": 4,
"isHidden": true,
"isHostCheck": false,
"isMonitored": true,
"name": "Configuration Update Gatherer",
"type": "ERDCwindows"
},
{
"description", "Default ping check for win-dleith",
"elementId": 1,
"id": 2,
"isHidden": false,
"isHostCheck": true,
"isMonitored": true,
"name": "PING-win-dleith",
"type": "Ping"
}
{
"description", "Default ping check for rd-01",
"elementId": 8,
"id": 306,
"isHidden": false,
"isHostCheck": true,
"isMonitored": true,
"name": "PING-rh-01"
"type": "Ping"
},
...
]
|
...
| 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 you are referencing has expired. Created filters persist, by default, for 5 five minutes. |
| UT-1014 | Invalid Monitor Filter | 400 | The referenced Element filter you are referencing does not exist. |
Example
List a specific service monitor (for example, ID #364):
GET https://youruptime/api/v1/monitors/364
| Code Block |
|---|
{
"description": "Collects basic performance data",
"elementId": 1,
"id": 3,
"isHidden": true,
"isHostCheck": false,
"isMonitored": true,
"name": "Platform Performance Gatherer",
"type": "ERDCwindows"
} |
...
| 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 |
...
| 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 you are referencing has expired. Created filters persist, by default, for 5 five minutes. |
| UT-1014 | Invalid Monitor Filter | 400 | The referenced Element filter you are referencing does not exist. |
Example
GET https://youruptime/api/v1/monitors/1/status
| Code Block |
|---|
{
"elementId": 1,
"elementStatus":
{
"id": 1,
"isMonitored": true,
"lastCheckTime": "2012-09-17T14:14:17",
"lastTransitionTime": "2012-09-13T11:34:24",
"message": "",
"name": "win-dleith",
"powerState": "On",
"status": "OK"
},
"id": 1,
"isHidden": false,
"isHostCheck": false,
"isMonitored": true,
"lastCheckTime": "2012-09-17T14:13:56",
"lastTransitionTime": "2012-09-13T11:34:38",
"message": "",
"name": "UPTIME-win-dleith",
"status": "UNKNOWN"
} |
...