API reference

Stats

Watch history and server-wide statistics (P3-20).

Paths are relative to /api/v1 on your server.

GET/history#

My watch history

Parameter	In	Type
`types`	query	`string`
`libraryId`	query	`string (uuid)`
`itemId`	query	`string (uuid)`
`method`	query	`"direct_play" \| "direct_stream" \| "transcode"`
`from`	query	`string (date-time)`
`to`	query	`string (date-time)`
`cursor`	query	`string`
`limit`	query	`integer`
`cards`	query

200Success. application/json · HistoryPage
400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope
401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
403FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope

GET/profile#

When the caller joined, and how much they have played: every play of theirs, whatever library it was in.

200Success. application/json · Profile
401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
403FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope

GET/stats#

Parameter	In	Type
`period`	query	`"7d" \| "30d" \| "90d" \| "365d" \| "all"`
`libraryId`	query	`string (uuid)`
`tz`	query	`string`

200Success. application/json · ServerStats
400VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope
401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
403FORBIDDEN: the account lacks session:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope