Skip to main content
GET
Retrieve Livestream Viewership

Autorisationer

Authorization
string
header
påkrævet

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

livestream:moderate

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

Livestream ID, prefixed lfeed_.

Svar

livestream viewership retrieved

average_viewers
number
påkrævet

Average number of viewers watching at once, not counting the host: watch_time_seconds divided by how long the livestream has run, rounded to one decimal place.

Eksempel:

31.1

new_members
integer
påkrævet

Number of members who joined the account between the start of the livestream and its end, or now while it is live. Team members are not counted.

Eksempel:

1

peak_viewers
integer
påkrævet

Highest number of viewers watching at once, not counting the host.

Eksempel:

164

peak_viewers_at
string | null
påkrævet

When the livestream first reached peak_viewers, as an ISO 8601 timestamp. null when nobody watched.

Eksempel:

"2026-01-01T12:00:00.000Z"

tracked
boolean
påkrævet

Whether viewer activity was tracked for this livestream. false before it starts, and after it ends when nothing was recorded, such as for livestreams from before viewer tracking existed. Every viewer count is then 0.

Eksempel:

true

unique_viewers
integer
påkrævet

Number of distinct people who watched, not counting the host. A signed-out guest counts once per visit.

Eksempel:

182

viewers
object[]
påkrævet
watch_time_seconds
integer
påkrævet

Total time viewers spent watching, in seconds, not counting the host.

Eksempel:

197340