Skip to content

Usage

GEThttps://api.kennmarq.com/v1/usage

This month's marks, data returned and time-stamps for the key's environment, with your plan's limits. Works with any valid key: a test key sees the test allowance.

curl
curl https://api.kennmarq.com/v1/usage -H "Authorization: Bearer $KENNMARQ_API_KEY"
200 application/json
{
  "object": "usage",
  "plan": "free",
  "environment": "live",
  "period": {
    "id": "2026-10",
    "start": "2026-10-01T00:00:00.000Z",
    "end": "2026-11-01T00:00:00.000Z"
  },
  "marks": { "used": 412, "limit": 1000, "ceiling": 1000 },
  "data_out": { "bytes": 389214772, "limit_bytes": 1000000000 },
  "time_stamps": { "used": 0, "limit": 1000 },
  "rate_limit": { "calls_per_minute": 10 }
}
Fields of the usage object
FieldMeaning
planYour organisation's plan: free, indie, startup, scale or enterprise.
environmentThe key's environment: live or test. Each has its own allowances.
periodThe calendar month counted, in UTC. Counts start again at its end.
marksMarks made this month, the month's allowance (limit), and how far they may run (ceiling): the allowance, or ten times it on a monthly paid plan, which bills the extras.
data_outBytes of marked files returned this month, and the allowance (1 GB = 10⁹ bytes).
time_stampsTime-stamps from POST /v1/tsa this month, and their allowance.
rate_limitCalls a minute each key may make on your plan.

Usage calls count toward the key's calls per minute, but never against your marks.