Skip to main content
GET
/
usage-stats
Get Usage Statistics
curl --request GET \
  --url https://api.spidra.io/api/usage-stats \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "data": [
    {
      "label": "Dec 12",
      "date": "2025-12-12",
      "tokens": 3500,
      "requests": 15,
      "crawls": 2,
      "captchas": 3,
      "latency": 4200,
      "credits": 20
    }
  ]
}
This endpoint returns aggregated usage metrics for your account over a selected time window. Use it to build usage dashboards, monitor credit burn rate, or understand how your workloads are distributed across days and weeks.

Time Ranges

Pass the range query parameter to select the window you want:
ValueDescription
7dLast 7 days, one data point per day
30dLast 30 days, one data point per day
weeklyLast 7 weeks, one data point per week
# Last 7 days
curl "https://api.spidra.io/api/usage-stats?range=7d" \
  -H "x-api-key: YOUR_API_KEY"

# Last 30 days
curl "https://api.spidra.io/api/usage-stats?range=30d" \
  -H "x-api-key: YOUR_API_KEY"

# Weekly summary (last 7 weeks)
curl "https://api.spidra.io/api/usage-stats?range=weekly" \
  -H "x-api-key: YOUR_API_KEY"

Response Fields

Each item in the data array represents one time period.
FieldTypeDescription
labelstringDisplay label for this period, suitable for chart axes. For example: "Mon", "Dec 12", or "Week 50"
datestringThe date or date range this data point covers
requestsnumberNumber of scrape requests made in this period
crawlsnumberNumber of crawl jobs started in this period
tokensnumberTotal AI tokens consumed (input and output combined)
captchasnumberNumber of CAPTCHAs solved in this period
latencynumberAverage response latency in milliseconds
creditsnumberCredits consumed in this period

Example Response

{
  "status": "success",
  "data": [
    {
      "label": "Dec 11",
      "date": "2025-12-11",
      "requests": 42,
      "crawls": 3,
      "tokens": 58400,
      "captchas": 6,
      "latency": 4100,
      "credits": 89
    },
    {
      "label": "Dec 12",
      "date": "2025-12-12",
      "requests": 15,
      "crawls": 2,
      "tokens": 21700,
      "captchas": 1,
      "latency": 3900,
      "credits": 32
    }
  ]
}

Errors

If you omit the range parameter or pass an unsupported value, the API returns a 400 error:
{
  "status": "error",
  "message": "Invalid or missing range"
}
For a full explanation of what each metric means and how to read your usage data, see the Usage and Analytics guide.

Authorizations

x-api-key
string
header
required

Query Parameters

range
enum<string>
required

Time range: '7d' (last 7 days), '30d' (last 30 days), or 'weekly' (last 7 weeks)

Available options:
7d,
30d,
weekly

Response

Usage statistics

status
enum<string>
Available options:
success
data
object[]