The traffic analytics endpoints give you detailed visibility into researcher activity on your HackGATE-protected sites. You can count total requests, identify the most active researchers, see which paths they have discovered, and pull timeline charts — all scoped to a time window you define. For multi-site rollups, use the summary endpoints that accept an array of URLs.
All traffic endpoints require a valid Bearer token in the Authorization header.
Common query parameters
Most single-site endpoints share these query parameters:
The hackgatedName of the HackGATE site to query. This is the subdomain identifier assigned when the site was created.
Start of the time range, as an ISO 8601 date-time string (for example, 2025-07-01T00:00:00Z).
End of the time range, as an ISO 8601 date-time string (for example, 2025-07-14T23:59:59Z).
Single-site endpoints
Total requests
Most active users
Path discovery
Traffic timeline
Traffic table
GET /api/analytics/getTotalRequest
Returns the total number of requests made through the HackGATE proxy for the specified site and time range.GET /api/analytics/getMostActiveUsers
Returns a ranked list of the researchers (by identity) who sent the most requests through the proxy during the specified time window.GET /api/analytics/getPathDiscovery
Returns the set of URL paths that researchers accessed on the target site during the time range, showing what endpoints have been explored.GET /api/analytics/getTrafficTimeline
Returns time-bucketed request counts for a single site, suitable for rendering a traffic chart over the selected period.GET /api/analytics/getTrafficTable
Returns a tabular breakdown of traffic data for a single site, including per-user or per-path detail depending on the response shape.
Multi-site summary endpoints
Use these endpoints when you need aggregated traffic data across multiple HackGATE sites in a single request. Both accept a JSON body instead of query parameters.
Summary traffic table
Summary timeline
POST /api/analytics/getSummaryTrafficTable
Returns a tabular traffic summary aggregated across the sites you specify.Body parameters
Array of hackgatedName values identifying the sites to include in the summary.
Start of the time range as an ISO 8601 date-time string.
End of the time range as an ISO 8601 date-time string.
Example
POST /api/analytics/getSummaryTimeline
Returns a time-bucketed traffic timeline aggregated across multiple sites.Body parameters
Array of hackgatedName values identifying the sites to include.
Start of the time range as an ISO 8601 date-time string.
End of the time range as an ISO 8601 date-time string.
Example
