Skip to content

Get current platform metrics

GET
/metrics/
curl --request GET \
--url https://shoehorn.example.com/api/v1/metrics/

Returns a snapshot of HTTP request counts, response-time samples, integration counts, and basic system stats. Used by the home and admin dashboards.

Metrics snapshot

Media type application/json
object
timestamp
string format: date-time
http_requests_total

Request counts keyed by HTTP method.

object
key
additional properties
integer
response_times
Array<object>
object
timestamp
string format: date-time
method
string
path
string
response_time_ms
number
status_code
integer
integrations_stats
object
total
integer
active
integer
errors
integer
mock_data
boolean
system_stats
object
database_connections
integer
cache_hits
integer
cache_misses
integer
memory_usage_bytes
integer
cpu_usage_percent
number
mock_data
boolean
mock_data

True if any field in the response is synthetic.

boolean
Example generated
{
"timestamp": "2026-04-15T12:00:00Z",
"http_requests_total": {
"additionalProperty": 1
},
"response_times": [
{
"timestamp": "2026-04-15T12:00:00Z",
"method": "example",
"path": "example",
"response_time_ms": 1,
"status_code": 1
}
],
"integrations_stats": {
"total": 1,
"active": 1,
"errors": 1,
"mock_data": true
},
"system_stats": {
"database_connections": 1,
"cache_hits": 1,
"cache_misses": 1,
"memory_usage_bytes": 1,
"cpu_usage_percent": 1,
"mock_data": true
},
"mock_data": true
}