Get Enhanced Statistics - Single Live Stream

Retrieves the latest enhanced statistics for a live channel or live event provided that it has viewership. Identify a live channel or live event by its system-defined ID.

Where can I find a live channel ID?

1. From the CMS, click the Live Channels tab.
2. Select the desired live channel.
   Basic options and live channel information will be displayed on the Details tab.
3. Find the live channel's system-defined ID under the GUID label.

Where can I find a live event ID?

1. Navigate to the Live Events page. How? From the main menu, navigate to Events | Live Events.
2. Select the desired live event.
3. Verify that the Details tab is selected.
4. Find the live event's system-defined ID under the GUID label.

Request

Request syntax:

GET /monitoring/stream_stats_enhanced/Live Channel or Live Event ID

Response

The response for a successful request contains the following properties:

stats Dictionary

The stats dictionary provides statistics for one or more live channels/live events through the following properties:

concurrent Dictionary

The concurrent dictionary provides statistics for playback sessions with a duration of at least 1 minute through the following properties:

Statistics are measured over the minute prior to the time identified by the ts_iso property.

domains Dictionary

The domains dictionary provides statistics for each domain through which your live stream was requested for playback sessions with a duration of at least 1 minute:

locations Dictionary

The locations dictionary provides statistics for each location from which your live stream was requested for playback sessions with a duration of at least 1 minute:

new Dictionary

The new dictionary provides statistics for playback sessions whose duration is less than 1 minute through the following properties:

platforms Dictionary

The platforms dictionary provides statistics for each platform from which your live stream was requested for playback sessions with a duration of at least 1 minute:

Statistics are measured over the minute prior to the time identified by the ts_iso property.

Sample Request/Response

Call the get_enhanced_stats_single_live_stream_v4 module (Python 3) to retrieve the latest statistics for a live channel whose system-defined ID is "114n9q6a847ieldd8bb8dbf67afef96b." This module imports names from the api_auth module.

import json
import requests
from api_auth import APICredentials, APIParams

class GetEnhancedStatsSingleLiveStream:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        """
        Get enhanced statistics for a single live stream.
        """
        self._get_enhanced_stats_single_live_stream()

    def _get_enhanced_stats_single_live_stream(self):
        stream_id = '114n9q6a847ieldd8bb8dbf67afef96b' # Replace with a live event or live channel ID.
        url = "{}{}{}".format(self.host, "/api/v4/monitoring/stream_stats_enhanced/", stream_id)

        response = requests.get(
            url, params=APIParams(APICredentials()).get_params({})
        )

        print(response.json())

GetEnhancedStatsSingleLiveStream().run()

Response:

{
	"@id": "/api/v4/monitoring/stream_stats_enhanced/114n9q6a847ieldd8bb8dbf67afef96b",
	"@type": "StreamStats",
	"id": "114n9q6a847ieldd8bb8dbf67afef96b",
	"stats": {
		"concurrent": {
			"sessions": 8193,
			"total_time": 494023.5793121638,
			"mcs": {
				"1": {
					"time": 60.416000000000004,
					"sessions": 1
				}
			}
		},
		"locations": [{
				'location': 'us:ca',
				'sessions': 4215,
				'mcs': 0,
				'ad_slate': 0
			}, {
				"location": "us:ny",
				"sessions": 3978,
				"mcs": 1,
				"ad_slate": 0
			}
		],
		"platforms": [{
				"platform": "mac",
				"sessions": 701,
				"mcs": 1,
				"ad_slate": 0
			}, {
				'platform': 'windows',
				'sessions': 7492,
				'mcs': 0,
				'ad_slate': 0
			}
		],
		"domains": [{
				"domain": "content.uplynk.com",
				"sessions": 8193,
				"mcs": 1,
				"ad_slate": 0
			}
		],
		"type": "channel"
	},
	"ts": 1649318700773,
	"ts_iso": "2022-04-07T08:05:00.773Z"
}