GET Broadcasts by Title

Retrieve live streams that satisfy specified search criteria.

Request

Method

GET

URI

sdkSharedMediaBaseUrl/v1/broadcasts/titles/title Query Parameters

Filter Query. Restricts the response to shared media that matches the filter query. The request can contain zero or more fq parameters. In addition to the standard fq fields, this request supports the following:

FieldDescription
broadcastDate Broadcast published date in milliseconds.
channelId Channel ID of the broadcast.

For example:

fq=serviceType:TWITCH&fq=broadcastDate:[NOW-7DAYS TO NOW]

You can use the q query parameters available for all requests. For more information, see Query Parameter Details

You can use the sort query parameters available for all requests. For more information, see Query Parameter Details

Field list. Comma-separated list of properties to be returned in the response. In addition to the standard fl fields, this request supports the following:

FieldDescription
broadcastDate Broadcast published date in milliseconds.
channelId Channel ID of the broadcast.
TitleMetadata Game defined metadata string.
TitleSessionId Game defined session ID string.
UserDeviceStatus Camera/Microphone enabled or disabled.

fl=broadcastDate,channelId,countOfViewers,description,TitleId,
TitleName,UserAccountId,serviceType,title

Limits the response to the number of rows specified. The maximum allowed value is 20. For example:

limit=10

Specifies a row in the query results from which the response should start. For example:

offset=11

Limits the response to game titles associated with the service label requested for shared media service. For example:

servicelabel=10

If omitted or the servicelabel does not exist, the search parameter defaults to zero (0).

Request Body

None

Response

The response provides a 200 OK status code and a response body containing an array of ugcDocument objects. Error The API responds with an HTTP status code and an error object. See Status and Error Codes for more information.

Example

Request

GET sdkSharedMediaBaseUrl/v1/broadcasts/titles/title?q=title:*Island*

Response

{
   "ugcDocument": [
    {
      "title": "Happy Cat Island",
      "description": "HI welcome my channel. ",
      "broadcastDate": 1455914657000,
      "countOfViewers": 11,
      "UserAccountID": "749007",
      "UserOnlineId": "achaoq1",
      "TitleId": " YXZW12345",
      "TitleName": "Happy Cat Island",
      "channelId": "123123",
      "serviceType": "LIVEXYZ"
    },
    {
      "title": "Happy Cat Island Der Eisedrache Livestream
      Console V2",
      "description": "hmm... Share my thoughts? But I have no
      thoughts. The only thought I can think of is making the 500th
      upload special. But I guess if you must know I play video games,
      like a lot. January 12,2016",
      "broadcastDate": 1455916650000,
      "countOfViewers": 8,
      "UserAccountId": "749007_1",
      "UserOnlineId": "ach111_5_1",
      "TitleId": " YXZW12345",
      "TitleName": "Happy Cat Island",
      "channelId": "MVRE2s6Q",
      "serviceType": "LIVEXYZ"
    },
    {
      "title": "Live Happy Cat Island, round alto der eisendrache,
      solo",
      "description": "Live de Happy Cat Island, round alto der
      eisendrache, solo\n\ntwitter do canal pra ficar por dentro de
      quando tem live: https://twitter.com/achao5555",
      "broadcastDate": 1455916145000,
      "countOfViewers": 7,
      "UserAccountId": "749007_2",
      "UserOnlineId": "1234",
      "TitleId": " YXZW123455",
      "TitleName": "Happy Cat Island",
      "channelId": "1234",
      "serviceType": "LIVEXYZ"
    }
   ]
}