API : IPTV: IPTV Device RTT

Introduction

This request will return the Round Trip Time statistics for an IPTV device (currently only STB)

Request

URL	https://api.telecomx.dk/iptv/device/DEVICE_ID/rtt
Method	GET
Access level	VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN.
Param	DEVICE_ID	Id of the IPTV device (24 hex-char string).
Query	date	Date for which to return RTT statistics, Date format is yyyy-mm-dd. Defaults to today if not specified.

Query example

https://api.telecomx.dk/iptv/device/1234567890ABCDEF12345678/rtt
https://api.telecomx.dk/iptv/device/1234567890ABCDEF12345678/rtt?date=2014-07-23

Response

JSON array

Sample
localRTT	Number	RTT between STB and it's default gateway..
localPacketLoss	Number	Packet loss percentage between STB and it's default gateway.
remoteRTT	Number	RTT between STB and streaming server.
remotePacketLoss	Number	Packet loss percentage between STB and streaming server.
tunnelUp	Boolean	True if VPN tunnel is up.
bandwidth	Number	Current bandwidth usage.
freeMemory	Number	Available RAM in percentage
cpuUsage	Number	CPU usage in percentage
uptime	Number	Amount of seconds since last reboot (FlexCare)
wifiLinkSpeed	Number	Wi-Fi link speed (FlexCare)
wifiSignalStrength	Number	Wi-Fi signal strength (FlexCare)
batteryState	Number	Battery percentage of device (FlexCare)
chargingState	Boolean	Whether the device is charging or not (FlexCare)
interactions	Number	Amount of interactions since last heartbeat (FlexCare)
temperatureZones	Number[]	`[tablets only]` The degrees (celsius) of different temperature zones in a tablet.
batteryRate	Number	`[tablets only]` How fast the tablet is charging. Given in battery percentage per minute.

Example

[
  {
     bandwidth: 293
     localPacketLoss: 0
     localRTT: 7.459
     remotePacketLoss: 0
     remoteRTT: 14.282
     tunnelUp: true,
     freeMemory: 51.2,
     cpuUsage: 15.23,
     uptime: 6003,
     wifiLinkSpeed: null,
     wifiSignalStrength: null,
     batteryState: null,
     chargingState: false,
     interactions: 12,
     temperatureZones: [16, 0, 5, 20, 0, 0, 0],
     batteryRate: -0.98
  }
]

Errors

Error code	Message	Description
400	bad_request	SIP phone id not found in request URI
404	not_found	Not found
404	not_found	No RTT data found for the requested date
403	access_denied	Insufficient access level

WIKI

Table of Contents

API : IPTV: IPTV Device RTT

Introduction

Request

Query example

Response

Example

Errors