Network Edge APIs | Equinix Product Documentation

Get Interface Statistics

Request

Returns the throughput statistics of a device interface. Pass the unique Id of the device and the interface Id as path parameters.

Security

BearerAuth

Path

virtualDeviceUuidstringrequired

Unique Id of a device

Example:3da0a663-20d9-4b8f-8c5d-d5cf706840c8

interfaceIdstringrequired

Interface Id

Example:1

Query

startDateTimestring, (date-time)

Start time of the duration for which you want stats. (YYYY-MM-DDThh:mm:ssZ)

Example:startDateTime=2023-11-10T19:06:06Z

endDateTimestring, (date-time)

End time of the duration for which you want stats. (YYYY-MM-DDThh:mm:ssZ)

Example:endDateTime=2023-11-17T19:06:06Z

Payload

// No request payload

Responses

Success

Bodyapplication/json

statsobject(InterfaceStatsDetailObject)

Detailed interface statistics

Response

{
  "stats": {
    "startDateTime": "2023-11-10T19:06:06Z",
    "endDateTime": "2023-11-17T19:06:06Z",
    "unit": "Mbps",
    "inbound": { … },
    "outbound": { … }
  }
}