Account Management

Get API usage & credit consumption

See exactly which API calls are consuming your credits, so you can pinpoint the integration or workflow that's spending the most and dial it back.

Input: from/to (ISO-8601 timestamps; default is the last 7 days), an optional endpoint to filter to a single route (e.g. /v4/firmographic), interval (hour or day, default hour) controlling the time-series bucket size, and limit/offset (default 100 / 0) to page through the individual-call log.

Output: totalCalls and totalCredits for the window; byEndpoint — a per-route rollup sorted by spend, so you can see which route costs the most; timeSeries — calls and credits per hour or day, to spot exactly when a spike began; and calls — a paginated log of individual billed calls (timestamp, route, credits) for a precise per-call, per-time-range, per-route view.

get/api/v1/account/credits/usage

Request

  • Base URL: https://api.rodz.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.rodz.io/api/v1/account/credits/usage
  • Auth: HTTP bearer

Query parameters

fromstring date-time nullable

Window start (ISO-8601). Defaults to 7 days ago.

tostring date-time nullable

Window end (ISO-8601). Defaults to now.

endpointstring nullable

Filter to a single route, e.g. /v4/firmographic.

intervalstring

Time-series bucket size: hour or day.

limitinteger

Max individual calls to return (pagination).

offsetinteger

Offset into the individual-call log.

Response

Successful Response

fromDatestring date-time required

Start of the window (UTC).

toDatestring date-time required

End of the window (UTC).

totalCallsinteger required

Total billed calls in the window (after any route filter).

totalCreditsnumber required

Total credits consumed in the window (after any route filter).

hasMoreboolean

True if more calls exist beyond this page.

Example response

{
  "byEndpoint": [
    {
      "calls": 2414,
      "credits": 1207,
      "endpoint": "/v4/firmographic"
    },
    {
      "calls": 1242,
      "credits": 621,
      "endpoint": "/v4/contact"
    },
    {
      "calls": 100,
      "credits": 100,
      "endpoint": "/people-search"
    }
  ],
  "calls": [
    {
      "credits": 0.5,
      "endpoint": "/v4/contact",
      "timestamp": "2026-07-23T16:42:07+00:00"
    }
  ],
  "fromDate": "2026-07-16T00:00:00+00:00",
  "hasMore": true,
  "timeSeries": [
    {
      "bucket": "2026-07-23T16:00:00+00:00",
      "calls": 1031,
      "credits": 515.5
    },
    {
      "bucket": "2026-07-23T17:00:00+00:00",
      "calls": 1051,
      "credits": 525.5
    }
  ],
  "toDate": "2026-07-23T20:00:00+00:00",
  "totalCalls": 3756,
  "totalCredits": 1928
}

Changes

No recorded changes to this operation across all 1 revision of this API.