Get Multiple Schedule Entries

Retrieves either:

• Up to 500 schedule entries associated with a live channel for a specific time period.

  We restrict the number of schedule entries that may be retrieved through this endpoint to 500. If the number of schedule entries in the requested time period exceeds this limit, then we will return the results for a shorter time period. Your script should check whether the requested end time (i.e., &end=End Time) matches the timestamp returned by the end response property. If there is a mismatch, then your script should submit another request with the start time set to the timestamp returned by the end response property and the end time set to the original requested end time.

  Identify gaps within your schedule by including the include_empty=1 query string parameter. This parameter adds a placeholder schedule entry for each gap in your schedule within the requested time period. This occurs regardless of the duration of the gap in the schedule. For example, if you request schedule entries for a 12 hour period and have only scheduled entries for the first 7 hours, then the response will include a 5 hour placeholder schedule entry. Let's assume that there is also a 30 minute gap within the first 7 hours. In that case, the response will include 2 schedule entries whose durations are 30 minutes and 5 hours, respectively.

• Recently updated schedule entries.

Information describing a scheduled entry is retained for 30 days after its end time.

Request

Request syntax (time period):

GET /channels/Live Channel ID/schedules?start=Start Time&end=End Time&include_deleted=1&include_empty=1&slicer_assets=1

Request syntax (recently updated schedule entries):

GET /channels/Live Channel ID/schedules?after=Last Modified Time

Define the following URL segment when submitting one of the above requests:

Define the following optional query string parameters when submitting one of the above requests:

Response

The response for a successful request contains the following properties:

items List

The items list describes each schedule entry through the following properties:

source Dictionary

The source dictionary identifies the playlist from which this schedule entry was created.

@included List

The @included list describes each asset played within a live channel as a result of a Live Slicer through the following properties:

Sample Request/Response

Call the get_multiple_schedule_entries module (Python 3) to retrieve up to 500 entries scheduled within the next two hours. This module imports names from the api_auth module.

import requests, datetime, time
from api_auth import APICredentials, APIParams
channel_id = 'Hak3zjnPLSW5o0j8GMpzRMsa' # Replace with the ID for the desired live channel.

def convert_ts(utc_tstamp):
    """
        Convert a UTC timestamp to ISO 8601 format (YYYY-MM-DDThh:mm:ss.sZ).
        :param utc_tstamp: The UTC timestamp to convert (expected milliseconds)
    """
    iso_format = "%Y-%m-%dT%H:%M:%S.%fZ"
    try:
        _ts = float("{0:.3f}".format(utc_tstamp/1000.0))
        return "{}{}".format(datetime.datetime.utcfromtimestamp(_ts).strftime(iso_format)[:-4], "Z")
    except Exception:
        print ("Invalid timestamp: {}".format(utc_tstamp))
        raise

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

    def run(self):
        self._get_multiple_schedule_entries()

    def _get_multiple_schedule_entries(self):
        start = int(time.time() * 1000.0) # Now
        end = start + (120 * 60 * 1000)  # 120 minutes later
        start = convert_ts(start)
        end = convert_ts(end)
        url = "{}{}{}{}{}{}{}".format(self.host, "/api/v4/channels/", channel_id, "/schedules?start=", start, "&end=", end)

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

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

        print(response.json())

ScheduleEntry().run()

Response:

{
	'@id': '/channels/Hak3zjnPLSW5o0j8GMpzRMsa/schedules?start=2021-02-15T22:58:10.835Z&end=2021-02-16T00:58:10.835Z',
	'@type': 'TimeSeries',
	'start': '2021-02-15T22:58:10.835Z',
	'end': '2021-02-16T00:58:10.835Z',
	'items': [{
			'@id': '/channels/Hak3zjnPLSW5o0j8GMpzRMsa/schedules/2158c7452b7841158972e019a5bd5f12',
			'@type': 'Schedule',
			'created': '2021-02-16T00:57:10.402Z',
			'lastmod': '2021-02-16T00:57:10.402Z',
			'id': '2158c7452b7841158972e019a5bd5f12',
			'owner': 'ab533864a92b46a1a286cdd49b0a9bd3',
			'content_id': 'ae071e89574248c2ab179fe73d436c3e',
			'content_type': 'asset',
			'desc': 'Sports Segment',
			'dur': 2343598,
			'external_id': '',
			'start': '2021-02-16T00:57:10.402Z',
			'end': '2021-02-16T01:36:14.000Z',
			'type': 'Time',
			'ad_breaks': []
		}
	]
}