Sign in

v1

latestOpenAPI 3.1.02026-07-1288262495.0 KB
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

Query parameters

orgIdstring

Organization ID to fetch usage metrics for

startTimestampinteger

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.

endTimestampinteger

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.

timeInterval'minute' | 'hourly' | 'daily' | 'weekly' | 'monthly'

Time interval granularity for data aggregation

groupBy'requestPath' | 'responseCode' | 'chainId' | 'apiKeyId' | 'requestType'

Query param for the criterion used for grouping metrics

chainIdstring

Filter data by chain ID.

responseCodestring

Filter data by response status code.

requestType'data' | 'rpc'

Filter data by request type.

apiKeyIdstring

Filter data by API key ID.

requestPathstring

Filter data by request path.

Response

Successful response

aggregateDurationstring required

Duration in which the metrics value is aggregated

orgIdstring required

Org ID for which the metrics are aggregated