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 values are scraped live at request time from each child proxy server’s usage report (no caching), aggregated across every server that hosts the order, and returned as a usage time series plus a list of the top requested domains. Because the data is fetched live, if a child server hosting the order is not currently producing usage reports, its slice of usage is omitted (each per-server fetch has a 5s timeout and fails open). Totals therefore reflect only the servers that are reporting.

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 week
  • 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, day of week, or day of month depending on period), usage (megabytes transferred for that bucket), and requests (the request/hit count for that bucket).
object
Aggregate totals across all reporting servers. bytes_in and bytes_out are raw byte totals; requests is the total hit count.
array
The most-requested domains, sorted by request count (descending), limited to the top 100. requestPercentage is computed across the aggregated set.

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 have the order service scope. Each call is rate-limited per key and recorded in the audit log (service: order, action: read).
  • Data is fetched live with no caching, so response time depends on how many servers host the order.