Skip to main content
POST
/
logging
/
media-playback-events
Log media playback event
curl --request POST \
  --url https://api.thehaystack.ai/v2/haystack/logging/media-playback-events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventType": "play",
  "itemId": 123,
  "mediaAssetId": 123,
  "surface": "embed",
  "mediaAssetType": "<string>",
  "embedToken": "<string>",
  "playbackSessionId": "<string>",
  "currentPlaybackPositionSeconds": 123,
  "totalPlaybackSeconds": 123,
  "itemDurationSeconds": 123,
  "playbackRate": 123,
  "isEmbedded": true,
  "searchId": "<string>",
  "errorMessage": "<string>"
}
'
{
  "mediaPlaybackEventId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.thehaystack.ai/llms.txt

Use this file to discover all available pages before exploring further.

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