Understanding the analytics, logging, and tracking systems in the Ping Proxies API
log
): Detailed individual request data, retained for 7 dayslog_summary
): Aggregated daily usage patterns, retained for 90+ daysresidential_ledger
): Residential bandwidth accounting records, retained indefinitely/analytics/graph
endpoint processes data from both logs and log summaries to provide comprehensive visualizations regardless of the age of the data being analyzed.
log
)proxy_user_id
levellog_summary
)proxy_user_id
, network
, and hostname
for the first 90 daysproxy_user_id
and network
level (hostname details are removed)residential_ledger
)log
record is createdlog_summary
is incremented or created if it doesn’t existlog
record is createdlog_summary
is incremented or createdresidential_ledger
usage record is incremented or created/analytics/graph
endpoint for most usage monitoring scenarios/log_summary
or /log
endpoints when you need to see information on specific requests or detailed breakdowns by hostname, proxy user ID, or network on a daily basis/residential_ledger
endpoints are best used specifically for monitoring daily residential bandwidth allocation changesEndpoint | Purpose | Retention | Granularity |
---|---|---|---|
/log/search | Search raw logs | 7 days | Individual requests |
/log/retrieve/{log_id} | Get specific raw log | 7 days | Individual request |
/log_summary/search | Search log summaries | 90+ days | Daily aggregations |
/log_summary/retrieve/{log_summary_id} | Get specific log summary | 90+ days | Daily aggregation |
/residential_ledger/search | Search residential usage records | Indefinite | Daily usage |
/residential_ledger/retrieve/{residential_ledger_id} | Get specific residential usage entry | Indefinite | Daily usage |
/analytics/graph | Visualize usage patterns | Indefinite | Configurable intervals |
/residential/summary | Get overall residential bandwidth status | Current | Account-level summary |