Retrieve a list of live events
Retrieves a list of live events. Only ongoing live events can be retrieved.
HTTP request
Parameters
The following table lists the parameters that this action supports.
Optional
Parameter name | Type | Description |
---|---|---|
host_type | string | Restricts the search scope to only retrieve live events whose |
state | string | Restricts the search scope to only retrieve live events whose |
created_at_start_date | int | Specifies the value of time period to restrict the search scope to only retrieve live events whose |
created_at_end_date | int | Specifies the value of time period to restrict the search scope to only retrieve live events whose |
started_at_start_date | int | Specifies the value of time period to restrict the search scope to only retrieve live events where the live event's started_at is equal to or greater than the specified value, in Unix milliseconds. |
started_at_end_date | int | Specifies the value of time period to restrict the search scope to only retrieve live events where the live event's started_at is less than the specified value, in Unix milliseconds. |
participant_count_range_gte | int | Specifies the number of current participants to restrict the search scope to only retrieve live events where the number of participants is equal to or greater than the specified value. |
participant_count_range_lte | int | Specifies the number of current participants to restrict the search scope to only retrieve live events where the number of participants is equal to or less than the specified value. |
live_event_ids | string | Searches for live events which the specified live event IDs are included in the parameter value. The string should consist of multiple URL encoded live event IDs separated by commas. |
created_by_user_ids | string | Searches for live events which the specified user IDs of users who created live events are included in the parameter value. The string should consist of multiple URL encoded user IDs separated by commas. |
duration_range_gte | long | Specifies the value of the duration to restrict search scope to only retrieve live events whose duration is equal to or greater than the specified value, in Unix milliseconds. |
duration_range_lte | long | Specifies the value of the duration to restrict search scope to only retrieve live events whose duration is less than the specified value, in Unix milliseconds. |
title_contains | string | Searches for live events which contains the specified value in their live event titles. |
current_host_user_id | string | Searches for a live event where the specified user ID of user who has entered as host is equal to the parameter value. |
limit | int | Specifies the number of results to retrieve per page. Acceptable values are 1 to 100, inclusive. (Default: |
prev | string | Specifies the value of the |
next | string | Specifies the value of the |
Response
If successful, this action returns a list of all live events in the application in the response body.
List of response properties
Property name | Type | Description |
---|---|---|
live_events | list of nested objects | A list of live events that has been retrieved. |
prev | string | Specifies the value of the |
next | string | Specifies the value of the |