Server Metrics

Returns server metrics including resource usage and historical data for bandwidth, viewers, and streams.

Request

Property	Value
Method	`GET`
URL	`/api/statistics/server-metrics`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X GET "{BASE_URL}/api/statistics/server-metrics" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

General

Parameter	Type	Description
`data.launchDate`	integer	Server launch time (Unix timestamp in ms)
`data.cpuUsagePercent`	string	Current CPU usage percentage

Memory

Parameter	Type	Description
`data.memory.totalMemory`	integer	Total available memory in bytes
`data.memory.currentMemory`	integer	Currently used memory in bytes
`data.memory.usagePercent`	string	Memory usage percentage

Network

Parameter	Type	Description
`data.network.inBandwidth`	integer	Incoming bandwidth in bytes/sec
`data.network.outBandwidth`	integer	Outgoing bandwidth in bytes/sec
`data.network.inTotalBytes`	integer	Total incoming bytes
`data.network.outTotalBytes`	integer	Total outgoing bytes

Thread Pools

Parameter	Type	Description
`data.threadpools.workersTotalCount`	integer	Total number of worker threads
`data.threadpools.workersActiveCount`	integer	Active worker threads
`data.threadpools.readersTotalCount`	integer	Total number of reader threads
`data.threadpools.readersActiveCount`	integer	Active reader threads
`data.threadpools.sendersTotalCount`	integer	Total number of sender threads
`data.threadpools.sendersActiveCount`	integer	Active sender threads
`data.threadpools.transportTotalCount`	integer	Total number of transport threads
`data.threadpools.transportActiveCount`	integer	Active transport threads

Incoming Bandwidth History

Parameter	Type	Description
`data.incomingBandwidthHistory`	object	Incoming bandwidth history
`data.incomingBandwidthHistory.current`	number	Current incoming bandwidth in bytes/sec
`data.incomingBandwidthHistory.average`	number	Average incoming bandwidth in bytes/sec
`data.incomingBandwidthHistory.max`	number	Maximum incoming bandwidth in bytes/sec
`data.incomingBandwidthHistory.data`	array	Array of historical data points
`data.incomingBandwidthHistory.data[].timestamp`	integer	Data point timestamp (Unix timestamp in ms)
`data.incomingBandwidthHistory.data[].value`	integer	Incoming bandwidth value in bytes/sec

Outgoing Bandwidth History

Parameter	Type	Description
`data.outgoingBandwidthHistory`	object	Outgoing bandwidth history
`data.outgoingBandwidthHistory.current`	number	Current outgoing bandwidth in bytes/sec
`data.outgoingBandwidthHistory.average`	number	Average outgoing bandwidth in bytes/sec
`data.outgoingBandwidthHistory.max`	number	Maximum outgoing bandwidth in bytes/sec
`data.outgoingBandwidthHistory.data`	array	Array of historical data points
`data.outgoingBandwidthHistory.data[].timestamp`	integer	Data point timestamp (Unix timestamp in ms)
`data.outgoingBandwidthHistory.data[].value`	integer	Outgoing bandwidth value in bytes/sec

Viewer Count History

Parameter	Type	Description
`data.viewerCountHistory`	object	Viewer count history
`data.viewerCountHistory.current`	integer	Current viewer count
`data.viewerCountHistory.average`	number	Average viewer count
`data.viewerCountHistory.max`	integer	Maximum viewer count
`data.viewerCountHistory.data`	array	Array of historical data points
`data.viewerCountHistory.data[].timestamp`	integer	Data point timestamp (Unix timestamp in ms)
`data.viewerCountHistory.data[].value`	integer	Viewer count at the given timestamp

Stream Count History

Parameter	Type	Description
`data.streamCountHistory`	object	Stream count history
`data.streamCountHistory.current`	integer	Current stream count
`data.streamCountHistory.average`	number	Average stream count
`data.streamCountHistory.max`	integer	Maximum stream count
`data.streamCountHistory.data`	array	Array of historical data points
`data.streamCountHistory.data[].timestamp`	integer	Data point timestamp (Unix timestamp in ms)
`data.streamCountHistory.data[].value`	integer	Stream count at the given timestamp

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "launchDate": 1764671260701,
    "cpuUsagePercent": "12.28",
    "memory": {
      "totalMemory": 25769803776,
      "currentMemory": 2604718060,
      "usagePercent": "10.11"
    },
    "network": {
      "inBandwidth": 1067023,
      "outBandwidth": 1595614,
      "inTotalBytes": 164766288812,
      "outTotalBytes": 244682447629
    },
    "threadpools": {
      "workersTotalCount": 96,
      "workersActiveCount": 2,
      "readersTotalCount": 48,
      "readersActiveCount": 0,
      "sendersTotalCount": 144,
      "sendersActiveCount": 2,
      "transportTotalCount": 96,
      "transportActiveCount": 2
    },
    "incomingBandwidthHistory": {
      "current": 1145375,
      "average": 878824.39,
      "max": 1918259,
      "data": [
        { "timestamp": 1764847013251, "value": 1145375 },
        { "timestamp": 1764846983251, "value": 987638 },
        { "timestamp": 1764846953251, "value": 976061 }
      ]
    },
    "outgoingBandwidthHistory": {
      "current": 1766429,
      "average": 1294576.78,
      "max": 2867107,
      "data": [
        { "timestamp": 1764847013251, "value": 1766429 },
        { "timestamp": 1764846983251, "value": 1325796 },
        { "timestamp": 1764846953251, "value": 1463568 }
      ]
    },
    "viewerCountHistory": {
      "current": 0,
      "average": 0,
      "max": 0,
      "data": [
        { "timestamp": 1764847013251, "value": 0 },
        { "timestamp": 1764846983251, "value": 0 },
        { "timestamp": 1764846953251, "value": 0 }
      ]
    },
    "streamCountHistory": {
      "current": 4,
      "average": 4,
      "max": 4,
      "data": [
        { "timestamp": 1764847013251, "value": 4 },
        { "timestamp": 1764846983251, "value": 4 },
        { "timestamp": 1764846953251, "value": 4 }
      ]
    }
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1764847032779
  }
}

Error Response (4xx/5xx)

Parameter	Type	Description
`message`	string	Human-readable error message

Error Response

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.