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.

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.

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.

requestPath

string

Filter data by request path.

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

Show child attributes

metrics.timestamp

number

required

The timestamp of the metrics value

metrics.values

object[]

required

The metrics values for the timestamp

Show child attributes

metrics.values.groupedBy

enum<string>

required

Column name used for data aggregation

Available options:

requestPath,

responseCode,

chainId,

apiKeyId,

requestType,

None

metrics.values.groupValue

The value of the column used for data aggregation

metrics.values.totalRequests

number

required

The total number of requests

metrics.values.requestsPerSecond

number

required

The number of requests per second

metrics.values.successRatePercent

number

required

The success rate percentage

metrics.values.medianResponseTimeMsecs

number

required

The median response time in milliseconds

metrics.values.invalidRequests

number

required

The number of invalid requests

metrics.values.apiCreditsUsed

number

required

The number of API credits used

metrics.values.apiCreditsWasted

number

required

The number of API credits wasted on invalid requests