Get CPU, memory, and network time series for a database
GET
/databases/{id}/metrics
const url = 'https://example.com/databases/example/metrics';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/databases/example/metrics \ --header 'Authorization: Bearer <token>'Auth: authenticated (scope: read)
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Query Parameters
Section titled “Query Parameters”start
Range start in epoch milliseconds. Defaults to end minus 1h.
string
Range start in epoch milliseconds. Defaults to end minus 1h.
end
Range end in epoch milliseconds. Defaults to now.
string
Range end in epoch milliseconds. Defaults to now.
step
Step in milliseconds, minimum 1000. Defaults to 30000.
string
Step in milliseconds, minimum 1000. Defaults to 30000.
Responses
Section titled “Responses”OK
Media typeapplication/json
object
data
required
object
cpu
required
Array<object>
object
x
required
number
y
required
number
mem
required
Array<object>
object
x
required
number
y
required
number
rx
required
Array<object>
object
x
required
number
y
required
number
tx
required
Array<object>
object
x
required
number
y
required
number
key
additional properties
end
required
number
start
required
number
step
required
number
key
additional properties
Example generated
{ "data": { "cpu": [ { "x": 1, "y": 1 } ], "mem": [ { "x": 1, "y": 1 } ], "rx": [ { "x": 1, "y": 1 } ], "tx": [ { "x": 1, "y": 1 } ] }, "end": 1, "start": 1, "step": 1}