Equinix SmartView APIs | Equinix Product Documentation

Retrieve subscription data via REST

Request

This endpoint allows users to obtain API+ near real time data via a simple REST endpoint by employing subscription ID alongside other specified criteria, enabling a comprehensive and targeted approach to data retrieval. Subscription data endpoint works for all channels and not just REST channel.

Security

BearerAuth

Path

subscriptionIdstringrequired

Subscription ID

Query

ibxsArray of strings

Filter, set of IBXs

messageTypesArray of strings

Filter, set of message types

Items Enum:"ALARM""ALERT""ENVIRONMENTAL""METERED_POWER""POWER""TAG_POINT"

streamIdsArray of strings

Filter, set of stream IDs

offsetinteger, (int32)

Pagination, offset of the first item

Default:0

limitinteger, (int32)

Pagination, limit of items returned

Default:250

Payload

// No request payload

Responses

OK

Bodyapplication/json

alarmMessageDataArray of objects(AlarmMessageData)

alarm message data

alertMessageDataArray of objects(AlertMessageData)

alert message data

environmentMessageDataArray of objects(EnvironmentMessageData)

environment message data

meteredPowerMessageDataArray of objects(MeteredPowerMessageData)

metered-power message data

powerMessageDataArray of objects(PowerMessageData)

power message data

tagPointMessageDataArray of objects(TagPointMessageData)

tag-point message data

paginationobject(Pagination)

Represents pagination component of the paginated response

Response

{
  "alarmMessageData": [
    { … }
  ],
  "alertMessageData": [
    { … }
  ],
  "environmentMessageData": [
    { … }
  ],
  "meteredPowerMessageData": [
    { … }
  ],
  "powerMessageData": [
    { … }
  ],
  "tagPointMessageData": [
    { … }
  ],
  "pagination": {
    "offset": 0,
    "limit": 0,
    "total": 0,
    "next": "string",
    "previous": "string"
  }
}