View Server Performance Metrics

Retrieve time-series metric data for a specific server by providing its monitor_id in the path. This endpoint allows you to query server resource usage — such as CPU, memory, disk, or network — across a specified time window.

You can refine the results using query parameters like type (e.g., cpu, memory), start_date, end_date, interval (e.g., on-demand, hourly), and limit to control the resolution and size of the returned dataset.

Use cases:

Chart rendering — Populate monitoring dashboards with metric visualizations for a selected server and time period.
Usage trend analysis — Explore how system resource consumption changes over time to assist with capacity planning.
Spike investigation — Drill into specific intervals to identify periods of high usage or irregular activity.

Authorization: Bearer YOUR_TOKEN

Path Parameters

id string
The unique ID of the server resource for which metrics are being retrieved. Example: '9bb4505f-6073-4a9b-abd3-cc698f695c7b'

Query Parameters

type string
The type of metric being retrieved. The accepted values are: 'cpu-total-usage', 'memory-usage', 'disk-io-unified', 'disk-usage-unified', 'system-load-unified', 'swap-usage', and 'network-usage-unified'.
Example: 'cpu-total-usage'
start_date (optional) string
end_date (optional) string
interval (optional) string
limit (optional) positive integer

ResponseThis section is used to view the possible HTTP response codes returned by the API. These codes indicate the status of a request, such as 201 (Created), 401 (Unauthorized), 409 (Conflict), or 422 (Unprocessable Entity).

View Server Performance Metrics

Chart rendering — Populate monitoring dashboards with metric visualizations for a selected server and time period.
Usage trend analysis — Explore how system resource consumption changes over time to assist with capacity planning.
Spike investigation — Drill into specific intervals to identify periods of high usage or irregular activity.

Authorization: Bearer YOUR_TOKEN

Path Parameters

id string
The unique ID of the server resource for which metrics are being retrieved. Example: '9bb4505f-6073-4a9b-abd3-cc698f695c7b'

Query Parameters

type string
The type of metric being retrieved. The accepted values are: 'cpu-total-usage', 'memory-usage', 'disk-io-unified', 'disk-usage-unified', 'system-load-unified', 'swap-usage', and 'network-usage-unified'.
Example: 'cpu-total-usage'
start_date (optional) string
end_date (optional) string
interval (optional) string
limit (optional) positive integer

curl -X GET 'https://api.pinghome.io/statistic-query/v1/server-resource/9bb4505f-6073-4a9b-abd3-cc698f695c7b/metrics?type=cpu-total-usage&start_date=2023-04-03T21:00:00Z&end_date=2023-04-03T22:04:00Z&interval=on-demand&limit=100' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Content-Type: application/json'