usage

List recent calls made with this API key

Returns the usage log of the API key used on this call: one entry for every report and every export it fetched, with the endpoint, the HTTP status and the timestamp, newest first, together with the organization name. Those are the two operations that consume daily quota, and an entry is written only when the call succeeds, so a refused call and a call to any other operation leave no entry.

The scope is the key, not the organization. An organization holding several keys sees only the activity of the key that authenticated the request, so rotating a key starts a fresh log rather than continuing the old one.

Pass limit to change how many events come back. The default is 100 and the endpoint never returns more than 500, whatever is requested. Reading this log does not consume daily quota.

get/api/v1/usage

Request

  • Base URL: https://api.gatiflow.io
  • URL: https://api.gatiflow.io/api/v1/usage
  • Auth: API key in header X-API-Key

Query parameters

limitinteger

How many entries to return, newest first. Values above 500 return 500.

Headers

X-API-Keystring nullable

The API key, prefix gf_: the credential the ApiKeyAuth scheme declares.

Response

The reports and exports fetched with the API key used on this request, newest first.

org_namestring required
total_returnedinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.