Event Logger API Follow

Overview

All logging requests should go to http://px.topspin.net/ev

Default parameters

All arguments will be passed as part of the GET query string.

new query keyformer keydescriptiontype
etevent_typeevent type iinteger from below list
esevent_sourcethe kind of widget sending the eventwill always be 10 for custom API player
uparent_urlthe url this widget is being served fromfull url
ccampaign_idthe campaign of the widgetinteger of campaign

Event Types

et valueevent
0view
1play
3click

Default response

The server will return a 200 OK along with the following headers:

The server will return a 1x1 image.

Primary event types

Play

  • Definition: a music track or video clip has started playback as the result of an explicit user request.
  • Additional Parameters: m: product id of media being played. st: subtype of play, see table below.
st valuesub type Play event
0user initiated play
1autoplay



The play event is sent at the beginning of the track and only one play event is ever sent per track. If the track is paused / unpaused, no further plays are propagated for the track.

The autoplay event is sent at the beginning of the track and only one autoplay event is ever sent per track. If the track is paused / unpaused, no further plays / autoplays are propagated for the track. Any subsequent tracks are logged as plays as defined above (since they are the result of an explicit user request).

Click

  • Definition: a "click" has a different meaning depending on the widget, but is effectively a measurement of fan activity. Each widget has one type of click that can be fired per load of the widget, such as clicking on a link or submitting an email address.
  • Additional Parameters: st: subtype of click. subtypes will be specified in a later revision.

View

  • Definition: an impression: a widget was successfully loaded and displayed to the user
  • Additional Parameters: none

Examples

View, campaign id = 1, 
http://px.topspin.net/ev?et=0&c=1&es=10

Play, campaign id = 1, media being played id = 1000: 
http://px.topspin.net/ev?et=1&es=X&c=1&es=10&m=1000

Autoplay, campaign id = 1, media being played id = 1000: 
http://px.topspin.net/ev?et=1&st=1&s=0&c=1&es=10&m=1000

Click, campaign id = 1, 
http://px.topspin.net/ev?et=3&c=1&es=10

 

Have more questions? Submit a request and our team will be able to help get you sorted.
Powered by Zendesk