v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Get Program by Custom ID

get/program-by-custom-id/{client_id}/{custom_id}

Path parameters

client_idstring required

Client ID of the application the program belongs to

custom_idstring required

Custom ID of the program to look up

Response

200

urlstring

widgets_urlstring

timeline_urlstring

leaderboard_urlstring

rank_urlstring

client_idstring

application_urlstring

idstring

custom_idstring

titlestring

created_atstring

scheduled_atstring

{"stackTrail":"paths:/program-by-custom-id/{client_id}/{custom_id}:get:responses:200:content:application/json:schema:properties:started_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/program-by-custom-id/{client_id}/{custom_id}:get:responses:200:content:application/json:schema:properties:stopped_at","oasType":"schema","type":"unknown"}

queue_order_urlstring

delete_widgets_urlstring

widgets_enabledboolean

chat_enabledboolean

subscribe_channelstring

widget_countinteger

{"stackTrail":"paths:/program-by-custom-id/{client_id}/{custom_id}:get:responses:200:content:application/json:schema:properties:sendbird_channel","oasType":"schema","type":"unknown"}

stream_urlstring

statusstring

sync_sessions_urlstring

{"stackTrail":"paths:/program-by-custom-id/{client_id}/{custom_id}:get:responses:200:content:application/json:schema:properties:sync_channel","oasType":"schema","type":"unknown"}

start_program_urlstring

stop_program_urlstring

active_sessions_statistics_urlstring

statistics_channelstring

current_active_session_countinteger

sticker_packs_urlstring

reaction_packs_urlstring

widget_reaction_packs_urlstring

update_sticker_packs_urlstring

rewards_typestring

report_urlstring

ban_urlstring

moderation_urlstring

banned_chat_users_urlstring

oembed_urlstring

sponsors_urlstring

widget_interactions_url_templatestring

unclaimed_widget_interactions_url_templatestring

pubnub_enabledboolean

{"stackTrail":"paths:/program-by-custom-id/{client_id}/{custom_id}:get:responses:200:content:application/json:schema:properties:custom_data","oasType":"schema","type":"unknown"}

Example response

{
  "url": "https://cf-blast.livelikecdn.com/api/v1/programs/a49b1d25-5c73-4b92-8dd5-57fed8586a6e/",
  "widgets_url": "https://cf-blast.livelikecdn.com/api/v1/programs/a49b1d25-5c73-4b92-8dd5-57fed8586a6e/widgets/",
  "timeline_url": "https://cf-blast.livelikecdn.com/api/v1/programs/a49b1d25-5c73-4b92-8dd5-57fed8586a6e/widgets/?ordering=recent&status=published&page=1",
  "leaderboard_url": "https://blast-prod-us-east-1.livelikeblast.com/services/_forbidden",
  "rank_url": "https://blast-prod-us-east-1.livelikeblast.com/services/_forbidden",
  "client_id": "mOBYul18quffrBDuq2IACKtVuLbUzXIPye5S3bq5",
  "application_url": "https://cf-blast.livelikecdn.com/api/v1/applications/mOBYul18quffrBDuq2IACKtVuLbUzXIPye5S3bq5/",
  "id": "a49b1d25-5c73-4b92-8dd5-57fed8586a6e",
  "custom_id": "match_uuid",
  "title": "Ind Vs Aus",
  "created_at": "2024-09-13T06:20:02.186138Z",
  "scheduled_at": "2024-09-13T06:20:01.011000Z",
  "queue_order_url": "https://cf-blast.livelikecdn.com/api/v1/programs/a49b1d25-5c73-4b92-8dd5-57fed8586a6e/queue-order/",
  "delete_widgets_url": "https://cf-blast.livelikecdn.com/api/v1/programs/a49b1d25-5c73-4b92-8dd5-57fed8586a6e/delete-widgets/",
  "widgets_enabled": true,
  "chat_enabled": true,
  "subscribe_channel": "program.a49b1d25-5c73-4b92-8dd5-57fed8586a6e",
  "status": "past",
  "sync_sessions_url": "https://blast-prod-us-east-1.livelikeblast.com/services/_empty-page",
  "start_program_url": "https://cf-blast.livelikecdn.com/api/v1/programs/a49b1d25-5c73-4b92-8dd5-57fed8586a6e/start/",
  "stop_program_url": "https://cf-blast.livelikecdn.com/api/v1/programs/a49b1d25-5c73-4b92-8dd5-57fed8586a6e/stop/",
  "active_sessions_statistics_url": "https://cf-blast.livelikecdn.com/api/v1/programs/a49b1d25-5c73-4b92-8dd5-57fed8586a6e/statistics/active-sessions/",
  "statistics_channel": "program.statistics.a49b1d25-5c73-4b92-8dd5-57fed8586a6e",
  "sticker_packs_url": "https://cf-blast.livelikecdn.com/api/v1/sticker-packs/?program_id=a49b1d25-5c73-4b92-8dd5-57fed8586a6e",
  "reaction_packs_url": "https://cf-blast.livelikecdn.com/api/v1/reaction-packs/?program_id=a49b1d25-5c73-4b92-8dd5-57fed8586a6e",
  "widget_reaction_packs_url": "https://cf-blast.livelikecdn.com/api/v1/widget-reaction-packs/?program_id=a49b1d25-5c73-4b92-8dd5-57fed8586a6e",
  "update_sticker_packs_url": "https://cf-blast.livelikecdn.com/api/v1/programs/a49b1d25-5c73-4b92-8dd5-57fed8586a6e/sticker-packs/",
  "analytics_properties": {
    "Program ID": "a49b1d25-5c73-4b92-8dd5-57fed8586a6e",
    "Program Title": "Ind Vs Aus",
    "Custom Program ID": "match_uuid"
  },
  "rewards_type": "none",
  "report_url": "https://blast-prod-us-east-1.livelikeblast.com/services/_forbidden",
  "ban_url": "https://blast-prod-us-east-1.livelikeblast.com/services/_forbidden",
  "moderation_url": "https://blast-prod-us-east-1.livelikeblast.com/services/_forbidden",
  "banned_chat_users_url": "https://blast-prod-us-east-1.livelikeblast.com/services/_forbidden",
  "oembed_url": "https://cf-blast.livelikecdn.com/api/v1/oembed-meta/",
  "chat_rooms": [
    {
      "id": "11684ff0-4924-460c-8dca-e59a6c66ea43",
      "url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/",
      "client_id": "mOBYul18quffrBDuq2IACKtVuLbUzXIPye5S3bq5",
      "title": "Ind Vs Aus",
      "created_at": "2024-09-13T06:20:02.332415Z",
      "content_filter": "none",
      "visibility": "everyone",
      "channels": {
        "chat": {
          "pubnub": "chatroom.11684ff0-4924-460c-8dca-e59a6c66ea43"
        },
        "reactions": {
          "pubnub": "chatroom.reactions.11684ff0-4924-460c-8dca-e59a6c66ea43"
        },
        "control": {
          "pubnub": "chatroom.control.11684ff0-4924-460c-8dca-e59a6c66ea43"
        }
      },
      "report_message_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/report-chat-message/",
      "reported_messages_url": "https://cf-blast.livelikecdn.com/api/v1/reported-chat-room-messages/?chat_room_id=11684ff0-4924-460c-8dca-e59a6c66ea43&status=pending",
      "delete_message_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/delete-chat-message/",
      "upload_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/upload/",
      "memberships_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/memberships/",
      "muted_status_url_template": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/muted-status/{profile_id}/",
      "custom_messages_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/custom-messages/",
      "sticker_packs_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/sticker-packs/",
      "reaction_packs_url": "https://cf-blast-storage.livelikecdn.com/reaction-packs/11684ff0-4924-460c-8dca-e59a6c66ea43/reaction_packs.json",
      "sponsors_url": "https://cf-blast-storage.livelikecdn.com/sponsors/11684ff0-4924-460c-8dca-e59a6c66ea43/sponsors.json",
      "chatroom_messages_url": "https://cf-blast.livelikecdn.com/api/v1/chatroom-messages/",
      "chatroom_messages_count_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/chatroom_messages_count/",
      "pubnub_messages_reaction_url_template": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/pubnub-messages/{message_timetoken}/reactions/",
      "pubnub_messages_remove_reaction_url_template": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/pubnub-messages/{message_timetoken}/reactions/{action_timetoken}/",
      "chatroom_access_rule_url": "https://cf-blast.livelikecdn.com/api/v1/chat-room-access-rules/",
      "reported_chat_messages_url": "https://cf-blast.livelikecdn.com/api/v1/reported-chat-messages/",
      "reaction_space_id": "81a2dde4-e62a-4cf8-a09a-a8d7fa384c05"
    }
  ],
  "default_chat_room": {
    "id": "11684ff0-4924-460c-8dca-e59a6c66ea43",
    "url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/",
    "client_id": "mOBYul18quffrBDuq2IACKtVuLbUzXIPye5S3bq5",
    "title": "Ind Vs Aus",
    "created_at": "2024-09-13T06:20:02.332415Z",
    "content_filter": "none",
    "visibility": "everyone",
    "channels": {
      "chat": {
        "pubnub": "chatroom.11684ff0-4924-460c-8dca-e59a6c66ea43"
      },
      "reactions": {
        "pubnub": "chatroom.reactions.11684ff0-4924-460c-8dca-e59a6c66ea43"
      },
      "control": {
        "pubnub": "chatroom.control.11684ff0-4924-460c-8dca-e59a6c66ea43"
      }
    },
    "report_message_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/report-chat-message/",
    "reported_messages_url": "https://cf-blast.livelikecdn.com/api/v1/reported-chat-room-messages/?chat_room_id=11684ff0-4924-460c-8dca-e59a6c66ea43&status=pending",
    "delete_message_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/delete-chat-message/",
    "upload_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/upload/",
    "memberships_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/memberships/",
    "muted_status_url_template": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/muted-status/{profile_id}/",
    "custom_messages_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/custom-messages/",
    "sticker_packs_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/sticker-packs/",
    "reaction_packs_url": "https://cf-blast-storage.livelikecdn.com/reaction-packs/11684ff0-4924-460c-8dca-e59a6c66ea43/reaction_packs.json",
    "sponsors_url": "https://cf-blast-storage.livelikecdn.com/sponsors/11684ff0-4924-460c-8dca-e59a6c66ea43/sponsors.json",
    "chatroom_messages_url": "https://cf-blast.livelikecdn.com/api/v1/chatroom-messages/",
    "chatroom_messages_count_url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/chatroom_messages_count/",
    "pubnub_messages_reaction_url_template": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/pubnub-messages/{message_timetoken}/reactions/",
    "pubnub_messages_remove_reaction_url_template": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/11684ff0-4924-460c-8dca-e59a6c66ea43/pubnub-messages/{message_timetoken}/reactions/{action_timetoken}/",
    "chatroom_access_rule_url": "https://cf-blast.livelikecdn.com/api/v1/chat-room-access-rules/",
    "reported_chat_messages_url": "https://cf-blast.livelikecdn.com/api/v1/reported-chat-messages/",
    "reaction_space_id": "81a2dde4-e62a-4cf8-a09a-a8d7fa384c05"
  },
  "sponsors_url": "https://cf-blast-storage.livelikecdn.com/sponsors/a49b1d25-5c73-4b92-8dd5-57fed8586a6e/sponsors.json",
  "widget_interactions_url_template": "https://cf-blast.livelikecdn.com/api/v1/profiles/{profile_id}/widget-interactions/",
  "unclaimed_widget_interactions_url_template": "https://cf-blast.livelikecdn.com/api/v1/profiles/{profile_id}/unclaimed-widget-interactions/"
}