Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@
"references/api/utilities",
"references/api/get-chains",
"references/api/get-chains-liquidity",
"references/api/get-integrators-usage",
"references/api/get-currencies-v2",
"references/api/get-token-price",
"references/api/transactions-index",
Expand Down
1 change: 1 addition & 0 deletions references/api/api-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ The [Relay Dashboard](https://dashboard.relay.link) is also where you observe wh
- **Custom views** — save any combination of filters, sort order, and columns as a reusable view for your team, each with its own name, icon, and color.
- **Keys** — create, rename, and revoke keys for your account.
- **Webhooks** — configure a per-key [webhook endpoint](/references/api/api_guides/webhooks) so transaction status updates are pushed to your backend instead of polling.
- **Programmatic usage metrics** — the [Get Integrator Usage](/references/api/get-integrators-usage) endpoint returns aggregated request counts grouped by endpoint, status code, and error code across `minutely` / `hourly` / `daily` buckets, so you can wire the same data the Dashboard shows into your own monitoring.

When debugging a specific transaction, paste the `requestId` from your application into the dashboard's search to jump straight to the matching record.

Expand Down
11 changes: 11 additions & 0 deletions references/api/get-integrators-usage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Get Integrator Usage"
description: "Returns aggregated request counts grouped by API key, endpoint, status code, and error code"
openapi: get /integrators/usage
---

Programmatic counterpart to the Dashboard's request history — returns the same aggregated counts you see under **Requests**, broken down by endpoint, HTTP status, and (for `400` responses) the machine-readable `errorCode`.

The `granularity` query parameter controls the time bucket and the default window: `minutely` (last 24h), `hourly` (last 7d), or `daily` (last 14d). Data older than 14 days is not retained.

<Tip>Use `granularity=minutely` to build a near-real-time uptime view; use `granularity=daily` for longer-range trend analysis. The `errorCode` field on `400` rows lets you distinguish validation errors (e.g. `AMOUNT_TOO_LOW`, `UNSUPPORTED_CHAIN`) from other client errors when calculating a meaningful success rate.</Tip>
Loading