v1

latestOpenAPI 3.1.02026-07-12185391.3 KB

Chain Metrics

Get ICM timeseries metrics

Get historical ICM message counts with flexible grouping.

Use filters (srcBlockchainId, destBlockchainId, network) to select data, and the groupBy parameter for aggregation level.

Specific pair: ?srcBlockchainId=...&destBlockchainId=...
From one source (aggregated): ?srcBlockchainId=...
From one source (by destination): ?srcBlockchainId=...&groupBy=destBlockchainId
To one destination (aggregated): ?destBlockchainId=...
To one destination (by source): ?destBlockchainId=...&groupBy=srcBlockchainId
Network total: ?network=mainnet
Network breakdown: ?network=mainnet&groupBy=srcBlockchainId,destBlockchainId.

get/v2/icm/timeseries

startTimestampinteger

Query param for retrieving items after a specific timestamp.

endTimestampinteger

Query param for retrieving items before a specific timestamp.

srcBlockchainIdstring

Query param for retrieving items for a specific source (initiating) blockchain id.

destBlockchainIdstring

Query param for retrieving items for a specific destination (receiving) blockchain id.

timeInterval'hour' | 'day' | 'week' | 'month'

Time interval granularity for data aggregation. Metrics prefixed with "cumulative", "max", or "avg" only support timeInterval equal to "day".

pageTokenstring

A page token, received from a previous list call. Provide this to retrieve the subsequent page.

pageSizeinteger

The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 2160.

groupBy'srcBlockchainId' | 'destBlockchainId' | 'srcBlockchainId,destBlockchainId'

Group results by srcBlockchainId, destBlockchainId, or both (comma-separated)

network'mainnet' | 'fuji' | 'testnet'

Either mainnet or testnet/fuji.

Successful response

nextPageTokenstring

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.