Skip to content

Get XML statistics

GET /xml/stats

Returns XML traffic statistics for one owned TID.

Query parameters

ParameterRequiredDescription
tokenYesPublisher API key with publisher:xml:read.
tidYesPositive XML traffic-source/account identifier.
date_fromYesInclusive start date in YYYY-MM-DD.
date_toYesInclusive end date in YYYY-MM-DD.
groupByNoday, geo, or subid; default day.
exportNojson or csv.
bash
curl --get "https://api.example.com/xml/stats" \
  --data-urlencode "token=YOUR_NEXUS_API_KEY" \
  --data-urlencode "tid=12345" \
  --data-urlencode "date_from=2026-08-01" \
  --data-urlencode "date_to=2026-08-17" \
  --data-urlencode "groupBy=day"
bash
curl --get "https://api.example.com/xml/stats" \
  --data-urlencode "token=YOUR_NEXUS_API_KEY" \
  --data-urlencode "tid=12345" \
  --data-urlencode "date_from=2026-08-01" \
  --data-urlencode "date_to=2026-08-17" \
  --data-urlencode "groupBy=geo"
bash
curl --get "https://api.example.com/xml/stats" \
  --data-urlencode "token=YOUR_NEXUS_API_KEY" \
  --data-urlencode "tid=12345" \
  --data-urlencode "date_from=2026-08-01" \
  --data-urlencode "date_to=2026-08-17" \
  --data-urlencode "groupBy=subid"

Example daily response

json
{
  "status": "success",
  "message": "XML API report",
  "data": [
    {
      "date": "2026-08-17",
      "gross_requests": 26023392,
      "gross_clicks": 10356,
      "gross_valid": 10356,
      "gross_invalid": 0,
      "gross_revenue": 5.28,
      "net_requests": 0,
      "net_clicks": 3749,
      "net_revenue": 2.25
    }
  ]
}

Errors

  • 403 — the TID is invalid, foreign, or forbidden for this key.
  • 404 — no data was available for the requested export.
  • 422 — invalid dates, grouping, export format, or numeric input.

White-label Nexus API documentation