Get Usage

This API returns API call counts for the authenticated API key, grouped by endpoint, status code, and error code.

GET /metrics/usage

cURL

cURL

curl --request GET \
  --url https://api.relay.link/metrics/usage

200

{
  "metrics": [
    {
      "apiKey": "<string>",
      "timestamp": "<string>",
      "endpoint": "<string>",
      "statusCode": 123,
      "errorCode": "<string>",
      "count": 123
    }
  ]
}

Headers

x-api-key · string

Integrator API key.

Query Parameters

granularity · enum<string> · default: hourly

Time bucket granularity. minutely defaults to last 24h, hourly to last 7d, daily to last 14d.

Available options: minutely, hourly, daily

startTimestamp · number

Start of the query window as a Unix timestamp (seconds). Defaults based on granularity.

endTimestamp · number

End of the query window as a Unix timestamp (seconds). Defaults to now.

apiKey · string

Filter metrics by API key. Accepts a single value or a comma-separated list (e.g. key1,key2) — results include metrics matching any of the supplied keys. Maximum 50 keys.

Response

200 - application/json

Default Response

metrics · object[]

Show child attributes