Skip to main content
Version: v2

AnalyticsVolumeResponse

data object[]required

The page of volume groups matching the query.

  • Array [
  • oneOf

    Volume aggregated for a single network.

    messageCountintegerrequired

    Number of messages in this group.

    Possible values: >= 0

    Example: 95281
    userCountintegerrequired

    Number of unique users that sent messages in this group.

    Possible values: >= 0

    Example: 13000
    volumeUsdstringnullablerequired

    Total transfer volume in USD, as a decimal string with two decimal places. null when USD pricing is unavailable, such as on testnet.

    Example: 5040468321.21
    groupBystringrequired

    Always network for this object shape.

    Possible values: [network]

    chainSelectorstringrequired

    The CCIP chain selector of the network this group's metrics are aggregated over.

    Possible values: Value must match regular expression ^[0-9]+$

    Example: 5009297550715157269
  • ]
  • pagination objectrequired
    limitintegerrequired

    Number of groups requested per page.

    Example: 10
    hasNextPagebooleanrequired

    Whether more groups are available after this page.

    Example: true
    totalCountintegerrequired

    Exact number of groups matching the query; never capped.

    Example: 9999
    isCountCappedbooleanrequired

    Whether totalCount is capped.

    Example: false
    cursorstringnullable

    Pagination cursor for fetching the next page (pass as the cursor parameter).

    JSON
    AnalyticsVolumeResponse
    {
    "data": [
    {
    "groupBy": "network",
    "chainSelector": "5009297550715157269",
    "messageCount": 95281,
    "userCount": 13000,
    "volumeUsd": "5040468321.21"
    },
    {
    "groupBy": "network",
    "chainSelector": "15971525489660198786",
    "messageCount": 193274,
    "userCount": 6478,
    "volumeUsd": "1688386207.86"
    }
    ],
    "pagination": {
    "limit": 10,
    "hasNextPage": true,
    "totalCount": 9999,
    "isCountCapped": false,
    "cursor": "WyJ2b2x1bWVVc2QiLDUwNDA0NjgzMjEuMjFd"
    }
    }