Get live stream library for organization

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
422 Unprocessable Entity: body has wrong attributes

Examples

 REQUEST
 GET /v1/organizations/15/live?page=1&per_page=50&states[]=finished
 Content-Type: application/json


 RESPONSE
 200
 {
   "summary":{
      "page":1,
      "per_page":50,
      "count":1
   },
   "stream_instances":[
     {
        "id":202,
        "player_id":11,
        "player_uuid":"FDcPaMBEPpKs3A9mjfDAxx",
        "name":"Live Stream 2",
        "status":"processing",
        "recurring":false,
        "air_date":0,
        "start_time":1614820644,
        "vod_created_at":1614575068,
        "created_at":1614575068,
        "updated_at":1614575068
     },
     {
        "id":203,
        "player_id":12,
        "player_uuid":"3gNuotBz2ZPVrSGw2b1yxx",
        "name":"Live Stream 3",
        "status":"unaired",
        "recurring":false,
        "air_date":0,
        "start_time":0,
        "vod_created_at":1615320459,
        "created_at":1615720460,
        "updated_at":1615720460
     },
   ]
}

 REQUEST
 GET /v1/organizations/15/live?page=1&per_page=50&states[]=upcoming,ongoing
 Content-Type: application/json

 RESPONSE
 200
 {
   "summary":{
      "page":1,
      "per_page":50,
      "count":1
   },
   "stream_instances":[
      {
         "id":201,
         "player_id":10,
         "player_uuid":"XQifG3tEE6P3gozEhsCKxx",
         "name":"Live Stream 1",
         "status":"ready",
         "recurring":false,
         "air_date":0,
         "start_time":1613575168,
         "vod_created_at":1613575068,
         "created_at":1613575068,
         "updated_at":1613575068
      }
   ]
 }

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

per_page
optional

The number of items to show per page
Maximum: 200

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.

query
optional

A string used to search for a set a stream instances by name as well as all associated tags

Validations:

  • Must be a String

states
optional

Filter streams to the given states.
Possible values are upcoming, ongoing, finished

Validations:

  • Must be an array of [upcoming, ongoing, finished]

order_by
optional

Only works if ‘per_page’ or ‘page’ parameters are also set.
The attribute to order the list by
Value: Must be one of: created_at, updated_at, air_date, start_time

Validations:

  • Must be one of: created_at, updated_at, air_date, start_time.

direction
optional

Only works if ‘per_page’ or ‘page’ parameters are also set.
When the direction to order the list
Only applies when order_by used
Default: asc
Value: Must be one of: asc, desc

Validations:

  • Must be one of: asc, desc.