Traffic Summary

GET/api/v1/admin/proxy/traffic-stats/summary

note

This endpoint requires Admin API Key authentication via the X-Admin-Key header.

Returns aggregated traffic statistics for all modems, useful for comparing carrier usage and reliability.

Query Parameters

location_idstring

Filter by location UUID

daysintegerdefault: 30

Number of days to analyze (1-365)

Response

period_daysinteger

Number of days analyzed

modem_countinteger

Number of modems included

modemsarray

Array of modem traffic summaries

Each modem summary contains:

Identification

• modem_id: Modem UUID
• carrier: Carrier name
• proxy_port: Proxy port number
• status: Current status (online/offline)
• is_healthy: Health status

Current (Today's Metrics)

• requests_today: Today's request count
• bytes_today: Today's bytes transferred
• rotations_today: Today's rotation count

Lifetime (All-Time Metrics)

• requests_total: Total requests ever
• bytes_total_gb: Total data in GB

Period (Analysis Window)

• days_analyzed: Days with data
• requests: Total requests
• failed_requests: Failed requests
• success_rate: Success percentage
• bytes_gb: Data transferred in GB
• rotations: IP rotations
• uptime_hours: Total uptime
• downtime_hours: Total downtime
• uptime_percent: Uptime percentage

Request Example

curl -X GET "https://spideriq.ai/api/v1/admin/proxy/traffic-stats/summary?days=30" \
  -H "X-Admin-Key: your_admin_key"

import requests

response = requests.get(
    "https://spideriq.ai/api/v1/admin/proxy/traffic-stats/summary",
    params={"days": 30},
    headers={"X-Admin-Key": "your_admin_key"}
)

# Find most reliable modem
for modem in response.json()["modems"]:
    print(f"{modem['carrier']} port {modem['proxy_port']}: "
          f"{modem['period']['success_rate']}% success, "
          f"{modem['period']['uptime_percent']}% uptime")

Response Example

{
  "period_days": 30,
  "modem_count": 4,
  "modems": [
    {
      "modem_id": "11111111-1111-1111-1111-111111111111",
      "carrier": "lifecell",
      "proxy_port": 3101,
      "status": "online",
      "is_healthy": true,
      "current": {
        "requests_today": 1523,
        "bytes_today": 423567890,
        "rotations_today": 24
      },
      "lifetime": {
        "requests_total": 892345,
        "bytes_total_gb": 228.7
      },
      "period": {
        "days_analyzed": 30,
        "requests": 45000,
        "failed_requests": 90,
        "success_rate": 99.8,
        "bytes_gb": 12.5,
        "rotations": 720,
        "uptime_hours": 715.2,
        "downtime_hours": 4.8,
        "uptime_percent": 99.3
      }
    },
    {
      "modem_id": "22222222-2222-2222-2222-222222222222",
      "carrier": "MTS UKR",
      "proxy_port": 3103,
      "status": "online",
      "is_healthy": true,
      "current": {
        "requests_today": 1245,
        "bytes_today": 345678901,
        "rotations_today": 24
      },
      "lifetime": {
        "requests_total": 756234,
        "bytes_total_gb": 195.4
      },
      "period": {
        "days_analyzed": 30,
        "requests": 38000,
        "failed_requests": 152,
        "success_rate": 99.6,
        "bytes_gb": 10.2,
        "rotations": 720,
        "uptime_hours": 712.8,
        "downtime_hours": 7.2,
        "uptime_percent": 99.0
      }
    }
  ]
}

Use Cases

1. Carrier Reliability: Compare success rates across carriers
2. Usage Billing: Track data consumption per modem
3. Capacity Planning: Identify underutilized modems
4. SLA Monitoring: Track uptime percentages
5. Cost Optimization: Find best value carriers