Get columnar service metrics history for charts

GET

/api/environments/{envId}/services/metrics/history

curl --request GET \
  --url 'https://example.com/api/environments/example/services/metrics/history?hours=24&metric=cpu&maxPoints=120' \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearerAuth

Parameters

Path Parameters

envId

required

string

Query Parameters

hours

number

default: 24 >= 1 <= 168

metric

string

Allowed values: cpu memory disk load

since

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

maxPoints

number

default: 120 >= 10 <= 2000

Responses

200

Default Response

Media typeapplication/json

object

services

Array<object>

object

id

string

deploymentId

string

name

string

serverName

string

serverId

string

timestamps

Array<string>

series

object

cpu

Array<Array<null | number>>

memory

Array<Array<null | number>>

memoryLimit

Array<Array<null | number>>

networkRx

Array<Array<null | number>>

networkTx

Array<Array<null | number>>

restartCount

Array<Array<null | number>>

mode

string

Allowed values: full delta

until

string

Example

{
  "mode": "full"
}

400

Default Response

Media typeapplication/json

object

error

string

details

Example^generated

{
  "error": "example",
  "details": "example"
}

404

Default Response

Media typeapplication/json

object

error

string

details

Example^generated

{
  "error": "example",
  "details": "example"
}