Subscription Data
The subscriptionData endpoint enables retrieving API Plus streaming subscription messages.
Get Subscription Data
| GET /smartview/v2/streaming/subscriptionData/{subscriptionId} | |
|---|---|
| Method | GET |
| URL or Endpoint | /smartview/v2/streaming/subscriptionData/{subscriptionId} |
| Headers | Authorization |
| Path Parameters | subscriptionId |
| Query Parameters | ibxs, messageTypes, streamIds, offset, limit |
| Body Parameters | Not applicable |
This API request retrieves API Plus subscription feed messages.
If you are unaware of how to obtain an authorization token, refer Requesting Access and Refresh tokens under Getting Access Token.
Sample curl request
curl -X
GET 'https://api.equinix.com/smartview/v2/streaming/subscriptionData/0f6bdb36-e130-4924-b038-ee1785fad999'
Path parameters
Parameter | Description |
|---|---|
subscriptionId string REQUIRED | Streaming subscription instance identifier. Example: 0f6bdb36-e130-4924-b038-ee1785fad999 |
Query parameters
Parameter | Description |
|---|---|
ibxs array[string] OPTIONAL | IBX data centers identifiers. Example: LD9 |
messageTypes array[string] OPTIONAL | Message types filter. Applicable values:
|
streamIds array[string] OPTIONAL | Identifies a data stream with messages from a specific asset instance. Example: 20409808 |
offset integer OPTIONAL | Index of the first item returned in the response. Example: 10 |
limit integer OPTIONAL | Maximum number of items returned per page. Example: 100 |
Sample response
{
"alarmMessageData": [],
"alertMessageData": [],
"environmentMessageData": [],
"meteredPowerMessageData": [],
"powerMessageData": [
{
"type": "power",
"data": {
"streamId": "20409808",
"ibx": "LD9",
"asset": {
"id": "20409808",
"type": "CIRCUIT"
},
"cage": "LD9:0G:0Z10BB",
"cabinet": "LD9:0G:0Z10BB:0109",
"accountNumber": "116710",
"description": "32-amp 230v Single Phase Primary AC Power",
"oid": "1.3.6.1.2.1.299.36.10.4442",
"realPower": {
"value": "0.000",
"unit": "kW"
},
"apparentPower": {
"value": "0.000",
"unit": "kVA"
},
"current": {
"value": "0.000",
"unit": "A"
},
"powerFactor": {
"value": "0.000",
"unit": "pf"
},
"soldCurrent": {
"value": "32.000",
"unit": "A"
},
"soldPower": {
"value": "7.360",
"unit": "kVA"
},
"powerConsumptionToContractual": {
"value": "0.000",
"unit": "PERCENT"
},
"peakLastSevenDays": {
"value": "0.000",
"unit": "kVA"
},
"peakLastSevenDaysRatio": {
"value": "0.000",
"unit": "PERCENT"
},
"peakLastSevenDaysContractualPower": {
"value": "7.360",
"unit": "kVA"
},
"peakLastSevenDaysTime": "2023-12-06T05:45:00",
"lastUpdated": "2023-12-07T15:49:00",
"readingTime": "2023-12-07T15:45:00"
}
},
{
"type": "power",
"data": {
"streamId": "20409809",
"ibx": "LD9",
"asset": {
"id": "20409809",
"type": "CIRCUIT"
},
"cage": "LD9:0G:0Z10BB",
"cabinet": "LD9:0G:0Z10BB:0109",
"accountNumber": "116710",
"description": "32-amp 230v Single Phase Redundant AC Power",
"oid": "1.3.6.1.2.1.299.36.10.4443",
"realPower": {
"value": "0.000",
"unit": "kW"
},
"apparentPower": {
"value": "0.000",
"unit": "kVA"
},
"current": {
"value": "0.000",
"unit": "A"
},
"powerFactor": {
"value": "0.000",
"unit": "pf"
},
"soldCurrent": {
"value": "32.000",
"unit": "A"
},
"soldPower": {
"value": "7.360",
"unit": "kVA"
},
"powerConsumptionToContractual": {
"value": "0.000",
"unit": "PERCENT"
},
"peakLastSevenDays": {
"value": "0.000",
"unit": "kVA"
},
"peakLastSevenDaysRatio": {
"value": "-1.000",
"unit": "PERCENT"
},
"peakLastSevenDaysContractualPower": {
"value": "0.000",
"unit": "kVA"
},
"peakLastSevenDaysTime": "2023-12-06T22:15:00",
"lastUpdated": "2023-12-07T15:49:00",
"readingTime": "2023-12-07T15:45:00"
}
}
],
"tagPointMessageData": [],
"pagination": {
"offset": 0,
"limit": 250,
"total": 46,
"next": null,
"previous": "?offset=0&limit=250"
}
}