bandwidth_squad_usage
Get internal squad users' traffic usage for a date range, filtered by minimum total bytes and scoped to nodes reachable through the squad's inbounds.
Instructions
Get internal squad users traffic usage for a period. Returns users whose total usage over the period on the given nodes is >= minTotalBytes, scoped to the nodes reachable via the internal squad inbounds. Underlying usage data is flushed to the database roughly every 2 minutes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | Yes | End date (YYYY-MM-DD) | |
| uuid | Yes | Internal squad UUID | |
| limit | No | Number of users to return, no more than 1000 | |
| start | Yes | Start date (YYYY-MM-DD) | |
| cursor | No | Pass the nextCursor from the previous response. Omit on the first request. | |
| minTotalBytes | No | Only include users whose total usage over the period is >= this (bytes) |