Skip to main content

Equinix SmartView APIs (2.0)

Download OpenAPI specification:Download

Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments. The Smart View APIs provide insights into power, environmental, mechanical, and electrical data, allowing users to access information in near-real-time or from a historical perspective.

Customers leverage Smart View APIs to:

  1. Monitor their assets in near-real-time through our Subscription API.
  2. Strategically plan power investments using the Power API.
  3. Gain a comprehensive understanding of the status of various assets that support their deployments.

For more information, please visit the Equinix Smart View Documentation Page.

SmartView Environment APIs

Empower yourself with Smart View Environment APIs. These APIs allow you to fetch current and trending environmental data (humidity and temperature) for your assets. You can retrieve data for a single sensor (by IBX code and sensor ID), for all sensors within an IBX (with pagination and sorting), or for a specific level value (IBX, zone, cage, cabinet, sensor). The APIs support both real-time and historical queries, enabling comprehensive monitoring and planning.

Retrieve current environmental data

The API returns environment information on temperature and humidity from inputs (ibx, zone, cage, sensor)

Authorizations:
BearerAuth
query Parameters
accountNo
required
string

Customer Account Number

ibx
required
string

IBX Code

levelType
required
string
Enum: "IBX" "ZONE" "CAGE" "SENSOR"

Level Type

levelValue
required
string

Level Value is ibxCode, zoneUsID, cageUsID, sensorid for levelType ibx, zone, cage, sensor resp.

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
object
ibx
string

ibx code

accountNo
string

account number

zone
string

zone unique space id

cage
string

cage unique space id

cabinet
string

cabinet unique space id

sensor
string

sensor id

temperature
string

current temperature

humidity
string

current humidity

timestamp
string

epoch timestamp when the current reading was read

temperatureUom
string

unit of measure for temperature values

humidityUom
string

unit of measure for humidity

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|3004|3005|4000|5000|6001] are the possible status codes

msg
string

[Ok|Invalid Level Type|Invalid Level Value|Invalid Account Details Or User is not Entitled|User Preference is not set as expected in the account|Invalid IBX|Invalid Account number|User is not entitled to the ibx|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR|NO_DATA|UNAUTHORISZED_ACCESS] are the possible messages

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

Retrieve a list of environmental data

The API returns environment info (humidity and temperature) for all the values for input level type IBX, ZONE, CAGE, SENSOR.

Authorizations:
BearerAuth
query Parameters
accountNo
required
string

Customer Account Number

ibx
required
string

IBX Code

levelType
required
string
Enum: "IBX" "ZONE" "CAGE" "SENSOR"

Level Type

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
object
totalCount
integer

total number of data values

Array of objects (EnvironmentDataForArray)
Array
ibx
string

ibx code

accountNo
string

account number

zone
string

zone unique space id

cage
string

cage unique space id

cabinet
string

cabinet unique space id

sensor
string

sensor id

temperature
string

current temperature

humidity
string

current humidity

timestamp
string

epoch timestamp when the current reading was read

temperatureUom
string

unit of measure for temperature values

humidityUom
string

unit of measure for humidity

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|3004|3005|4000|5000|6001] are the possible status codes

msg
string

[Ok|Invalid Level Type|Invalid Level Value|Invalid Account Details Or User is not Entitled|User Preference is not set as expected in the account|Invalid IBX|Invalid Account number|User is not entitled to the ibx|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR|NO_DATA|UNAUTHORISZED_ACCESS] are the possible messages

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

Retrieve trending environmental data

The API returns trending environment information (temperature and humidity) for input ibx, zone, cage, sensor.

Authorizations:
BearerAuth
query Parameters
accountNo
required
string

Customer Account Number

ibx
required
string

IBX Code

dataPoint
required
string
Enum: "temperature" "humidity"

Data point

levelType
required
string
Enum: "IBX" "ZONE" "CAGE" "SENSOR"

Level Type

levelValue
required
string

Level Value is ibxCode, zone, cage, sensorid for levelType ibx, zone, cage, sensor resp.

interval
required
string
Enum: "reading" "1h" "1d"

Interval

fromDate
required
string <date-time>

Date in long

toDate
required
string <date-time>

Date in long

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
object
ibx
string

ibx code

accountNo
string

customer account num

interval
string

interval

datapoint
string

data point for which the timeseries data is fetched

uom
string

unit of measure used for the datapoint

Array of objects (DataValue)

Time series data for the data point

Array
value
string

reading value for the datapoint

modifiers
Array of strings

modifiers applicable for the reading value

datetime
string

timestamp since epoch. reading timestamp

Response samples

Content type
application/json
{
  • "payLoad": {
    }
}

Retrieve IBX sensors current readings

Returns current environmental (temperature and humidity) sensor readings for the given IBX code in a paginated way.

Authorizations:
BearerAuth
path Parameters
ibx
required
string
Example: CH2

IBX where the sensor is located.

query Parameters
type
string
Example: type=HUMIDITY

Type of sensor data to display, e.g. specifying 'HUMIDITY' means only sensor readings with HUMIDITY value will be included

zone
string
Example: zone=CH2:1:06:ColoArea:1

Zone name. Adding this parameter limits the query to sensors in the specified zone

offset
integer
Default: 0

Results offset you want to retrieve (0..N)

limit
integer
Default: 20

Number of records to retrieve per request.

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
required
Array of objects (SensorReading)

List of data objects

Array
sensorId
required
string

The sensor identifier.

zoneId
required
string

The zone where the sensor is placed.

ibx
required
string

The ibx identifier where the sensor is placed.

object

Sensor reading - humidity

object

Sensor reading - temperature

required
object (Pagination)

Represents pagination component of the paginated response

offset
required
integer <int64>

The number of elements to skip.

limit
required
integer <int64>

The page size.

total
required
integer <int64>

The total number of elements in the result set.

next
string

Represents a relative link to the next page. This can be empty if there is no next page available.

previous
string

Represents a relative link to the previous page. This can be empty if there is no previous page available.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Retrieve Single sensor current value(s)

Returns current environmental sensor readings such as temperature and humidity for the given sensor ID and IBX code.

Authorizations:
BearerAuth
path Parameters
ibx
required
string
Example: SV2

IBX where the sensor is located.

sensorId
required
string
Example: CH2.Environmental.MbusColo3Mod5.MOD35.C3TS03

Id of sensor to read.

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
sensorId
required
string

The sensor identifier.

zoneId
required
string

The zone where the sensor is placed.

ibx
required
string

The ibx identifier where the sensor is placed.

object

Sensor reading - humidity

value
required
number

Specific value, to be read together with unit.

unit
required
string

Unit for value.

object

Sensor reading - temperature

value
required
number

Specific value, to be read together with unit.

unit
required
string

Unit for value.

Response samples

Content type
application/json
{
  • "sensorId": "SV2.Environmental.Colo4-ZoneHumidity1",
  • "zoneId": "CH2:1:06:ColoArea:1",
  • "ibx": "SV2",
  • "humidity": {
    },
  • "temperature": {
    }
}

Streaming Subscription API

IBX SmartView's subscription API allows users to subscribe to near real-time message feeds for events occurring within an IBX. Users can specify the types of messages to receive for each IBX. Users are able to view all subscriptions within their organization and update any subscription to modify the message feed being received.

Retrieve all subscriptions

This endpoint allows users to fetch details for all streaming subscriptions for a given organization.

Authorizations:
BearerAuth
header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
Array
id
string
status
string
Enum: "PENDING" "ACTIVE" "FAILED" "DELETE_IN_PROGRESS" "DELETED"
object (MessageType)

Message type for a given subscription

Array of objects (Asset)

List of asset message type to subscribe

Array of objects (Environmental)

List of environmental message type to subscribe

Array of objects (PowerMessage)

List of power message type to subscribe

Array of objects (MeteredPower)

List of metered power message type to subscribe

Array of objects (SystemAlert)

List of system alert message type to subscribe

Array of objects (CustomAlert)

List of custom alert message type to subscribe

object (Channel)

Subscription can be created using one channel.

channelType
string
Enum: "AWS_IOT_CORE" "WEBHOOK" "AZURE"
object (AwsIotCoreChannelConfiguration)

The configuration for an 'AWS_IOT_CORE' channel

object (WebhookChannelConfiguration)

The configuration for a 'WEBHOOK' channel

object (AzureChannelConfiguration)

The configuration for an 'AZURE' channel

orgId
string
createdBy
string
createdDateTime
string <date-time>
updatedBy
string
updatedDateTime
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Create subscription endpoint

The endpoint allows users to define and create a new streaming subscription for a given organization.

Authorizations:
BearerAuth
header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Request Body schema: application/json
optional
object (MessageType)

Message type for a given subscription

Array of objects (Asset)

List of asset message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
assetClassification
Array of strings [ 1 .. 2147483647 ] items unique
Items Enum: "MECHANICAL" "ENVIRONMENTAL" "ELECTRICAL"

Asset Classification value if specified, otherwise all allowable classifications

assetId
Array of strings [ 1 .. 2147483647 ] items unique
Array of objects (Environmental)

List of environmental message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
level
Array of strings [ 1 .. 3 ] items unique
Items Enum: "ZONE" "IBX" "CAGE"

This field is not required. If not provided in the request, subscription will include all environmental messages at the IBX, zone, and cage levels. If granularity is specified, at least one level must be provided.

Array of objects (PowerMessage)

List of power message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
Array of objects (MeteredPower)

List of metered power message type to subscribe

Array
streamId
required
string

unique message id

ibx
required
string

ibx

required
object (MeteredPowerAssetDetails)

asset details

cage
string

cage

cageSerialNo
string

cage serial number

accountNumber
string

account number

required
object (MeteredPowerTagDetails)

tag details

required
object (MeteredPowerValueWithUnit)

reading details

readingTime
string

message reading time

dataQuality
string

data quality - Good | Bad | Uncertain

Array of objects (SystemAlert)

List of system alert message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
Array of objects (CustomAlert)

List of custom alert message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
user
string
object (Channel)

Subscription can be created using one channel.

channelType
string
Enum: "AWS_IOT_CORE" "WEBHOOK" "AZURE"
object (AwsIotCoreChannelConfiguration)

The configuration for an 'AWS_IOT_CORE' channel

url
required
string
object (WebhookChannelConfiguration)

The configuration for a 'WEBHOOK' channel

sslCertificate
string
url
required
string
numberOfRetries
integer <int32> [ 1 .. 5 ]
numberOfConcurrentCalls
integer <int32> [ 20 .. 50 ]
batchSize
integer <int32> [ 5 .. 20 ]
object (AzureChannelConfiguration)

The configuration for an 'AZURE' channel

numberOfRetries
integer <int32> [ 1 .. 5 ]
numberOfConcurrentCalls
integer <int32> [ 20 .. 50 ]
batchSize
integer <int32> [ 5 .. 20 ]

Responses

Response Headers
Location
string

Location of created subscription. For Example - /smartview/v2/streaming/subscriptions/607460b4e4a78360425bca56

Request samples

Content type
application/json
{
  • "messageType": {
    },
  • "channel": {}
}

Response samples

Content type
application/json
{
  • "errorCode": "EQ-1912306",
  • "errorMessage": "Wrong customer id",
  • "correlationId": "b1ea22f8-34ae-6f67-4a33-b4f5ec99a1c6",
  • "details": "Wrong value of ph#. Correct format is xxx-xxx-xxxx",
  • "additionalInfo": [
    ]
}

Retrieve subscription by ID

This endpoint allows users to fetch details for a given streaming subscription for a given organization.

Authorizations:
BearerAuth
path Parameters
id
required
string
header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
id
string
status
string
Enum: "PENDING" "ACTIVE" "FAILED" "DELETE_IN_PROGRESS" "DELETED"
object (MessageType)

Message type for a given subscription

Array of objects (Asset)

List of asset message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
assetClassification
Array of strings [ 1 .. 2147483647 ] items unique
Items Enum: "MECHANICAL" "ENVIRONMENTAL" "ELECTRICAL"

Asset Classification value if specified, otherwise all allowable classifications

assetId
Array of strings [ 1 .. 2147483647 ] items unique
Array of objects (Environmental)

List of environmental message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
level
Array of strings [ 1 .. 3 ] items unique
Items Enum: "ZONE" "IBX" "CAGE"

This field is not required. If not provided in the request, subscription will include all environmental messages at the IBX, zone, and cage levels. If granularity is specified, at least one level must be provided.

Array of objects (PowerMessage)

List of power message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
Array of objects (MeteredPower)

List of metered power message type to subscribe

Array
streamId
required
string

unique message id

ibx
required
string

ibx

required
object (MeteredPowerAssetDetails)

asset details

cage
string

cage

cageSerialNo
string

cage serial number

accountNumber
string

account number

required
object (MeteredPowerTagDetails)

tag details

required
object (MeteredPowerValueWithUnit)

reading details

readingTime
string

message reading time

dataQuality
string

data quality - Good | Bad | Uncertain

Array of objects (SystemAlert)

List of system alert message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
Array of objects (CustomAlert)

List of custom alert message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
user
string
object (Channel)

Subscription can be created using one channel.

channelType
string
Enum: "AWS_IOT_CORE" "WEBHOOK" "AZURE"
object (AwsIotCoreChannelConfiguration)

The configuration for an 'AWS_IOT_CORE' channel

url
required
string
object (WebhookChannelConfiguration)

The configuration for a 'WEBHOOK' channel

sslCertificate
string
url
required
string
numberOfRetries
integer <int32> [ 1 .. 5 ]
numberOfConcurrentCalls
integer <int32> [ 20 .. 50 ]
batchSize
integer <int32> [ 5 .. 20 ]
object (AzureChannelConfiguration)

The configuration for an 'AZURE' channel

numberOfRetries
integer <int32> [ 1 .. 5 ]
numberOfConcurrentCalls
integer <int32> [ 20 .. 50 ]
batchSize
integer <int32> [ 5 .. 20 ]
orgId
string
createdBy
string
createdDateTime
string <date-time>
updatedBy
string
updatedDateTime
string <date-time>

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "PENDING",
  • "messageType": {
    },
  • "channel": {},
  • "orgId": "string",
  • "createdBy": "string",
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDateTime": "2019-08-24T14:15:22Z"
}

Update subscription

This endpoint allows users to modify and update an existing streaming subscription for a given organization. Request payload replaces current subscription.

Authorizations:
BearerAuth
path Parameters
id
required
string
header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Request Body schema: application/json
optional
object (MessageType)

Message type for a given subscription

Array of objects (Asset)

List of asset message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
assetClassification
Array of strings [ 1 .. 2147483647 ] items unique
Items Enum: "MECHANICAL" "ENVIRONMENTAL" "ELECTRICAL"

Asset Classification value if specified, otherwise all allowable classifications

assetId
Array of strings [ 1 .. 2147483647 ] items unique
Array of objects (Environmental)

List of environmental message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
level
Array of strings [ 1 .. 3 ] items unique
Items Enum: "ZONE" "IBX" "CAGE"

This field is not required. If not provided in the request, subscription will include all environmental messages at the IBX, zone, and cage levels. If granularity is specified, at least one level must be provided.

Array of objects (PowerMessage)

List of power message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
Array of objects (MeteredPower)

List of metered power message type to subscribe

Array
streamId
required
string

unique message id

ibx
required
string

ibx

required
object (MeteredPowerAssetDetails)

asset details

cage
string

cage

cageSerialNo
string

cage serial number

accountNumber
string

account number

required
object (MeteredPowerTagDetails)

tag details

required
object (MeteredPowerValueWithUnit)

reading details

readingTime
string

message reading time

dataQuality
string

data quality - Good | Bad | Uncertain

Array of objects (SystemAlert)

List of system alert message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
Array of objects (CustomAlert)

List of custom alert message type to subscribe

Array
accountNumber
required
string
ibx
required
Array of strings unique
user
string
object (Channel)

Subscription can be created using one channel.

channelType
string
Enum: "AWS_IOT_CORE" "WEBHOOK" "AZURE"
object (AwsIotCoreChannelConfiguration)

The configuration for an 'AWS_IOT_CORE' channel

url
required
string
object (WebhookChannelConfiguration)

The configuration for a 'WEBHOOK' channel

sslCertificate
string
url
required
string
numberOfRetries
integer <int32> [ 1 .. 5 ]
numberOfConcurrentCalls
integer <int32> [ 20 .. 50 ]
batchSize
integer <int32> [ 5 .. 20 ]
object (AzureChannelConfiguration)

The configuration for an 'AZURE' channel

numberOfRetries
integer <int32> [ 1 .. 5 ]
numberOfConcurrentCalls
integer <int32> [ 20 .. 50 ]
batchSize
integer <int32> [ 5 .. 20 ]

Responses

Request samples

Content type
application/json
{
  • "messageType": {
    },
  • "channel": {}
}

Response samples

Content type
application/json
{
  • "errorCode": "EQ-1912306",
  • "errorMessage": "Wrong customer id",
  • "correlationId": "b1ea22f8-34ae-6f67-4a33-b4f5ec99a1c6",
  • "details": "Wrong value of ph#. Correct format is xxx-xxx-xxxx",
  • "additionalInfo": [
    ]
}

Delete subscription

This endpoint allows users to delete and remove an existing streaming subscription for a given organization.

Authorizations:
BearerAuth
path Parameters
id
required
string
header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Retrieve subscription data via REST

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.

Authorizations:
BearerAuth
path Parameters
subscriptionId
required
string

Subscription ID

query Parameters
ibxs
Array of strings

Filter, set of IBXs

messageTypes
Array of strings
Items Enum: "ALARM" "ALERT" "ENVIRONMENTAL" "METERED_POWER" "POWER" "TAG_POINT"

Filter, set of message types

streamIds
Array of strings

Filter, set of stream IDs

offset
integer <int32>
Default: 0

Pagination, offset of the first item

limit
integer <int32>
Default: 250

Pagination, limit of items returned

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
Array of objects (AlarmMessageData)

alarm message data

Array
type
required
string
Default: "system-alert"

message type

required
object (Alarm)

message data

Array of objects (AlertMessageData)

alert message data

Array
type
required
string
Default: "custom-alert"

message type

required
object (Alert)

message data

Array of objects (EnvironmentMessageData)

environment message data

Array
type
required
string
Default: "environmental"

message type

required
object (Environment)

message data

Array of objects (MeteredPowerMessageData)

metered-power message data

Array
type
required
string
Default: "metered-power"

message type

required
object (MeteredPower)

message data

Array of objects (PowerMessageData)

power message data

Array
type
required
string
Default: "power"

message type

required
object (Power)

message data

Array of objects (TagPointMessageData)

tag-point message data

Array
type
required
string
Default: "tag-point"

message type

required
object (TagPoint)

message data

object (Pagination)

Represents pagination component of the paginated response

offset
required
integer <int64>

The number of elements to skip.

limit
required
integer <int64>

The page size.

total
required
integer <int64>

The total number of elements in the result set.

next
string

Represents a relative link to the next page. This can be empty if there is no next page available.

previous
string

Represents a relative link to the previous page. This can be empty if there is no previous page available.

Response samples

Content type
application/json
{
  • "alarmMessageData": [
    ],
  • "alertMessageData": [
    ],
  • "environmentMessageData": [
    ],
  • "meteredPowerMessageData": [
    ],
  • "powerMessageData": [
    ],
  • "tagPointMessageData": [
    ],
  • "pagination": {
    }
}

SmartView Hierarchy APIs

Empower yourself with Smart View Hierarchy APIs. Use these APIs to obtain location and power hierarchy for invoking other APIs. Given an account number, IBX code, and an asset Id, returns the corresponding location and power hierarchy of related assets. Required query parameters to obtain a valid response from these endpoints are account number and IBX code.

Retrieve the Location Hierarchy

This endpoint returns the location hierarchy and provides data for invoking other APIs such as Environmental APIs that require location hierarchy information.

Authorizations:
BearerAuth
query Parameters
accountNo
required
string

Customer Account Number

ibx
string

IBX Code

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
Array
levelType
string
Enum: "ibx" "zone" "cage" "cabinet" "sensor"

levelType indicates which level in the location hierarchy does the node belong to.

levelValue
string

ibx code, zone us id, cage us id, cabinet us id, sensor number for levelType ibx, zone, cage, cabinet, sensor resp.

label
string

ibx code, zone unique space id, cage unique space id, cabinet unique space id, sensor number for levelType ibx, zone, cage, cabinet, sensor resp.

children
Array of objects (HierarchyNode)

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the Power Hierarchy

This endpoint returns the power hierarchy and provides data for invoking other APIs such as Power APIs that require power hierarchy information.

Authorizations:
BearerAuth
query Parameters
accountNo
required
string

Customer Account Number

ibx
string

IBX Code

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
Array
levelType
string
Enum: "ibx" "cage" "cabinet" "circuit"

levelType indicates which level in the power hierarchy does the node belong to.

levelValue
string

ibx code, cage us id, cabinet us id, circuit number for levelType ibx, cage, cabinet, circuit resp.

label
string

ibx code, cage unique space id, cabinet unique space id, circuit label for levelType ibx, cage, cabinet, circuit resp.

children
Array of objects (PowerHierarchyNode)

ibx, cage, cabinet nodes can have cage, cabinet and circuit, circuit nodes as children respectively.

Response samples

Content type
application/json
[
  • {
    }
]

SmartView Assets APIs

Empower yourself with Smart View Assets API. These provide the ability to consumers to list infra asset, fetch infra asset details, get affected customer assets based on asset id. Given an account number, IBX code, cage and asset classification (Electrical, Mechanical), information about the asset in a hierarchical structure comprising of the category, template and asset is returned. Given a category and a template, a list of assets is returned.

Retrieve assets list information

This endpoint returns information about asset in a hierarchical structure (category / template / asset) based on the input account number, IBX code, cage and asset classification (Electrical, Mechanical).

Authorizations:
BearerAuth
query Parameters
accountNo
required
string

customer account number

ibx
required
string

ibx code

classification
required
string
Enum: "Electrical" "Mechanical"

asset classification (Electrical, Mechanical)

cages
Array of strings

cage unique space id to be used to filter the assets list assumed to be all cage unique space id if no value is sent.

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
object
classification
string

asset classification for the Electrical and Mechanical

Array of objects (Category)
Array
Array of objects (Template)
categoryName
string
object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages possible messages

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

Retrieve details for an asset

This endpoint returns information about asset details including tag points lists for a given asset identifier.

Authorizations:
BearerAuth
query Parameters
accountNo
required
string

customer account number

ibx
required
string

ibx code

classification
required
string

asset classification (Electrical, Mechanical)

assetId
required
string

asset id

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
object
assetId
string

asset id for the Asset

assetType
string

Template Name for the asset

userPrefTimeZone
string

Time zone for the user

Array of objects (TagPointDataArray)

List of tag points for the Asset

Array
value
string

Current data value for the tag point

tagId
string

ID for the tagPoint - Unique Identifier for the Tag Point

tagDisplayName
string

Generic label for the tag point

uom
string

Unit of measure for the data value for the tag point

alarmStatus
string

Generic label for the tag point

readingTime
string

date time when the tag point value was read from the device.

lastMaintenanceDate
string

Datetime when the machine had its last maintenance

manufacturerName
string

Manufacturer name for the Asset

equipmentModelNumber
string

Equipment Model Number

equipmentSerialNumber
string

Equipment Serial Number

alarmLastTriggeredTime
string

Datetime when the latest alarm was triggered on the asset

alarmLastProcessedTime
string

Datetime when the latest alarm was processed on the asset

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

Retrieve asset details

This endpoint returns information about assets details including the assets tag points list for the given multiple asset identifiers.

Authorizations:
BearerAuth
header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Request Body schema: application/json
required

request schema

accountNo
string

customer account number

ibx
string

ibx code

classification
string

asset classification

assetIds
Array of strings

Responses

Response Schema: application/json
object
totalCount
integer

total number of assets that match the request filters

Array of objects (AssetDetails)
Array
assetId
string

asset id for the Asset

assetType
string

Template Name for the asset

userPrefTimeZone
string

Time zone for the user

Array of objects (TagPointDataArray)

List of tag points for the Asset

lastMaintenanceDate
string

Datetime when the machine had its last maintenance

manufacturerName
string

Manufacturer name for the Asset

equipmentModelNumber
string

Equipment Model Number

equipmentSerialNumber
string

Equipment Serial Number

alarmLastTriggeredTime
string

Datetime when the latest alarm was triggered on the asset

alarmLastProcessedTime
string

Datetime when the latest alarm was processed on the asset

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages

Request samples

Content type
application/json
{
  • "accountNo": "string",
  • "ibx": "string",
  • "classification": "string",
  • "assetIds": [
    ]
}

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

Retrieve affected customers assets hierarchy

This endpoint returns information regarding the affected assets of customers for a given asset identifier

Authorizations:
BearerAuth
query Parameters
accountNo
required
string

customer account number

ibx
required
string

ibx code

assetId
required
string

asset id

classification
required
string
Enum: "Electrical" "Mechanical"

asset classification(Electrical, Mechanical)

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
object
Array of objects (Cages)
Array
name
string

Cage Unique Space Id

type
string

type of the asset

Array of objects (Cabinets)
Array of objects (CircuitsMapWithCage)
Array
name
string
Value: "877483"
type
string
Value: "circuit"
object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

Search for Assets matching the identifiers

This endpoint is used to search for assets using wild card search patterns matching the asset identifier.

Authorizations:
BearerAuth
query Parameters
accountNo
required
string

Customer Account Number

ibx
required
string

IBX Code

searchString
required
string

Search String

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
object
totalCount
integer
Array of objects (AssetsArray)
Array
assetId
string

The assetid is the circuit number, sensor id, asset id, asset id for type circuit, sensor, electrical and mechanical resp.

type
string
assetLabel
string

Asset Label is the Circuit display label, Sensor ID, and Asset ID for types circuit, sensor, electrical and mechanical resp.

assetClassification
string

Asset classification is electrical or mechanical

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages possible messages

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

Retrieve latest tag point data

This endpoint fetches and provides the most recent tag point information for a given tag identifier.

Authorizations:
BearerAuth
query Parameters
accountNo
required
string

customer account number

ibx
required
string

ibx code

tagid
required
string

tag id is the unique identifier for the tag point

header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json
Array of objects (TagPointDataArrayCurrent)
Array
value
string

Current data value for the tag point

tagId
string

ID for the tagPoint - Unique Identifier for the Tag Point

tagDisplayName
string

Generic label for the tag point

uom
string

Unit of measure for the data value for the tag point

readingTime
string

date time when the tag point value was read from the device.

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the

Response samples

Content type
application/json
{
  • "payLoad": [
    ],
  • "status": {
    }
}

Retrieve current tag points data

This endpoint fetches the latest read values for given tag points using given tag identifiers.

Authorizations:
BearerAuth
header Parameters
Authorization
required
string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Request Body schema: application/json
required

request schema

accountNo
string

customer account number

tagIds
Array of strings <= 1000 characters
ibx
string

ibx code

Responses

Response Schema: application/json
Array of objects (TagPointDataArrayCurrent)
Array
value
string

Current data value for the tag point

tagId
string

ID for the tagPoint - Unique Identifier for the Tag Point

tagDisplayName
string

Generic label for the tag point

uom
string

Unit of measure for the data value for the tag point

readingTime
string

date time when the tag point value was read from the device.

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the

Request samples

Content type
application/json
{
  • "accountNo": "string",
  • "tagIds": [
    ],
  • "ibx": "string"
}

Response samples

Content type
application/json
{
  • "payLoad": [
    ],
  • "status": {
    }
}

DCIM Power APIs

Empower yourself with DCIM Power APIs. Use them to get current and trending information on power consumption by assets. These APIs return the power consumption info for all level values, given a customer account number, IBX and level type of ibx - cage, cabinet or circuit. Trending power data returns the kVA power draw and max allowed (%) for the given asset.

Retrieve current power consumption data

This powerData endpoint returns power consumption info (power consumption data with comparison data of current [% Kva] vs yesterday, lastWeek, lastMonth, lastQuarter) for input ibx, cage, cabinet, circuit.

Authorizations:
BearerAuth
query Parameters
accountNo
required
string

Customer Account Number

ibx
required
string

IBX Code

levelType
required
string
Enum: "ibx" "cage" "cabinet" "circuit"

level type allowed value [ibx|cage|cabinet|circuit]

levelValue
required
string

level value - ibx code, cage unique space id, cabinet unique space id, serial number for level type ibx, cage, cabinet, circuit respectively.

header Parameters
Authorization
required
string

Specify the OAuth Bearer token with prefix 'Bearer '.

Responses

Response Schema: application/json
object
ibx
string

ibx code

accountNo
string

customer account number

levelType
string
Enum: "ibx" "cage" "cabinet" "circuit"

power hierarchy node levelType linked to the power data

levelValue
string

power hierarchy node levelValue linked to the power data

isAlarm
string

returns boolean based on breakertip alarm

kva
number

power consumption in kva

amps
number

instantaneous current amp reading on circuits

soldKva
number

maximum amp draw allowable on a circuit

cabinetRating
number

maximum kVA draw allowed for the cabinet|cabinet description when the levelType is cabinet. Null otherwise.

contractualKva
number

The maximum power draw contractually allowable in a private cage.

percentageKva
number

calculated field kva / contractualKva

object (ComparisonData)

comparison of readings with the current reading for specified datapoint

datapoint
string
Value: "percentageKva"

datapoint on which the comparison is done.

yesterday
number

comparison for the current value of the datapoint with yesterday's value

lastWeek
number

comparison for the current value of the datapoint with last week's value

lastMonth
number

comparison for the current value of the datapoint with the last month's value

lastQuarter
number

comparison for the current value of the datapoint with the last quarter's value

peakKvaLastSevenDays
number
peakKvaLastSevenDaysPercentage
number
peakKvaLastSevenDaysContractualKva
number
peakKvaLastSevenDaysTime
integer
soldAmps
integer

circuit description when the levelType is circuit. Null otherwise.

primaryKva
number

the sum of instantaneous power draw reading on all the primary circuits within the levelType.

redundantKva
number

the sum of instantaneous power draw reading on all the redundant circuits within the levelType.

kw
string

measure of real power expressed in kilowatt applicable for ibxs that have capability of energy meter reading|value will be "NA" for AMER and APAC regions

powerFactor
string

The ratio between real power and apparent power in a circuit.(kW/kVA)|value will be "NA" for AMER and APAC regions

readingTime
string

date-time when the latest value was read in (epoc - milliseconds).

lastUpdatedTime
string

date-time when the latest value was updated (epoc - milliseconds).

customerName
string
object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

Retrieve current power consumption data

This powerdata endpoint returns power consumption info for all values of input level type ibx, cage, cabinet or circuit.

Authorizations:
BearerAuth
header Parameters
Authorization
required
string

Specify the OAuth Bearer token with prefix 'Bearer '.

Request Body schema: application/json
required

request payload

accountNo
string

Customer Account Number

ibx
string

trending values

levelType
string
Enum: "ibx" "cage" "cabinet" "circuit"

level type allowed value [ibx|cage|cabinet|circuit]

Responses

Response Schema: application/json
object
Array of objects (PowerData_IBX)
Array
ibx
string

ibx code

accountNo
string

customer account number

levelType
string
Enum: "ibx" "cage" "cabinet" "circuit"

power hierarchy node levelType linked to the power data

levelValue
string

power hierarchy node levelValue linked to the power data

isAlarm
string

returns boolean based on breakertip alarm

kva
number

power consumption in kva

amps
number

instantaneous current amp reading on circuits

soldKva
number

maximum amp draw allowable on a circuit

cabinetRating
number

maximum kVA draw allowed for the cabinet

contractualKva
number

The maximum power draw contractually allowable in a private cage. example - 341.54

percentageKva
number

calculated field kva / contractualKva

object (ComparisonData)

comparison of readings with the current reading for specified datapoint

peakKvaLastSevenDays
number
peakKvaLastSevenDaysPercentage
number
peakKvaLastSevenDaysContractualKva
number
peakKvaLastSevenDaysTime
integer
soldAmps
integer

circuit description when the levelType is circuit. Null otherwise.

primaryKva
number

the sum of instantaneous power draw reading on all the primary circuits within the levelType.

redundantKva
number

the sum of instantaneous power draw reading on all the redundant circuits within the levelType.

kw
string

measure of real power expressed in kilowatt applicable for ibxs that have capability of energy meter reading|value will be "NA" for AMER and APAC regions

powerFactor
string

The ratio between real power and apparent power in a circuit.(kW/kVA)|value will be "NA" for AMER and APAC regions

readingTime
string

date-time when the latest value was read in (epoc - milliseconds).

lastUpdatedTime
string

date-time when the latest value was updated (epoc - milliseconds).

customerName
string
object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages

Request samples

Content type
application/json
{
  • "accountNo": "1234",
  • "ibx": "0.147",
  • "levelType": "ibx"
}

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

Retrieve Trending Power Data.

This trending power data for draw kVA to max allowed (%) for input ibx, cage, cabinet, circuit.

Authorizations:
BearerAuth
query Parameters
accountNo
required
string

Customer Account Number

ibx
required
string

IBX Code

levelType
required
string
Enum: "ibx" "cage" "cabinet" "circuit"

[ibx|cage|cabinet|circuit]

levelValue
required
string

ibx code, cage unique space id, cabinet unique space id and serial number for level type ibx, cage, cabinet and circuit respectively.

interval
required
string

[recording|1h|1d]

fromDate
required
string

timestamp expected to be epoch long (milliseconds).

toDate
required
string

timestamp expected to be epoch long (milliseconds).

header Parameters
Authorization
required
string

Specify the OAuth Bearer token with prefix 'Bearer '.

Responses

Response Schema: application/json
object
accountNumber
string
ibx
string
levelType
string
Enum: "ibx" "cage" "cabinet" "circuit"

power hierarchy node levelType linked to the power data

levelValue
string

ibx code, cage unique space id, cabinet unique space id and serial number for levelType ibx, cage, cabinet, circuit resp.

interval
string
Enum: "5m" "15m" "1h" "1d"

serial number

Array of objects (ComparisonData_Trend)
Array
datetime
string

datetime.

value
string

trending values

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|From/ToDate interval cannot be greater than 1 year|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

DCIM System Alert

Empower yourself with IBX SmartView System Alert APIs to access information on the alarms, now \nknown as system alerts. Given a multiple criteria, this API retrieves all the system alerts.\nWe recommend customers utilize the POST call, however both calls are supported and functional.

System alerts search

This endpoint returns all system alerts in a paginated way allows narrowing returned results by submitting additional search filters.

Allowed search filters.

Authorizations:
BearerAuth
query Parameters
limit
required
integer
Example: limit=100

Number of records to retrieve per request.

offset
required
integer

Record Number you want start to retrieve from (0..N)

status
string
Example: status=ACTIVE

Alert status - ACTIVE or INACTIVE

assetClassification
string
Example: assetClassification=Mechanical

The class of assets this asset belongs to - Mechanical/Electrical/Environmental

edgeCollectedOn
string
Example: edgeCollectedOn=2023-11-30T05:08:39.345Z

Returns the alarms after the passed time

Responses

Response Schema: application/json
Array of objects (AlertReadModel)

Array of the alerts.

Array
id
integer <int64>

database ID

alertUid
string

alert unique ID

traceUid
string

alert trace unique ID related to status change

assetTagUid
string

asset tag point unique id

assetTagDisplayName
string

asset tag point display name

status
string
Enum: "ACTIVE" "INACTIVE"

alert status

object (ValueReadModel)
object (AssetReadModel)
object (ConfigurationReadModel)
object (ProcessingTimeReadModel)
object (ProcessingTimeReadModel)
object (Pagination)

Represents pagination component of the paginated response

offset
required
integer <int64>

The number of elements to skip.

limit
required
integer <int64>

The page size.

total
required
integer <int64>

The total number of elements in the result set.

next
string

Represents a relative link to the next page. This can be empty if there is no next page available.

previous
string

Represents a relative link to the previous page. This can be empty if there is no previous page available.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

System alerts search

This endpoint returns all system alerts in a paginated way allows narrowing returned results by submitting additional search filters.

Allowed search filters:

Property Operator Description
/status =, IN Alert status, INACTIVE or ACTIVE
/assetTagUid =, IN Asset tag point unique id, example: PA8A.CB-CRITICAL-DB2:tripped
/assetTagDisplayName =, IN Active tag reading display value, example: ALARM
/configuration/thresholdType =, IN Example: DIGITAL
/configuration/conditionName =, IN Name given to the alarm condition. Example: ALARM
/asset/ibx =, IN Name of the IBX for which data is being requested, example: PA8A
/asset/assetUid =, IN, LIKE Asset unique ID, example: PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM
/activeProcessing/edgeCollectedOn =, >=, <= When tag reading was collected on source, example: 2022-09-23T13:40:53.449276Z
/asset/assetUnderMaintenance =, IN Asset was under maintenance during alert processing, example: false
/asset/assetType =, IN Indicates the template name for the asset, example: Circuit Breaker with Metering
/asset/assetClassification =, IN The class of assets this asset belongs to. Asset classification is electrical or mechanical, example: Electrical

Allowed search request sort options:

  • /status
  • /assetTagUid
  • /assetTagDisplayName
  • /configuration/thresholdType
  • /configuration/conditionName
  • /asset/ibx
  • /asset/assetUid
  • /activeProcessing/edgeCollectedOn
  • /asset/assetUnderMaintenance
  • /asset/assetType
  • /asset/assetClassification
Authorizations:
BearerAuth
Request Body schema: application/json
required
object (SearchFilter)
Array of objects (SearchCondition)

Array of search conditions.

Array
property
required
string

Field name

operator
required
string
Enum: "<=" ">=" "LIKE" "IN" "=" "!="

Condition used to compare the property and the value(s).

values
required
Array of strings [ 1 .. 2147483647 ] items

Array of values to be compared with the field.

Array of objects (SearchCondition)

Array of search conditions.

Array
property
required
string

Field name

operator
required
string
Enum: "<=" ">=" "LIKE" "IN" "=" "!="

Condition used to compare the property and the value(s).

values
required
Array of strings [ 1 .. 2147483647 ] items

Array of values to be compared with the field.

object (SearchPagination)
offset
required
integer <int64> >= 0

Starting index of an item. First item is offset 0. Default value for offset is 0.

limit
required
integer <int32>

The maximum number of items to return starting from the index denotes by the offset item. Default value for limit is 20. Upper limit is 1000

Array of objects (SearchSort)

Array of sorting conditions.

Array
direction
string
Enum: "ASC" "DESC"

Direction of sorting. Default is ASC.

property
required
string

Property used for sorting the data.

Responses

Response Schema: application/json
Array of objects (AlertReadModel)

Array of the alerts.

Array
id
integer <int64>

database ID

alertUid
string

alert unique ID

traceUid
string

alert trace unique ID related to status change

assetTagUid
string

asset tag point unique id

assetTagDisplayName
string

asset tag point display name

status
string
Enum: "ACTIVE" "INACTIVE"

alert status

object (ValueReadModel)
object (AssetReadModel)
object (ConfigurationReadModel)
object (ProcessingTimeReadModel)
object (ProcessingTimeReadModel)
object (Pagination)

Represents pagination component of the paginated response

offset
required
integer <int64>

The number of elements to skip.

limit
required
integer <int64>

The page size.

total
required
integer <int64>

The total number of elements in the result set.

next
string

Represents a relative link to the next page. This can be empty if there is no next page available.

previous
string

Represents a relative link to the previous page. This can be empty if there is no previous page available.

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}