Skip to content

Retrieve traffic data

GET
/analytics/traffic

Returns traffic data for a specific IP address over a given time period.

Parameters

Query Parameters

ip
string

The IP address to retrieve traffic data for

unit
required
string
Allowed values: mbps pps

The unit of measurement for traffic data (megabits per second or packets per second)

time
required
integer
>= 1
3600

The time period in seconds for which to retrieve traffic data

Responses

200

Successful retrieval of traffic data

object
data
object
interval

The number of minutes between each data point

integer
1
traffic

Array of traffic data points [timestamp, allowed traffic, dropped traffic]

Array<Array<number>>
[
[
1724781300,
40023,
0
],
[
1724781360,
744910,
0
]
]
success
boolean
true

400

Bad request (e.g., invalid parameters)

object
success
boolean
message
string
Invalid parameters