 API: Usage / Throttle Statistics
« Back to the API Documentation overview - authentication, security, response codes, and the full endpoint list.
Your project's current rate-limit consumption. Always available, regardless of endpoint access settings.
| HTTP Request Type | GET |
| Calling URI | https://www.YourDepartment.com/apps/api/usage/ |
| Request Header | Authorization: Bearer {access_token} |
| Success Codes | 200 OK |
| Failure Codes | 400, 401, 403, 404, 405, 429, 500 - see the error reference |
This endpoint has no parameters of its own; the common MaxRows
(default 100, maximum 500) and StartRow paging parameters apply.
Response Properties
| Property | Description |
limit_per_minute / limit_per_day |
Your throttle limits (number) |
calls_last_minute / calls_last_24_hours / calls_last_30_days |
Recent call counts (number) |
remaining_this_minute / remaining_today |
Calls left before throttling (number) |
throttled_calls / failed_calls / total_calls_logged |
Historical counts within the log retention window (number) |
Records are returned in the items array of the
standard response envelope.
Sample Code
Exchange your refresh token for an access token, then request data. The same two steps
work in any language; JavaScript and Python are shown here.
JavaScript
const BASE = "https://www.YourDepartment.com/apps/api";
const REFRESH_TOKEN = "your-refresh-token-here";
// 1. Exchange the refresh token for an access token (do this from a server,
// not from a public web page, so the refresh token stays secret)
const tokenRes = await fetch(`${BASE}/refresh/`, {
method: "POST",
headers: { "Authorization": `Bearer ${REFRESH_TOKEN}` }
});
const tokenData = await tokenRes.json();
// 2. Call the usage endpoint (reuse the token for up to 24 hours)
const res = await fetch(`${BASE}/usage/?MaxRows=10`, {
headers: { "Authorization": `Bearer ${tokenData.access_token}` }
});
const data = await res.json();
data.items.forEach(item => console.log(item));
Python
import requests
BASE = "https://www.YourDepartment.com/apps/api"
REFRESH_TOKEN = "your-refresh-token-here"
# 1. Exchange the refresh token for an access token
token = requests.post(f"{BASE}/refresh/",
headers={"Authorization": f"Bearer {REFRESH_TOKEN}"}).json()
# 2. Call the usage endpoint (reuse the token for up to 24 hours)
data = requests.get(f"{BASE}/usage/",
params={"MaxRows": 10},
headers={"Authorization": f"Bearer {token['access_token']}"}).json()
for item in data["items"]:
print(item)
|
August 15, 2026: