GET
/
cms
/
events
/
v1

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page_size
integer

Maximum number of records to return

project_id
string
filter
string

Filter the result-set by properties using a subset of the Kibana Query Language. Only AND statements are supported. E.g. status:EVENT_STATUS_FINISHED and type_id:football_match For filtering on events without a type_id, use type_id:default.

order_by
string

Specifies the result ordering for List requests. Supported values are:

  • "title asc|desc"
  • "start_time asc|desc" This order is not applied when combined with search or pinned parameters.
page_token
string

The pagination token in the List request.

search
string

Any user-provided search query (as a plain string). This works in tandem with the filter parameter. Using search will automatically order all results by relevance instead of the supplied order_by value.

pinned
string[]

One or more event IDs that you want to receive at the top of the results (if it is available). Pinned items will not be included in the results if it does not match the filter. It will, however, ignore the search parameter. Using pinned will automatically order all results by relevance instead of the supplied order_by value.

Response

200 - application/json
events
object[]
next_page_token
string

The pagination token that should be used to get next page results. An empty value means no more results