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

cURL

cURL

curl -H "X-API-Key: $PARTICLE_API_KEY" \
  "https://api.particle.pro/v1/me/usage?period=current"

200

{
  "api_key": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "key_prefix": "<string>",
    "name": "<string>",
    "created_by": {
      "id": "<string>",
      "name": "<string>"
    },
    "expires_at": "2023-11-07T05:31:56Z",
    "last_used_at": "2023-11-07T05:31:56Z"
  },
  "billable_basis": "requests",
  "billable_requests": 123,
  "endpoints": [
    {
      "billable_requests": 123,
      "endpoint": "<string>",
      "errors": 123,
      "method": "<string>",
      "requests": 123,
      "mcp_tool": "<string>"
    }
  ],
  "endpoints_truncated": true,
  "errors": 123,
  "period": {
    "end": "2023-11-07T05:31:56Z",
    "name": "current",
    "source": "billing_period",
    "start": "2023-11-07T05:31:56Z",
    "counts_since": "2023-11-07T05:31:56Z"
  },
  "requests": 123,
  "totals_partial": true
}

Authorizations

ApiKeyHeaderBearerAuth

X-API-Key · string · header · required

Pass your API key in the X-API-Key header (recommended).

Query Parameters

period · enum<string> · default: current

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

Available options: current, today

Response

200

application/json

OK

api_key · object · required

The key the request authenticated with. Only its prefix is returned, never the full key.

Show child attributes

billable_basis · enum<string> · required

What billable_requests counts. requests: the plan bills in requests, so each call counts the requests it draws. calls: the plan bills calls in dollars, or the organization has no plan, so each call that bills counts once. calls_fallback: billing data could not be reached, so each call that bills counts once and a transcription request counts 1 rather than the requests it draws.

Available options: requests, calls, calls_fallback

billable_requests · integer<int64> · required

Requests this key's calls billed in the period, counted as billable_basis says. On a plan billed in requests, each call counts the requests it draws from the plan's included requests, or past them as overage: most draw 1, a transcription request that queues an episode draws 100, and a call to an endpoint or tool your subscription does not price draws nothing. Otherwise each call that bills counts once. Calls that bill: 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), a retried write answered from its first response under an Idempotency-Key, or a transcription request whose charge was refunded because the episode could not be transcribed.

endpoints · object[] | null · required

Usage by endpoint and MCP tool, busiest first, at most 100 rows.

Show child attributes

endpoints_truncated · boolean · required

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

errors · integer<int64> · required

Requests that returned an HTTP status of 400 or above.

period · object · required

The window the usage covers.

Show child attributes

requests · integer<int64> · required

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

totals_partial · boolean · 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.