Log a play for the specified track

Header Parameters

StoreIdstring Required

APIKey provided by TG

Authorizationstring Required

Http basic auth header

Body Parameters

UserIdinteger

ID of the Tuned user

Default value
0
TrackIdinteger Required

Tuned Track id

Countrystring Required

ISO-2 country code of the user

LogPlayTypestring Required

Type of log play. Acceptable values are Start, Progress, Skip, End

Enum values:
Secondsinteger Required

Duration of the play. Acceptable values are 0, 5, 10, 30 or total song duration in seconds

Default value
30
Sourcestring

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

Default value
Queue
Enum values:
PlayTypestring Required

Type of play. Acceptable values are Stream, Offline, Cache, Download, Preview

Default value
Stream
Enum values:
SourceIdinteger

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

Default value
0
UserIpstring

Ip address of the user.

DeviceIdinteger

ID of Device the play is logged from.

Latitudenumber
Longitudenumber
SubIdinteger

ID of the subscription / plan the user is on.

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:
IsValidboolean

Indicate if the model is valid or not.

ExternalPlanIdstring

Id of the plan from client's system.

Response

200
Object
JSON object with a Boolean flag denoting the status of the log play API.

Response Attributes

Valueboolean

Return value true or false

Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?

Base URL

Production:

Sandbox:

Language Box

POST

/

Select
1

Response

Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot