/api/playback/sessions/{sessionId}/heartbeat

Path Parameters

sessionId*string

Playback session ID

application/json

TypeScript Definitions

Use the request body type in TypeScript.

position*number

Range0 <= value

duration?number

Range0 <= value

secondsWatched?number

Range0 <= value

pagesRead?integer

Range0 <= value

curl -X POST "https://example.com/api/playback/sessions/string/heartbeat" \  -H "Content-Type: application/json" \  -d '{    "position": 0  }'

{
  "success": true
}

{
  "error": "string"
}

{
  "error": "string"
}