List Programs

List all programs for an app

get/

Request

Base URL
https://cf-blast.livelikecdn.com/api/v1/programs
URL
https://cf-blast.livelikecdn.com/api/v1/programs/
Auth
none required

Query parameters

client_idstring required

The unique identifier of the application

titlestring

Filters the program if title contains this value

sincestring

Filters program since scheduled_at ISO datetime.

untilstring

Filters program until scheduled_at ISO datetime.

activestring

Returns active/inactive programs based on active values(true/false)

status'future' | 'live' | 'past'

future: Returns programs, which have scheduled_at > current_time. past: Returns programs, which have scheduled_at < current_time, live: Returns programs, which are not yet stopped.

attributesstring

Filters program on the basis of their attributes, ?attributes=key:value

orderingstring

scheduled_at, started_at, stopped_at, created_at. For descending order use "-" eg. -scheduled_at.

Response

200

countinteger

nextunknown

previousunknown

Example response

{
  "count": 1,
  "results": [
    {
      "url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/",
      "widgets_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/widgets/",
      "leaderboard_url": "https://cf-blast.livelikecdn.com/api/v1/leaders/?client_id=pilot&program_id=f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
      "rank_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/rank/",
      "client_id": "pilot",
      "application_url": "https://cf-blast.livelikecdn.com/api/v1/applications/pilot/",
      "id": "f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
      "title": "HCI Usability Test",
      "created_at": "2019-02-12T12:27:22.323196Z",
      "scheduled_at": "2019-04-10T22:13:00Z",
      "started_at": "2019-04-08T18:31:43Z",
      "queue_order_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/queue-order/",
      "delete_widgets_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/delete-widgets/",
      "widgets_enabled": true,
      "chat_enabled": true,
      "subscribe_channel": "program_f1938a34_2611_4cff_9043_ad6b3dd2f6fd",
      "widget_count": 220,
      "sendbird_channel": "program_f1938a34_2611_4cff_9043_ad6b3dd2f6fd",
      "stream_url": "https://cf-streams.livelikecdn.com/live/colorbars-angle1/index.m3u8",
      "status": "live",
      "sync_sessions_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/sync-sessions/",
      "start_program_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/start/",
      "stop_program_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/stop/",
      "active_sessions_statistics_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/statistics/active-sessions/",
      "statistics_channel": "statistics_f1938a34_2611_4cff_9043_ad6b3dd2f6fd",
      "sticker_packs_url": "https://cf-blast.livelikecdn.com/api/v1/sticker-packs/?program_id=f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
      "reaction_packs_url": "https://cf-blast.livelikecdn.com/api/v1/reaction-packs/?program_id=f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
      "update_sticker_packs_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/sticker-packs/",
      "analytics_properties": {
        "Program ID": "f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
        "Program Title": "HCI Usability Test"
      },
      "rewards_type": "badges",
      "report_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/report/",
      "ban_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/ban/",
      "moderation_url": "https://cf-blast.livelikecdn.com/api/v1/reported-chat-messages/?program_id=f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
      "banned_chat_users_url": "https://cf-blast.livelikecdn.com/api/v1/banned-chat-users/?program_id=f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
      "oembed_url": "https://cf-blast.livelikecdn.com/api/v1/oembed-meta/",
      "chat_rooms": [
        {
          "id": "4e45cc19-0c8d-4f7d-9bdb-842da03c0d21",
          "url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/4e45cc19-0c8d-4f7d-9bdb-842da03c0d21/",
          "client_id": "pilot",
          "created_at": "2019-11-21T20:12:02.730797Z",
          "channels": {
            "chat": {
              "sendbird": "chat_4e45cc19_0c8d_4f7d_9bdb_842da03c0d21",
              "pubnub": "chat_4e45cc19_0c8d_4f7d_9bdb_842da03c0d21"
            },
            "reactions": {
              "pubnub": "reactions_4e45cc19_0c8d_4f7d_9bdb_842da03c0d21"
            }
          }
        }
      ],
      "default_chat_room": {
        "id": "4e45cc19-0c8d-4f7d-9bdb-842da03c0d21",
        "url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/4e45cc19-0c8d-4f7d-9bdb-842da03c0d21/",
        "client_id": "pilot",
        "created_at": "2019-11-21T20:12:02.730797Z",
        "channels": {
          "chat": {
            "sendbird": "chat_4e45cc19_0c8d_4f7d_9bdb_842da03c0d21",
            "pubnub": "chat_4e45cc19_0c8d_4f7d_9bdb_842da03c0d21"
          },
          "reactions": {
            "pubnub": "reactions_4e45cc19_0c8d_4f7d_9bdb_842da03c0d21"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.