Account
tier:free

Get your API key's usage

Returns the requests this API key made in the current billing period (or today), broken down by endpoint and MCP tool, with how many bill per call. Free. Counts come from the request log, which keeps 90 days. MCP calls made through an OAuth grant are not attributed to any key.

get/v1/me/usage

Request

  • Base URL: https://api.particle.pro
  • URL: https://api.particle.pro/v1/me/usage
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

period'current' | 'today'

current: the organization's billing period (the UTC calendar month without a subscription). today: the current UTC day.

Response

OK

billable_requestsinteger required

Requests this key made that bill per call: successful calls to priced endpoints, and calls to paid MCP tools, which are metered when the call starts and so count even when the tool then fails or is denied. Free endpoints such as /v1/me are never counted, nor are endpoints and MCP tools billed through plan features rather than per call (alerts, the episode archive and stream), nor a retried write answered from its first response under an Idempotency-Key.

endpoints_truncatedboolean required

True when the key called more endpoints than endpoints lists. The totals above still cover all of them unless totals_partial is set.

errorsinteger required

Requests that returned an HTTP status of 400 or above.

requestsinteger required

Requests this key made in the period, including failed and free ones.

totals_partialboolean required

True in the rare case a key called more distinct endpoints, tools and unrouted paths than one report reads (5,000). requests still counts every request, but billable_requests and errors then cover only the busiest 5,000 of them.

Changes

No recorded changes to this operation across all 2 revisions of this API.