Skip to main content
GET
Read server metrics history
Required permissions: scout.read. Personal keys are capped by their owner’s current team role. See request conventions and automation workflows. MCP clients use the task-oriented tool catalogue.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

serverId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

range
enum<string>
default:1h
Available options:
15m,
30m,
1h,
6h,
24h,
7d,
15d,
30d,
60d,
custom
startAt
string<date-time>

Inclusive ISO 8601 start with time-zone offset; required for range=custom and within server retention.

Pattern: ^(?:(?:\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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
endAt
string<date-time>

Exclusive ISO 8601 end with time-zone offset; required for range=custom, at least 30 seconds after start and not in the future.

Pattern: ^(?:(?:\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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

Server metrics by time, preserving sample counts and minimum/maximum values, plus deployment events.

agent
object
required
serverId
string
required
range
required
Allowed value: "custom"
startAt
string
required
endAt
string
required
stepSeconds
number
required
series
object[]
required
seriesLimited
boolean
required
events
object[]
required
eventsLimited
boolean
required
localization
object
required
Last modified on September 5, 2026