Skip to main content
POST
/
statistics
/
l2_interface
Get l2 Statistics
curl --request POST \
  --url https://api.example.com/statistics/l2_interface \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "since": "2023-11-07T05:31:56Z",
  "until": "2023-11-07T05:31:56Z",
  "column": [
    "rx_bytes"
  ],
  "filters": {
    "vrf_name": "<string>",
    "alias_name": "<string>",
    "l2_name": "<string>",
    "tenant_name": "<string>",
    "node_name": "<string>",
    "system_name": "<string>"
  },
  "sample_rate": "auto",
  "flags": {}
}
'
{
  "sample_rate": "<string>",
  "samples": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
since
string<date-time>
required
​
until
string<date-time>
required
​
column
enum<string>[]
required
Available options:
rx_bytes,
tx_bytes,
rx_bits,
tx_bits,
rx_packets,
tx_packets,
rx_bytes_dropped_by_meter,
tx_bytes_dropped_by_meter,
rx_packets_dropped_by_meter,
tx_packets_dropped_by_meter,
rx_bps,
tx_bps,
rx_pps,
tx_pps,
rx_bps_dropped_by_meter,
tx_bps_dropped_by_meter,
rx_pps_dropped_by_meter,
tx_pps_dropped_by_meter,
incoming_bps,
outgoing_bps,
incoming_pps,
outgoing_pps
​
filters
StatisticsL2Filters · object
required
​
sample_rate
enum<string>
default:auto

Enum defining the sample rate in any Statistics API request

Available options:
auto,
10s,
30s,
1m,
5m,
15m,
1h
​
flags
StatisticsFlags · object

Response

Successful Response

​
sample_rate
string
required
​
samples
Samples · object[]