GET
/
nodes
/
analytics

You must provide a security nonce to use this endpoint, you can obtain one using the Get analytics nonce endpoint.

WebSockets ahead!

This endpoint is a WebSocket endpoint, you must use a WebSocket client to receive data from this endpoint.

​
Usage

This endpoint initiates a message upon successful connection, followed by updates every 5 seconds containing the requested analytical data. Below is an example of the analytical data transmitted over this connection.

[
  {
    "timestamp": "2024-10-28T14:30:00Z",
    "memory": 8192.0,
    "memoryUsage": 4096.0,
    "disk": 500000.0,
    "diskWriteUsage": 120.5,
    "diskReadUsage": 95.3,
    "cpu": 4,
    "cpuUsage": 1.75,
    "networkInbound": 102400.0,
    "networkOutbound": 76800.0
  }
]

​
Response

timestamp
datetime
required

Timestamp of the received analytical data.

memory
decimal
required

The total memory of the node in megabytes.

memoryUsage
decimal
required

The used memory of the node in megabytes.

disk
decimal
required

The total disk size of the node in megabytes.

diskWriteUsage
decimal
required

The current disk write usage in megabytes.

diskReadUsage
decimal
required

The current disk read usage in megabytes.

cpu
int64
required

The amount of CPU cores the node has.

cpuUsage
decimal
required

The current overall CPU usage across all cores on the node, expressed as a percentage.

networkInbound
decimal
required

The amount of inbound network usage in bytes

networkOutbound
decimal
required

The amount of outbound network usage in bytes.

Authorizations

Authorization
string
headerrequired

Your API key goes here, you can generate one in your account settings.

Query Parameters

nonce
string

The security nonce to use

Get analytics nonceDeploy new node