Skip to content

Retrieve real-time network usage statistics and bandwidth metrics for nodes

Request

Returns an array of usage data buckets for specified nodes within the specified time range and interval.

Security
JWTAuthorizer
Query
relative_startstring

The relative start time for the data (e.g., "-7 days").

relative_endstring

The relative end time for the data (e.g., "now").

intervalInMinutesstring

The size of the time buckets in minutes.

startinteger, (int64)

The start time for the data in Unix timestamp format (if not using relative_start).

endinteger, (int64)

The end time for the data in Unix timestamp format (if not using relative_end).

filtersstring

The filters to apply when querying for nodes, like tags.

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/stats/realtime/usage?relative_start=string&relative_end=string&intervalInMinutes=string&start=0&end=0&filters=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

An array of usage data buckets.

Bodyapplication/json
Array [
bytesinteger, (int64)

The number of bytes in the bucket.

countinteger, (int64)

The number of flows in the bucket.

tinteger, (int64)

The time of the bucket in Unix timestamp format.

]
Response
[
  {
    "bytes": 0,
    "count": 0,
    "t": 0
  }
]