v1

latestOpenAPI 3.1.02026-07-246652306.5 KB

itemWindow

get/itemWindow

Query parameters

reasonstring

The reason a player is requesting a new item window. See the reason parameter page for a list of possible values. New in v2.2: Players can send requests with multiple reason values separated with a + symbol. For example, reason=load+queueCompleted.

itemIdstring

The identifier for the track that should be returned. If it is omitted or an empty string, it indicates your server should return the first item in your cloud queue.

previousWindowSizeinteger

The maximum number of tracks before the track specified by the itemId that should be returned by your cloud queue server. A non-negative integer.

upcomingWindowSizeinteger

The maximum number of tracks after the track specified by the itemId that should be returned by your cloud queue server. A non-negative integer.

queueVersionstring

The last cloud queue change state identifier cached by the player. This could have been from: -the last GET /itemWindow or GET /version response, and a loadCloudQueue or skipToItem response. This is omitted when the value is unknown, for example, if the server did not respond to a query.

isExplicitboolean

If true, indicates that a user performed a specific action or there was a specific intent to play the track. For example, the user pressed play, skipped backwards or forwards, or selected the track in the queue. If false or omitted, indicates that the player requested the track, for example, because it was the next track in the queue. You can use this to track user actions, for example, to determine if the playback stream has been initiated from another device.

Response

200