Watch the calls
APIM 3 · 3:14
The gateway logs each request, and its figures show who calls an API and which calls failed. A row in the request list opens the trace of that call into the integration behind the API.
What it covers
- The last day of calls and the Behind it line in
weikio describe api - One row per caller with
weikio metrics, split by subscription - Failures on the platform's side and failures on the caller's side
- The API's overview tiles and the Behind it link in the admin UI
- The Requests section, with one row per call
- Opening the trace of a call into the integration behind the API
Commands in this video
Terminal
$ weikio describe api finance/invoices
$ weikio metrics --api finance/invoices --env production
$ weikio metrics --api finance/invoices --env production --by subscription
$ curl http://api.example.com/invoices/1.0/orders/42 -H "X-Api-Key: $API_KEY"Transcript
- 0:02Partner-x has been calling the invoices API for a day.
- 0:06This video answers who calls it, how often, what failed and what is behind it.
- 0:16The gateway is serving invoices in production, on api.example.com.
- 0:22And partner-x calls it with a key, limited to 60 calls a minute.
- 0:27Each call the gateway serves keeps one access line, and its figures count them.
- 0:36The describe api command reads one API with its last day of calls.
- 0:42Its table shows the version, its published environments and their public URL.
- 0:48One line sums the last 24 hours: the calls, and the share that failed on our side.
- 0:53And the Behind it line names finance/orders-api, seen in its traces.
- 1:00Under it, its subscriptions: partner-x, with its key and its limit.
- 1:05The gateway learns what is behind an API only from watching its calls.
- 1:10Nothing in the platform configures it.
- 1:16The metrics command reads the gateway's figures for one API.
- 1:21One block sums them: the calls, the failures on each side,
- 1:25the status classes, the response time and the limited calls.
- 1:29Split by subscription, it is one row per caller:
- 1:33its calls, how many it limited, its last call.
- 1:37A failure on our side is the gateway or the integration behind it.
- 1:41A failure on the callers' side is the caller's mistake:
- 1:45a missing key, no grant, a limit or a bad request.
- 1:52Let partner-x call once more.
- 1:55Its line goes into the gateway, and the requests section gets one row for it.
- 2:05The admin UI keeps one page per API, and its overview shows the same last day.
- 2:11Its tiles are the calls, the failures on each side, and the response time.
- 2:17And its details carry the Behind it link, into the integration its traces show.
- 2:26Its requests section lists one row per call, from the gateway's own lines.
- 2:31The last one is the call partner-x made with its key.
- 2:39A row opens the call's trace.
- 2:41The trace follows the call into the integration behind the API:
- 2:46the gateway's part, and the integration's part.
- 2:53Here is the picture.
- 2:55Every call keeps its line, and the figures say who called,
- 2:58how often and what failed.
- 3:01And one row opens its trace into the integration behind it.
Next in this track
APIM 4 · 3:08 Webhooks Watched