Granite Upgrade Activates in11d:16h:54m:17s
OverviewNode RPCsData APIsSDKsACPs
Data API Usage Metrics

Get usage metrics for the Data API

Gets metrics for Data API usage over a specified time interval aggregated at the specified time-duration granularity.

GET
/v1/apiUsageMetrics

Authorization

x-glacier-api-key<token>

Api keys provide higher access to rate limits. To obtain an api key, sign up for an account at https://build.avax.network/console/utilities/data-api-keys.

In: header

Query Parameters

orgId?string

Organization ID to fetch usage metrics for

startTimestamp?integer

The start time of the range as a UNIX timestamp. The requested start time will be rounded down to 0:00 UTC of the day.

Range0 <= value
endTimestamp?integer

The end time of the range as a UNIX timestamp. The requested end time will be rounded down to 0:00 UTC of the day.

Range0 <= value
timeInterval?string

Time interval granularity for data aggregation

Value in"minute" | "hourly" | "daily" | "weekly" | "monthly"
groupBy?string

Query param for the criterion used for grouping metrics

Value in"requestPath" | "responseCode" | "chainId" | "apiKeyId" | "requestType"
chainId?string

Filter data by chain ID.

responseCode?string

Filter data by response status code.

requestType?string

Filter data by request type.

Value in"data" | "rpc"
apiKeyId?string

Filter data by API key ID.

requestPath?string

Filter data by request path.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://data-api.avax.network/v1/apiUsageMetrics?startTimestamp=1739507200&endTimestamp=1739664000&timeInterval=daily&groupBy=requestPath"
{
  "aggregateDuration": "string",
  "orgId": "string",
  "metrics": [
    {
      "timestamp": 0,
      "values": [
        {
          "groupedBy": "requestPath",
          "groupValue": "string",
          "totalRequests": 0,
          "requestsPerSecond": 0,
          "successRatePercent": 0,
          "medianResponseTimeMsecs": 0,
          "invalidRequests": 0,
          "apiCreditsUsed": 0,
          "apiCreditsWasted": 0
        }
      ]
    }
  ]
}
{
  "message": "string",
  "statusCode": 400,
  "error": "Bad Request"
}
{
  "message": "string",
  "statusCode": 401,
  "error": "Unauthorized"
}
{
  "message": "string",
  "statusCode": 403,
  "error": "Forbidden"
}
{
  "message": "string",
  "statusCode": 404,
  "error": "Not Found"
}
{
  "message": "string",
  "statusCode": 429,
  "error": "Too Many Requests"
}
{
  "message": "string",
  "statusCode": 500,
  "error": "Internal Server Error"
}
{
  "message": "string",
  "statusCode": 502,
  "error": "Bad Gateway"
}
{
  "message": "string",
  "statusCode": 503,
  "error": "Service Unavailable"
}

Is this guide helpful?

Get logs for requests made by client GET

Previous Page

Get usage metrics for the Primary Network RPC GET

Next Page