Skip to main content
POST
Log media playback event

Authorizations

Authorization
string
header
required

Enter your API token from the Haystack dashboard

Body

application/json
eventType
enum<string>
required
Available options:
play,
pause,
seek,
progress,
end,
error
itemId
integer
required
mediaAssetId
integer
required
surface
enum<string>
required
Available options:
embed,
connect,
console
mediaAssetType
string

Variant type name

embedToken
string | null
playbackSessionId
string

Client-generated session id, unique per tab

currentPlaybackPositionSeconds
number
totalPlaybackSeconds
number

Cumulative play time since session start

itemDurationSeconds
number | null
playbackRate
number | null
isEmbedded
boolean
searchId
string | null

Set when playback was initiated from a search result

errorMessage
string | null

Response

200 - application/json

Event logged

mediaPlaybackEventId
string