For the complete documentation index, see llms.txt. This page is also available as Markdown.

Statistics

You can read residential traffic and request data in three places: the dashboard, the REST API, and per-response headers.

Dashboard

Dashboard → Residential → Statistics shows:

  • Traffic over time — bytes per minute / hour / day, stacked by sub-user

  • Top destinations — domains by traffic and request count

  • Top countries — exit IP geos used

  • Error breakdown — by HTTP status and X-Helodata-Error-Code

  • Session count — concurrent sticky sessions

  • Concurrency — peak parallel connections

Filter by sub-user, by date range, and by tag (if you set X-Helodata-Tag on requests — see below).

Data refreshes every minute. Granularity downsamples after 14 days (1-min → 5-min) and 90 days (5-min → 1-hour).

REST API

For programmatic access — useful for billing pipelines, custom dashboards, and alerting.

Get aggregate traffic

curl -H "Authorization: Bearer API_KEY" \
     "https://api.helodata.com/v1/residential/traffic?from=2026-05-01&to=2026-05-28&group_by=subuser"

Response:

group_by accepts subuser, region, asn, tag, or day.

Get per-request log (sample)

For debugging only — costs API quota. Returns the last 1,000 sampled requests.

Each entry includes status, exit IP, geo, ASN, bytes, and your tag.

Full schema: Traffic & usage.

Per-response headers

Every successful request includes these usage hints:

Use X-Helodata-Request-Id when contacting support — we can pull the full request record from it.

Tagging requests

To slice analytics by your own categories (campaign, customer, job), send a X-Helodata-Tag request header (max 64 chars, [a-z0-9_-]):

Tags appear in dashboard filters and as a group_by value in the traffic API.

Billing reconciliation

Bandwidth shown in the dashboard is what you're billed for. To reconcile against your own logs:

  1. Pull the traffic API at day granularity for the billing period.

  2. Sum bytes_in + bytes_out across sub-users.

  3. Match against the invoice line on Billing → Invoices.

Discrepancies > 1% are rare; if you see one, open a support ticket with the X-Helodata-Request-Id range and we'll investigate.

Alerts

Set up usage alerts under Dashboard → Alerts:

  • Daily traffic exceeds X GB

  • Error rate exceeds Y% over Z minutes

  • Sub-user concurrency near plan limit

Alerts deliver via email and optional Slack webhook.

Last updated

Was this helpful?