Table of Contents

API : IPTV : Device : Log : Dashboard : Base info

Introduction

This request will return the general (summary) statistics for the IPTV device log dashboard. It reports, for the selected period, the total number of logged events, how many devices produced events, and the average number of events per device. The result may optionally be scoped to a single customer and/or a single device type.

Request

URL https://api.telecomx.dk/iptv/device/log/dashboard/baseinfo
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/baseinfo?from=2020-01-01T00:00:00.000Z&to=2020-01-07T23:59:59.999Z&customerId=12345678901234567890ABCD&type=STB

Response

JSON object
totalLogs Number Total number of logged events in the period.
devicesWithLogs Number Number of distinct devices that produced at least one event in the period.
deviceAvgLogs Number Average number of events per device (totalLogs / devicesWithLogs), rounded to two decimals. 0 when no devices have events.

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

Example

{
  "totalLogs": 2359,
  "devicesWithLogs": 142,
  "deviceAvgLogs": 16.61
}

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>