Overview

Log Play

Records a single play event for a track on a registered device while the user is online. The body specifies the track, event type (Start, Progress, End, or Skip), playback position, content source, and how audio was delivered (e.g. Stream or Download).

Use this when: you need to report active online playback for analytics and royalty reporting. Send Start at play begin, periodic Progress updates, and End or Skip when the user stops or moves on. Reuse the same Guid across events for one track session. Use Log Offline Plays to upload batched events after offline listening; use Log Live Play for live video, not this endpoint.

Security Model

oAuth

Header Parameters

Authorizationstring Required

Credentials with catalogue:read scope.

StoreIdstring Required

StoreId API Key provided by Tuned Global for accessing the service.

Countrystring

Market for the play log.

Default value

Defaults to the store's default country.

Path Parameters

deviceIdinteger Required

Id of the device performing the play

Body Parameters

TrackIdinteger Required

Id of the track that has been played

LogPlayTypestring Required

The type of event being logged

Enum values:

StartProgressEndSkip

Secondsinteger Required

Optional. The number of seconds the track had been played for at the point of this event

Sourcestring

Source of the log play. Acceptable values are Queue, Station,Playlist,Album, Artist, Podcast,Log, ExtRadio, Continuous, System

Default value

Queue

Enum values:

QueueStationPlaylistAlbumArtistPodcastLogExtRadioContinuousSystem

... 1 other enums

FileSourcestring Required

Source of the file being played

Enum values:

StreamOfflineCacheDownloadPreview

SourceIdinteger

ID of the Source. This would be the AlbumId, ArtistId, PlaylistId, StationId depending of the Value used in the Source parameter

Latitudenumber

Latitude coordinate of the user

Longitudenumber

Longitude coordinate of the user

Guidstring Required

Guid for log play. If you are sending multiple 'PlayTypes' for the same play i.e. start, progress, skip or end, please use the same GUID for all these events.

AudioQualitystring

Audio quality of the track. Acceptable values are low, med, high, HD.

Enum values:

lowhighhlsflacogg

Countrystring Required

ISO-2 country code of the user

PlayerTypestring

Type of player used for the log play

Enum values:

MobilePhoneTabletWebAutoWatchTvOther

Extrasstring

Additional information for the log play event

Response

200

Object

Response Attributes

Valueboolean

Whether the play log was accepted

Sections

Log Play

Security Model

Header Parameters

Path Parameters

Body Parameters

... 1 other enums

Response

Response Attributes

Response