DeveloperAPI ReferencePlaybackSessions
/api/playback/sessions
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/playback/sessions" \ -H "Content-Type: application/json" \ -d '{ "itemId": "string" }'{
"session": {
"id": "string",
"userId": "string",
"profileId": "string",
"itemId": "string",
"fileId": "string",
"libraryId": "string",
"mediaType": "string",
"source": "tracked",
"status": "active",
"startPosition": 0,
"endPosition": 0,
"duration": 0,
"secondsWatched": 0,
"pagesRead": 0,
"completed": true,
"playbackFormat": "direct_play",
"videoCodec": "string",
"audioCodec": "string",
"container": "string",
"clientName": "string",
"userAgent": "string",
"clientIp": "string",
"startedAt": "string",
"endedAt": "string",
"lastHeartbeatAt": "string"
}
}{
"error": "string"
}