API : IPTV : Device : Log : Dashboard : Noisy Devices

Introduction

This request will return the top 10 devices that produced the most logged events in the selected period, ordered by event count (most events first). Each entry carries the device's identity (name, hardware id and model), the owning customer, the event total for the period and its share of all events. The result may optionally be scoped to a single customer and/or a single device type. Devices that have since been deleted are kept in the result and reported as “Unknown device”, so high-volume deleted devices remain visible.

Request

URL	https://api.telecomx.dk/iptv/device/log/dashboard/noisydevices
Method	GET
Access level	RESELLER_ADMIN with employee feature TV ADMIN
Query	from	`[required]` Start of the period. Normalized to the start of the day (00:00:00.000) in server local time.
	to	`[required]` End of the period. Normalized to the end of the day (23:59:59.999) in server local time. Must be on or after `from`.
	customerId	`[optional]` Limit the result to a single customer (id of the customer).
	type	`[optional]` Limit the result to a single device type. One of: STB, IOS, ANDROID, ANDROIDTV, APPLETV, WEB.

Query example

https://api.telecomx.dk/iptv/device/log/dashboard/noisydevices?from=2020-01-01T00:00:00.000Z&to=2020-01-07T23:59:59.999Z&customerId=12345678901234567890ABCD&type=STB

Response

A JSON array of up to 10 devices, ordered by event count (most events first).

Array item
[]._id	String	Internal id of the device (the id used by the device log endpoint).
[].name	String	Device name. “Unknown device” if the device no longer exists.
[].deviceId	String	The device's hardware device id. Empty if the device no longer exists.
[].model	String	Device model. Empty if not available.
[].type	String	Device type (STB, IOS, ANDROID, ANDROIDTV, APPLETV or WEB).
[].customerId	String	Id of the customer the device belongs to.
[].customerName	String	Name of the customer. Empty if not available.
[].isFlexCare	Boolean	True if the customer has the FlexCare feature.
[].total	Number	Number of logged events for this device in the period.
[].totalPercentage	Number	The device's share of all logged events in the period, as a percentage rounded to two decimals.

Note that properties holding no value may be omitted from the object.

Example

[
  {
    "_id": "12345678901234567890ABCD",
    "name": "Living room STB",
    "deviceId": "00:1A:2B:3C:4D:5E",
    "model": "AmiNet130",
    "type": "STB",
    "customerId": "098765432109876543210FED",
    "customerName": "John Doe",
    "isFlexCare": true,
    "total": 842,
    "totalPercentage": 35.69
  },
  {
     ...
  }
]

Errors

Error code	Message	Description
422	invalid_data	Invalid or missing query parameter (e.g. bad date, or `from` after `to`)
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents