Skip to main content
GET
/
api
/
usage
Get API usage stats
curl --request GET \
  --url https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/usage \
  --header 'Authorization: <api-key>'
{
  "period": "current_month",
  "totalRequests": 15000,
  "requestsByEndpoint": {
    "/api/quotes": 500,
    "/api/bookings": 300
  },
  "rateLimits": {
    "requestsPerMinute": 60,
    "requestsPerHour": 1000,
    "requestsPerDay": 10000
  }
}
Get API usage statistics and rate limits per tenant.

​
Reference Documentation

For more information on administration functions, please refer to:

Authorizations

​
Authorization
string
header
required

Query Parameters

​
period
string
default:current_month

Reporting period

​
groupBy
string
default:endpoint

Group by endpoint or other criteria

Response

200 - application/json

Usage statistics

​
period
string
Example:

"current_month"

​
totalRequests
integer
Example:

15000

​
requestsByEndpoint
object
Example:
{ "/api/quotes": 500, "/api/bookings": 300 }
​
rateLimits
object
⌘I