Get Multiple Publishing Jobs

Retrieves all publishing jobs.

Request

Request syntax:

GET /syndication-jobs

Response

The response for a successful request contains the following properties:

Name	Data Type	Description
@id	String	Indicates the relative path to the requested endpoint.
@type	String	Returns Collection.
items	List of dictionaries	Contains a list of publishing jobs.
total_items	Integer	Indicates the total number of publishing jobs.

items List

The items list describes each publishing job via the following properties:

Name	Data Type	Description
content_description	String	Indicates the name of the live channel or live event identified by the content_id parameter.
content_id	String	Identifies a live channel or live event by its system-defined ID.
content_type	String	Indicates whether the content_id parameter identifies a live channel or a live event. Valid values are: _ e: Live Event _ c: Live Channel
description	String	Indicates the name of the publishing target.
id	String	Identifies this publishing job by its system-defined ID.
job_status	String	Indicates a publishing job's status. Valid values are: activeIndicates that one or more publishing schedules that leverage this publishing target are in the active state.	stoppedIndicates that none of the publishing schedules that leverage this publishing target are in the active or error state.	errorIndicates that one or more publishing schedules that leverage this publishing target are in the error state.
platform	String	Identifies a social media or content distribution platform by its name. Valid values are: Facebook	YouTube	Twitch	Periscope	Zixi	Other
region	String	Indicates the publishing job's publishing location by its system-defined ID. Use the Get All Publishing Locations endpoint to retrieve a list of publishing locations and their system-defined IDs.
region_auto_selected	Boolean	Indicates whether the publishing job's publishing location was auto selected.
start	String	Indicates the timestamp, in Unix time (milliseconds), at which the publishing job was started.
stop	String	Indicates the timestamp, in Unix time (milliseconds), for either of the following conditions: _ Active Publishing Schedule: Reports one year from the start time. _ Stopped Publishing Schedule: Reports the timestamp at which the publishing job was stopped.
syndication_target_id	String	Identifies a publishing target by its system-defined ID.
target_protocol	String	Indicates the protocol through which your content will be published. Valid values are: rtmp	rtmps	hls	hls-pull	zixi	srt	rist

Sample Request/Response

The code below (Python 3) shows how to retrieve publishing jobs.

This code imports names from the api_auth module for V4 APIs (see below).

🦉

API Auth for Classic Authentication (V4 APIs)

Open Recipe

import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        self._get_publishing_jobs()

    def _get_publishing_jobs(self):
        url = "{}{}".format(self.host, "/api/v4/syndication-jobs")

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

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

        print(response.json())

PublishingJob().run()

Response:

{
	"@id": "/api/v4/syndication-jobs",
	"@type": "Collection",
	"items": [{
			"@id": "/api/v4/syndication-jobs/23248d5c270340ca86ca7a36e155e794",
			"@type": "SyndicationData",
			"id": "23248d5c270340ca86ca7a36e155e794",
			"start": "",
			"stop": "1630236590416",
			"syndication_target_id": "7caf1c6c67d041ad8210e7e493be781f",
			"status": "stopped",
			"content_id": "gn2df67cbcf24e74bf564816ebecc0fg",
			"content_type": "c",
			"syndication_target_description": "Events",
			"syndication_target_platform": "Facebook",
			"syndication_target_protocol": "rtmp",
			"content_description": "Sales"
		}, {
			"@id": "/api/v4/syndication-jobs/4806d5badf5349f9823f358993611ebc",
			"@type": "SyndicationData",
			"id": "4806d5badf5349f9823f358993611ebc",
			"start": "",
			"stop": "1629717143701",
			"syndication_target_id": "e5464aeab08245eeb28bfed8470731g6",
			"status": "stopped",
			"content_id": "6b2df67cbcf24e74bf564816ebecc44k",
			"content_type": "c",
			"syndication_target_description": "Conferences",
			"syndication_target_platform": "YouTube",
			"syndication_target_protocol": "rtmp",
			"content_description": "Marketing"
		}
	],
	"total_items": 2
}