Get Enhanced Statistics - Multiple Live Streams

Retrieves the latest statistics for all of the live channels or live events defined in the stream_ids request body property.

Request

Request syntax:

POST /monitoring/stream_stats_enhanced

Request body:

Define the desired live channels or live events by passing the following property within a JSON body:

Response

The response for a successful request contains the following properties:

items List

The items list provides statistics for one or more live channels/live events through 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_multiple_live_streams_v4 module (Python 3) to retrieve the latest statistics for three live channels. This module imports names from the api_auth module.

import json
import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        """
        Get the enhanced statistics for multiple live streams.
        """
        self._get_enhanced_stats_multiple_live_streams()

    def _get_enhanced_stats_multiple_live_streams(self):
        url = "{}{}".format(self.host, "/api/v4/monitoring/stream_stats_enhanced")

        stream_ids = ['114n9q6a847ieldd8bb8dbf67afef96b', 'k30y636fa2f143eb95c7a41d96d581c4', 'n2fj4f8knf83nf81347fh12347fhjwse']
        # Replace with the IDs for the desired live channel(s) and live event(s).

        headers = {'Content-Type': 'application/json'}

        response = requests.post(
            url, params=APIParams(APICredentials()).get_params({}), json={"stream_ids": json.dumps(stream_ids)}, headers=headers
        )

        print(response.json())

GetEnhancedStatsMultipleLiveStreams().run()

Response:

{
	'@id': '/api/v4/monitoring/stream_stats_enhanced',
	'@type': 'Collection',
	'items': [{
			"@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"
		}, {
			'@id': '/api/v4/monitoring/stream_stats_enhanced/k30y636fa2f143eb95c7a41d96d581c4',
			'@type': 'StreamStats',
			'id': 'k30y636fa2f143eb95c7a41d96d581c4',
			'stats': {
				'concurrent': {
					'sessions': 4,
					'total_time': 258.048
				},
				'locations': [{
						'location': 'us:ca',
						'sessions': 4,
						'mcs': 0,
						'ad_slate': 0
					}
				],
				'platforms': [{
						'platform': 'windows',
						'sessions': 3,
						'mcs': 0,
						'ad_slate': 0
					}, {
						'platform': 'mac',
						'sessions': 1,
						'mcs': 0,
						'ad_slate': 0
					}
				],
				'domains': [{
						'domain': 'content.uplynk.com',
						'sessions': 4,
						'mcs': 0,
						'ad_slate': 0
					}
				],
				'type': 'channel'
			},
			'ts': 1649801640042,
			'ts_iso': '2022-04-12T22:14:00.042Z'
		}, {
			'@id': '/api/v4/monitoring/stream_stats_enhanced/n2fj4f8knf83nf81347fh12347fhjwse',
			'@type': 'StreamStats',
			'id': 'n2fj4f8knf83nf81347fh12347fhjwse',
			'stats': None,
			'ts': None,
			'ts_iso': None
		}
	],
	'total_items': 3
}