Metrics
Get aggregated traffic data for a given time period.
Enterprise feature
Gets traffic usage data for the selected period, either aggregated by day or by month.
get/api/admin/metrics/traffic
Query parameters
grouping'daily' | 'monthly' required
Example:daily
Whether to aggregate the data by month or by day
fromstring date required
Example:2024-01-01
The starting date of the traffic data usage search in IS:yyyy-MM-dd format
tostring date required
Example:2024-01-31
The starting date of the traffic data usage search in IS:yyyy-MM-dd format
Response
trafficUsageDataSegmentedCombinedSchema
Example response
{
"grouping": "monthly",
"dateRange": {
"from": "2023-04-01",
"to": "2023-04-30"
},
"apiData": [
{
"apiPath": "/api/client",
"dataPoints": [
{
"period": "2023-04-01",
"trafficTypes": [
{
"group": "successful-requests",
"count": 42
}
]
}
]
}
]
}