Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hackgate.io/llms.txt

Use this file to discover all available pages before exploring further.

HackGATE records every request that passes through your proxy and makes this data available through the Analytics API. You can query traffic stats, see which researchers are most active, and discover which paths they’ve been testing — all scoped to your HackGATE URL and a time range.
All analytics queries use the url parameter set to your HackGATEd URL (e.g. example-yourorg.hackgate.net), and gte/lte for the time range in ISO 8601 format.

​
Total requests

Get the total number of requests that passed through your HackGATE in a given time range: 
curl "https://admin.hackgate.io/api/analytics/getTotalRequest?url=example-yourorg.hackgate.net&gte=2024-01-01T00:00:00Z&lte=2024-01-31T23:59:59Z" \
  -H "Authorization: Bearer <your-token>"
Returns the total hit count across the time range.

​
Most active researchers

Get the top researchers ranked by request count: 
curl "https://admin.hackgate.io/api/analytics/getMostActiveUsers?url=example-yourorg.hackgate.net&gte=2024-01-01T00:00:00Z&lte=2024-01-31T23:59:59Z" \
  -H "Authorization: Bearer <your-token>"
Returns the top 10 researchers ranked by request count.

​
Path discovery

See which URL paths researchers have been testing, ranked by how frequently each was hit: 
curl "https://admin.hackgate.io/api/analytics/getPathDiscovery?url=example-yourorg.hackgate.net&gte=2024-01-01T00:00:00Z&lte=2024-01-31T23:59:59Z" \
  -H "Authorization: Bearer <your-token>"
Returns up to 1,000 paths with hit counts.

​
Traffic timeline

Get an hourly breakdown of requests per researcher: 
curl "https://admin.hackgate.io/api/analytics/getTrafficTimeline?url=example-yourorg.hackgate.net&gte=2024-01-01T00:00:00Z&lte=2024-01-31T23:59:59Z" \
  -H "Authorization: Bearer <your-token>"

​
Activity log

The activity log shows when your HackGATE was deployed, started, and stopped: 
curl https://admin.hackgate.io/api/sites/getLog/<site-id> \
  -H "Authorization: Bearer <your-token>"
Response: 
[
  { "id": "log1", "date": "2024-01-15T10:30:00Z", "action": "Deployed" },
  { "id": "log2", "date": "2024-01-15T10:35:00Z", "action": "Started" },
  { "id": "log3", "date": "2024-01-29T17:00:00Z", "action": "Stopped" }
]

​
Monthly usage

Get the number of unique days your HackGATE was active in a given month: 
curl "https://admin.hackgate.io/api/sites/getUsageByMonth/<site-id>?year=2024&month=1" \
  -H "Authorization: Bearer <your-token>"
Response: 
{ "year": 2024, "month": 1, "uniqueDays": 15 }
Last modified on May 9, 2026