Skip to main content
GET
Get Usage Statistics
Retrieve live proxy usage statistics for a datacenter order — the same data shown on the dashboard’s usage view.
Only available for datacenter orders. Residential and other product categories have no usage source and return 400.

How It Works

Usage is read live at request time (no caching) from every server that serves the order’s product, combined, and returned as a usage time series plus a list of the top requested domains. If a server does not answer within 5 seconds, its share of the usage is left out and the request still succeeds. Totals reflect only the servers that answered. If none answer, you get 200 with zero totals and empty lists.

Request

Headers

Path Parameters

string
required
The order ID returned from order creation.

Query Parameters

string
default:"monthly"
The reporting granularity. One of daily, weekly, monthly.
  • daily — time series is keyed by hour ("00"–"23")
  • weekly — time series is keyed by day of month ("01" to "31") for each day of the week, Sunday first
  • monthly — time series is keyed by day of month ("01"–"31")
string
ISO date string selecting the reporting window (e.g. 2026-06-25). Defaults to today.

Example Requests

Response

Success Response

Response Fields

string
Status of the request.
string
The order the statistics are for.
string
The reporting granularity that was applied (daily, weekly, or monthly).
object
The aggregated usage data.
array
Per-bucket usage. Each entry has a date key (hour for daily, day of month for weekly and monthly), timestamp (the bucket start as an ISO date-time with no time zone), usage (megabytes transferred in that bucket), and requests (request count for that bucket). The series starts at the first bucket with data.
object
Totals across all servers that answered. bytes_in and bytes_out both hold the total bytes transferred (they are always equal); requests is the total request count.
array
The most-requested domains, sorted by request count (descending), limited to the top 100. requestPercentage is computed across the aggregated set. Each entry has url, requests, bytesTransferred, megabytesTransferred (string), firstVisit / mostRecentVisit (display strings), firstVisitAt / mostRecentVisitAt (ISO 8601), and requestPercentage (string). The first-visit fields are only filled for daily; they are null for weekly and monthly.

Error Responses

400 Bad Request - Invalid Period

400 Bad Request - Invalid Date

400 Bad Request - Not a Datacenter Order

401 Unauthorized

404 Not Found

500 Internal Server Error

Notes

  • The key must include the order service. Calls count toward the 60 requests per minute per-key limit.
  • Data is fetched live with no caching, so responses can take several seconds.