Honeycluster Docs – Get bucketed network throughput metrics

network

Get bucketed network throughput metrics

get

/network/metrics

operationId: network-metrics

Returns network throughput aggregated into fixed buckets (hourly or daily). Each bucket includes average and peak TPS, average close time, and the number of ledgers sampled. Results are ordered newest-first and capped by limit.

Authorizations

Name	Location	Details
`BearerAuth`	Authorization header · bearer	JWT issued by the Honeycluster auth service for the `indexer` audience. Present as `Authorization: Bearer <token>`.

Query Parameters

Name	Type	Default	Description
`interval`	enum<string>	`"hourly"`	Available `hourlydaily`
`startTime`	integer
`endTime`	integer
`limit`	integer	`500`

Responses

200

application/json

Successful response

Field	Type	Description
`items`	object[]
`items[].bucket`	integer	Start of the aggregation bucket, Unix-seconds.
`items[].avgTps`	number	Mean transactions per second in the bucket.
`items[].maxTps`	number	Peak transactions per second in the bucket.
`items[].avgCloseTimeMs`	number	Average ledger close time in milliseconds.
`items[].totalTransactions`	number	Total transaction count in the bucket.
`items[].sampleCount`	number	Number of ledgers sampled in the bucket.

Example

Json

{
  "items": [
    {
      "bucket": 1745712000,
      "avgTps": 14.2,
      "maxTps": 38.5,
      "avgCloseTimeMs": 3925,
      "totalTransactions": 51120,
      "sampleCount": 360
    },
    {
      "bucket": 1745715600,
      "avgTps": 12.8,
      "maxTps": 31.2,
      "avgCloseTimeMs": 4012,
      "totalTransactions": 46080,
      "sampleCount": 360
    }
  ]
}

400

application/json

Invalid input data

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401

application/json

Authorization not provided

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403

application/json

Insufficient access

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

404

application/json

Not found

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

500

application/json

Internal server error

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}