GET
/
v1
/
apiUsageMetrics

Authorizations

x-glacier-api-key
string
headerrequired

Api keys provide higher access to rate limits. To obtain an api key, sign up for an account at https://avacloud.io/.

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.

Required range: x > 0
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.

Required range: x > 0
timeInterval
enum<string>

Time interval granularity for data aggregation

Available options:
minute,
hourly,
daily,
weekly,
monthly
groupBy
enum<string>

Query param for the criterion used for grouping metrics

Available options:
requestPath,
responseCode,
chainId,
apiKeyId,
requestType
chainId
string

Filter data by chain ID.

requestPath
string

Filter data by request path.

responseCode
string

Filter data by response status code.

requestType
enum<string>

Filter data by request type.

Available options:
data,
rpc
apiKeyId
string

Filter data by API key ID.

Response

200 - application/json
aggregateDuration
string
required

Duration in which the metrics value is aggregated

orgId
string
required

Org ID for which the metrics are aggregated

metrics
object[]
required

Metrics values