/api2/liveevents2/list
Returns a list of LiveEvent2 objects determined by the search criteria.
| Request Parameter | Type | Description |
|---|---|---|
| limit | integer | Cap the number of items returned, maximum of 100 items. |
| skip | integer | Skip the first N results. The skip and limit parameters can be used together for paginated results. |
| start | integer | The beginning of a time range to search in UTC milliseconds since the epoch. The system will search for events that are scheduled to begin during the specified time range based on the event's expected_start field. |
| stop | integer | (optional*) Only valid if start is also included. Marks the end of a time range to search in UTC milliseconds since the epoch. If start is included but stop is omitted, it will default to start + 8 hours. |
| order | string | Sort the results by the given field. Supported fields include: desc, created, lastmod, expected_start, external_id, and operator. Prefix the sort field with a minus sign for descending order (e.g. order='-desc' to retrieve values in reverse alphabetical order) |
| fields | string | Comma-separated list of fields to return in the event object in the events array. |
stop is only valid if start is also included.
Sample request/response:
The Call() function, which is imported from uplynk_api2_auth module, prepares the message body and digital signature.
from uplynk_api2_auth import Call
# Find all events that are scheduled to start on 4 May 2013 ordered by their expected_start time
print(Call('/api2/liveevents2/list', start=1367625600000, stop=1367711999000, order='expected_start', fields='id,expected_start,require_drm,desc'))
{
"events": [
{
"id": "0ba5fb90b3144c06be19645b9efa07eb",
"expected_start": 1462356000000,
"require_drm": true,
"require_studio_drm": true,
"desc": "Concert of the Year"
},
{
"id": "e0139ec1bd11468f91f0645f07bf875a",
"expected_start": 1462379400000,
"require_drm": false,
"require_studio_drm": false,
"desc": "Concert Afterparty"
}
],
"error": 0
}