Skip to main content
Loading...

API docs by

Get Metrics by Asset Id (Deprecated)
deprecated

Request

This API provides capability to retrieve Metrics of an asset id

Security
BearerAuth
Path
assetstring(MetricAssetType)required

asset

Enum:"ports""connections""metros"
assetIdstring, (uuid)required

asset UUID

Example:757400f8-d360-11e9-bb65-2a2ae2dbcce6
Query
namestring^equinix\.fabric\.(connection|port|metro)\..+required

Name of the metric types:

  • equinix.fabric.connection.bandwidth_rx.usage
  • equinix.fabric.connection.bandwidth_tx.usage
  • equinix.fabric.connection.packets_dropped_rx_aside_rateexceeded.count
  • equinix.fabric.connection.packets_dropped_tx_aside_rateexceeded.count
  • equinix.fabric.connection.packets_dropped_rx_zside_rateexceeded.count
  • equinix.fabric.connection.packets_dropped_tx_zside_rateexceeded.count
  • equinix.fabric.connection.byte_rx.count
  • equinix.fabric.connection.byte_tx.count
  • equinix.fabric.connection.bandwidth_rx.usage_summary
  • equinix.fabric.connection.bandwidth_tx.usage_summary
  • equinix.fabric.port.bandwidth_rx.usage
  • equinix.fabric.port.bandwidth_tx.usage
  • equinix.fabric.port.packets_dropped_rx.count
  • equinix.fabric.port.packets_dropped_tx.count
  • equinix.fabric.port.packets_erred_rx.count
  • equinix.fabric.port.packets_erred_tx.count
  • equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.latency
  • equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.jitter_avg
Examples:
connectionRxUsageExample
name=equinix.fabric.connection.bandwidth_rx.usage
connectionTxUsageExample
name=equinix.fabric.connection.bandwidth_tx.usage
connectionRxPacketAsideDroppedExample
name=equinix.fabric.connection.packets_dropped_rx_aside_rateexceeded.count
connectionTxPacketAsideDroppedExample
name=equinix.fabric.connection.packets_dropped_tx_aside_rateexceeded.count
connectionRxPacketZsideDroppedExample
name=equinix.fabric.connection.packets_dropped_rx_zside_rateexceeded.count
connectionTxPacketZsideDroppedExample
name=equinix.fabric.connection.packets_dropped_tx_zside_rateexceeded.count
connectionRxByteCountExample
name=equinix.fabric.connection.byte_rx.count
connectionTxByteCountExample
name=equinix.fabric.connection.byte_tx.count
connectionRxBandwidthUsageSummaryExample
name=equinix.fabric.connection.bandwidth_rx.usage_summary
connectionTxBandwidthUsageSummaryExample
name=equinix.fabric.connection.bandwidth_tx.usage_summary
portRxUsageExample
name=equinix.fabric.port.bandwidth_rx.usage
portTxUsageExample
name=equinix.fabric.port.bandwidth_tx.usage
portRxPacketDroppedExample
name=equinix.fabric.port.packets_dropped_rx.count
portTxPacketDroppedExample
name=equinix.fabric.port.packets_dropped_tx.count
portRxPacketErredExample
name=equinix.fabric.port.packets_erred_rx.count
portTxPacketErredExample
name=equinix.fabric.port.packets_erred_tx.count
metroLatencyExample
name=equinix.fabric.metro.sv_dc.latency
metroJitterExample
name=equinix.fabric.metro.sv_dc.jitter_avg
fromDateTimestring, (date-time)(StartDateTime)

Start date and time

Example:fromDateTime=2024-07-11T18:06:21.000Z
toDateTimestring, (date-time)(EndDateTime)

End date and time

Example:toDateTime=2024-07-11T18:06:21.000Z
offsetinteger(Offset)

offset

Default:0
Example:offset=0
limitinteger(Limit-2)

limit

Default:20
Example:limit=20
Payload
// No request payload

Responses

Successful operation

Bodyapplication/json
paginationobject(Pagination)

Pagination response information

dataArray of objects(Metric)

Data returned from the API call.

Response
{
  "pagination": {
    "offset": 0,
    "limit": 10,
    "total": 2,
    "next": null,
    "previous": null
  },
  "data": [
    { … },
    { … }
  ]
}
Was this page helpful?