Equinix Fabric API v4 | Equinix Product Documentation

Get Metrics by Name

This API provides capability to retrieve Metrics by specific wildcard metric types

Security

BearerAuth

namestring^equinix\.fabric\.metro\.\*\..+required

Name of the metric types with wildcard:

Examples:

metroLatencyExample

name=equinix.fabric.metro.*.latency

metroJitterExample

name=equinix.fabric.metro.*.jitter_avg

valuestring(Value)required

value

Example:value=last

offsetinteger(Offset)

offset

Default:0

Example:offset=0

limitinteger(Limit-2)

limit

Default:20

Example:limit=20

Payload

// No request payload

Successful operation

Bodyapplication/json

paginationobject(Pagination)

Pagination response information

dataArray of objects(Metric)

Data returned from the API call.

Response

{
  "pagination": {
    "offset": 0,
    "limit": 5000,
    "total": 3
  },
  "data": [
    { … },
    { … },
    { … }
  ]
}