Get API usage

Returns API key details and rate limit information. Detailed usage is only available when authenticating with an API key.

GET /api/v1/usage

Get API usage

cURL

curl --request GET \
  --url https://app.sure.am/api/v1/usage \
  --header 'X-Api-Key: <api-key>'

200

{
  "api_key": {
    "name": "<string>",
    "scopes": [
      "<string>"
    ],
    "last_used_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "rate_limit": {
    "tier": "<string>",
    "limit": 123,
    "current_count": 123,
    "remaining": 123,
    "reset_in_seconds": 123,
    "reset_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-Api-Key · string · header · required

API key for authentication. Generate one from your account settings.

Response

200 - application/json

usage information

api_key · object

Show child attributes

rate_limit · object

Show child attributes