SocialSkip API v1

Authentication

SocialSkip API v1 use a Token-based authentication.

Token-based authentication requires an access token that is used by a client to access the resources from the server. To get the access token, sign in and visit your account settings page.

The provided access token you will need to add it to all requests. You can do by adding the access token as a access_token GET parameter. (See below)

http://www.socialskip.org/api/v1/interactions/experiment/123456?access_token=YOUR_ACCESS_TOKEN

Resources

Video interactions log

Experiment-based retrieval

method path example description
GET /api/v1/interactions/experiment/{experiment_id} http://www.socialskip.org/api/v1/interactions/experiment/123456?access_token=*** video interactions log of the experiment with id={experiment_id}

Filters

parameter accepted values example description
interactions forward, backward, play and pause http://www.socialskip.org/api/v1/interactions/experiment/123456?interactions=forward-backward&access_token=*** returns only selected interactions on the video interactions log

Video-based retrieval

method path example description
GET /api/v1/interactions/video/{youtube_video_id} http://www.socialskip.org/api/v1/interactions/video/tVIIgpIqoPw?access_token=*** video interactions log of the video with id={youtube_video_id}

Filters

parameter accepted values example description
interactions forward, backward, play and pause http://www.socialskip.org/api/v1/interactions/video/tVIIgpIqoPw?interactions=forward-backward&access_token=*** returns only selected interactions on the video interactions log
has_questionnaire yes or no http://www.socialskip.org/api/v1/interactions/video/tVIIgpIqoPw?has_questionnaire=no&access_token=*** returns interactions only for experiments which include (or not include) a questionnaire

Example

Request
http://www.socialskip.org/api/v1/interactions/experiment/123456?interactions=backward-forward-pause&access_token=***
Response
		
[{
  "video_id":"123456",
  "interaction_id":"1",
  "interaction":"Backward",
  "tester_id":"1000",
  "interaction_time":"15/03/2014 18:03:51",
  "video_time":"79",
  "skip_time":"10"
},
{
  "video_id":"123456",
  "interaction_id":"2",
  "interaction":"Forward",
  "tester_id":"1000",
  "interaction_time":"15/03/2014 18:04:03",
  "video_time":"194",
  "skip_time":"103"
},
{
  "video_id":"123456",
  "interaction_id":"4",
  "interaction":"Pause",
  "tester_id":"1000",
  "interaction_time":"15/03/2014 18:04:07",
  "video_time":"198",
  "skip_time":"0"
}]
						
						

Timeseries

Experiment-based retrieval

method path example description
GET /api/v1/timeseries/experiment/{experiment_id}/backward http://www.socialskip.org/api/v1/timeseries/experiment/123456/backward?access_token=*** backward timeseries of the experiment with id={experiment_id}
GET /api/v1/timeseries/experiment/{experiment_id}/forward http://www.socialskip.org/api/v1/timeseries/experiment/123456/forward?access_token=*** forward timeseries of the experiment with id={experiment_id}

Filters

parameter accepted values example description
No filters for this retrieval method.

Video-based retrieval

method path example description
GET /api/v1/timeseries/video/{youtube_video_id}/backward http://www.socialskip.org/api/v1/timeseries/video/tVIIgpIqoPw/backward?access_token=*** backward timeseries of the video with id={youtube_video_id}
GET /api/v1/timeseries/video/{youtube_video_id}/forward http://www.socialskip.org/api/v1/timeseries/video/tVIIgpIqoPw/forward?access_token=*** forward timeseries of the video with id={youtube_video_id}

Filters

parameter accepted values example description
has_questionnaire yes or no http://www.socialskip.org/api/v1/timeseries/video/tVIIgpIqoPw/backward?has_questionnaire=no&access_token=*** returns data only for experiments which include (or not include) a questionnaire

Example

Request
http://www.socialskip.org/api/v1/timeseries/video/tVIIgpIqoPw/forward?access_token=***
Response
		
[{
  "video_time":0,
  "count":12
},
{
  "video_time":1,
  "count":14
},
{
  "video_time":2,
  "count":14
},
{
  "video_time":3,
  "count":15
},
{
  "video_time":4,
  "count":15
}]