Channel Statistics

GET channels/statistics/meta

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns channel statistics meta data.

Resource URL

http://{host}/api/2.0/channels/statistics/meta/.format

Example Request

GET

http://44.235.52.211/api/2.0/channels/statistics/meta/.json

{
    "EventSeverities": {
        "0": "Clear",
        "1": "Critical",
        "2": "Major",
        "3": "Minor",
        "4": "Warning",
        "5": "Notice",
        "6": "Info",
        "500": "Lost connection to device",
        "501": "No network interface",
        "502": "Not Monitored"
    },
    "SourceTransportModes": {
        "1": "Unknown",
        "2": "MPTS/UDP",
        "3": "MPTS/RTP",
        "4": "SPTS/UDP",
        "5": "SPTS/RTP",
        "6": "HLS",
        "7": "MPEG-DASH",
        "8": "RTMP",
        "9": "SMPTE-2022-6",
        "10": "SMPTE-2110-20",
        "11": "SMPTE-2110-30",
        "12": "SMPTE-2110-40",
        "13": "SMPTE-2110-31",
        "14": "MSS",
        "15": "HLS/CMAF"
    },
    "ChannelSourceMonitorLevels": {
        "1": "Full",
        "5": "Light",
        "10": "Extra Light"
    }
}

GET channels/statistics

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of monitored channels main statistics.

Resource URL

http://{host}/api/2.0/channels/statistics/.format

Example Request

GET

http://44.235.52.211/api/2.0/channels/statistics/.json

[
    {
	        "ChannelStatistics": {
            "id": 60,
            "access_type_id": 2,
            "is_snoozed": 0,
            "monitoring_level": 1,
            "snooze_remark": null,
            "title": "test_Channel1",
            "uuid": "E7B4DAB3-7496-460B-9601-316173C7943B",
            "network_id": 1,
            "total_bit_rate": 0,
            "null_padding_count": null,
            "cc_errors": 0,
            "service_type_id": 1,
            "device_id": 9011,
            "is_record_enabled": 0,
            "is_descrambling_enabled": 0,
            "t2mi_plp": -1,
            "highest_active_event_severity_id": 1,
            "clock": null,
            "source_address": null,
            "secondary_source_address": null,
            "modified": "1619184738566",
            "program_number": 200,
            "ts_id": 1,
            "ip_address": "224.0.1.1",
            "ssm_ip_address": null,
            "port": 1000,
            "ChannelProfile": [
                {
                    "id": 62,
                    "title": "Default",
                    "notification_set_id": 1,
                    "event_rule_set_id": 1,
                    "is_default": 1,
                    "is_scanned": 0,
                    "is_active": 1,
                    "is_forced": 0,
                    "is_scrambled": 0
                }
            ]
        }
    },{
        "ChannelStatistics": {
            "id": 59,
            "access_type_id": 3,
            "is_snoozed": 0,
            "monitoring_level": 1,
            "snooze_remark": null,
            "title": "new_GEvPd339fg",
            "uuid": "B3FF2503-9466-4B8C-9A3D-5D7F33F41486",
            "network_id": 1,
            "total_bit_rate": 0,
            "null_padding_count": null,
            "cc_errors": 0,
            "service_type_id": 1,
            "device_id": 9011,
            "is_record_enabled": 0,
            "is_descrambling_enabled": 0,
            "t2mi_plp": -1,
            "highest_active_event_severity_id": 1,
            "clock": null,
            "source_address": null,
            "secondary_source_address": null,
            "modified": "1619184937380",
            "main_url": "234.22.22.22",
            "bandwidth": null,
            "program_id": null,
            "codec": null,
            "audio": null,
            "resolution": null,
            "stream_url": null,
            "is_scrambled": 0,
            "ChannelProfile": []
        }
    }
]

GET channels/statistics/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a specific channel's statistics.

Resource URL

http://{host}/api/2.0/channels/statistics/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the specific channel.

Example Request

GET

http://44.235.52.211/api/2.0/channels/statistics/60/.json

{
    "ChannelStatistics": {
        "id": 60,
        "monitoring_level": 1,
        "access_type_id": 2,
        "is_snoozed": 0,
        "snooze_remark": null,
        "title": "test_Channel1",
        "uuid": "E7B4DAB3-7496-460B-9601-316173C7943B",
        "network_id": 1,
        "iface": "eth0",
        "total_bit_rate": 0,
        "null_padding_count": null,
        "mux_bitrate_by_pcr": null,
        "mux_bitrate_by_time": 0,
        "cc_errors": 0,
        "service_type_id": 1,
        "device_id": 9011,
        "is_record_enabled": 0,
        "is_descrambling_enabled": 0,
        "t2mi_plp": -1,
        "highest_active_event_severity_id": 1,
        "clock": null,
        "source_address": null,
        "secondary_source_address": null,
        "source_transport_mode_id": 1,
        "modified": "1619185106970",
        "program_number": 200,
        "ts_id": 1,
        "ip_address": "224.0.1.1",
        "ssm_ip_address": null,
        "port": 1000,
        "ChannelProfile": [
            {
                "id": 62,
                "title": "Default",
                "notification_set_id": 1,
                "event_rule_set_id": 1,
                "is_default": 1,
                "is_scanned": 0,
                "is_active": 1,
                "is_forced": 0,
                "is_scrambled": 0
            }
        ],
        "ChannelPidStatistics": []
    }
}

GET channels/statistics/bitrate/{ch_id}/{pid}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a data array of channel pid bitrates, specified by the required {id} parameter.

Resource URL

http://{host}/api/2.0/channels/statistics/bitrate/{ch_id}/{pid}/.format

Parameters

Parameter	Data Type	Description
ch_id (required)	integer	The ID of the channel.
pid (required)	integer	PID number of the audio PID.

Example Request

GET

http://44.235.52.211/api/2.0/channels/statistics/bitrate/1/6000/.json

GET channels/statistics/loudness/{ch_id}/{pid}/current

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns current immediate statistics of channel PID loudness data as defined by EBU R128.

Resource URL

http://{host}/api/2.0/channels/statistics/loudness/{ch_id}/{pid}/current/.format

Parameters

Parameter	Data Type	Description
ch_id (required)	integer	The ID of the channel.
pid (required)	integer	PID number of the audio PID.

Example Request

GET

http://44.235.52.211/api/2.0/channels/statistics/loudness/1/6000/current/.json

GET channels/statistics/loudness/{ch_id}/{pid}/hourly/from:{start_time}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns hourly statistics of channel PID loudness data as defined by EBU R128. Each entry represents one hour, starting from timestamp specified in start_time parameter.

Resource URL

http://{host}/api/2.0/channels/statistics/loudness/{ch_id}/{pid}/hourly/from:{start_time}/.format

Parameters

Parameter	Data Type	Description
ch_id (required)	integer	The ID of the channel.
pid (required)	integer	PID number of the audio PID.
start_time (required)	timestamp	Specifies the starting timestamp from where to start the data list. The value "0" will give data from last reboot.

Example Request

GET

http://44.235.52.211/api/2.0/channels/statistics/loudness/1/6000/hourly/from:0/.json

GET channels/statistics/loudness/{ch_id}/{pid}/daily/from:{start_time}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns daily statistics of channel PID loudness data as defined by EBU R128.

Resource URL

http://{host}/api/2.0/channels/statistics/loudness/{ch_id}/{pid}/daily/from:{start_time}/.format

Parameters

Parameter	Data Type	Description
ch_id (required)	integer	The ID of the channel.
pid (required)	integer	PID number of the audio PID.
start_time (required)	timestamp	Specifies the starting timestamp of the desired day. The value "0" will give data from last reboot.

Example Request

GET

http://62.90.243.12:443/api/2.0/channels/statistics/loudness/16/257/daily/from:0/.json

GET channels/statistics/videoBlocking/{ch_id}/{pid}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns channel's video blocking statistics.

Resource URL

http://{host}/api/2.0/channels/statistics/videoBlocking/{ch_id}/{pid}/.format

Parameters

Parameter	Data Type	Description
ch_id (required)	integer	The ID of the channel.
pid (required)	integer	PID number of the video PID.

Example Request

GET

http://62.90.243.12:443/api/2.0/channels/statistics/videoBlocking/16/256/.json

GET channels/statistics/quantizers/{ch_id}/{pid}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns channel's average, minimum and maximum quantizers data.

Resource URL

http://{host}/api/2.0/channels/statistics/quantizers/{ch_id}/{pid}/.format

Parameters

Parameter	Data Type	Description
ch_id (required)	integer	The ID of the channel.
pid (required)	integer	PID number of the video PID.

Example Request

GET

http://62.90.243.12:443/api/2.0/channels/statistics/quantizers/16/256/.json

GET channels/statistics/audio_pids_statistics

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of channels audio statistics. For each channel, the statistics includes bitrate and loudness information, codec type, language and cc_errors count.

Resource URL

http://{host}/api/2.0/channels/statistics/audio_pids_statistics/.format

Example Request

GET

http://44.235.52.211/api/2.0/channels/statistics/audio_pids_statistics/.json