Skip to main content
GET
/
v1
/
events
/
{id}
Event detail
curl --request GET \
  --url http://localhost:8787/v1/events/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "title": "<string>",
  "avg_viewers": 123,
  "peak_viewers": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "channels": [
    "<string>"
  ],
  "logo_url": "<string>",
  "user_id": "<string>",
  "is_public": true,
  "description": "<string>",
  "host_stream_id": "<string>",
  "streams": [
    {
      "id": "<string>",
      "streamer_id": "<string>",
      "title": "<string>",
      "game_name": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "avg_viewers": 123,
      "peak_viewers": 123,
      "is_live": true,
      "display_name": "<string>",
      "profile_image": "<string>"
    }
  ],
  "markers": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "color": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Optional bearer token enforced when the Worker is configured with an API token.

Path Parameters

id
string
required

Response

Successful response

id
string
title
string
avg_viewers
integer | null
peak_viewers
integer | null
started_at
string<date-time>
ended_at
string<date-time> | null
channels
string[] | null
logo_url
string<uri> | null
user_id
string | null
is_public
boolean
description
string | null
host_stream_id
string | null
streams
object[]
markers
object[]