Skip to content
ShipSquares

/servers/{id}/metrics/series

GET
/servers/{id}/metrics/series
 
curl --request GET \
  --url 'https://example.com/api/v1/servers/example/metrics/series?metric=cpu&range=1h'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Query Parameters

Section titled “Query Parameters ”
metric
required
Any of:
string
Allowed values: cpu
range
required
Any of:
string
Allowed values: 1h

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
object
metric
required
string
range
required
string
stepMs
required
integer
limitBytes
required
Any of:
number
points
required
Array<object>
object
ts
required
number
avg
required
number
min
required
number
max
required
number
count
required
integer
Example generated
{
  "metric": "example",
  "range": "example",
  "stepMs": 1,
  "limitBytes": 1,
  "points": [
    {
      "ts": 1,
      "avg": 1,
      "min": 1,
      "max": 1,
      "count": 1
    }
  ]
}

404

Section titled “404 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}