The TwentyThree™ API

API Method: /api/viewer/list

Get a list of recent viewers, viewer timelines and viewer profiles

The method also return a Bayeux/Faye server and channel that allows listening for further events for viewers.

Parameters

ParameterDescription
uuid Filter viewers profiles to a specific uuid.
object Filter viewers profiles to a specific object. This may be either a `live_id` or a `photo_id`.
user Filter profiles to a specific user id.
search Search through viewer profiles.
minutes Number of minutes to include viewer updates for.
conversion Boolean allow filtering to only converted viewers, i.e. viewers that have converted by leaving extra information such as e-mail or name.
include_timelines_p Boolean indicating whether or not to include viewer timelines in the reponse. Default is `false`.
include_events_p Boolean indicating whether or not to include events in the reponse. Default is `false`.
orderby Ordering of profiles, default is `recent`. Valid options are `recent`, `email`, `timeline_first`, `timeline_recent`, `timeline_count`, `timeline_engagement`, `event_first`, `event_updated`, `event_count`.
order Order of the profiles in the response
Default: desc
Valid values: desc and asc

This methods support standard options for pagination: p, size and offset.

Permission level

The minimum required permission level is:

read

Example JSON Response

{  
   "status":"ok",
   "permission_level":"read",
   "cached":"0",
   "profiles":[  
      {  
         "uuid":"48fbfc40-0d8b-03ca-9a17-9b9ef2b8f1fc",
         "site":454054,
         "identifier":2991,
         "email":"",
         "user":"",
         "ip":"24.200.4.163",
         "profile":{  
            "city":"Québec",
            "country":"Canada",
            "latitude":46.786699999999996,
            "longitude":-71.2436,
            "postalCode":"G1S",
            "regionName":"Quebec",
            "countryCode":"CA",
            "continentCode":"NA"
         },
         "conversion":false,
         "timeline_first":"2016-02-13T19:15:07.551Z",
         "timeline_recent":"2016-02-13T20:42:33.016Z",
         "timeline_count":2,
         "timeline_engagement":380,
         "event_first":null,
         "event_updated":null,
         "event_count":0,
         "source_first":"embed",
         "referer_first":"http://www.23video.com/closed",
         "source_recent":"embed",
         "referer_recent":"http://www.23video.com/closed",
         "first":"2016-02-13T19:15:07.540Z",
         "recent":"2016-02-13T20:43:32.792Z",
         "timelines":[  
            {  
               "uuid":"48fbfc40-0d8b-03ca-9a17-9b9ef2b8f1fc",
               "site":454054,
               "object":"12098241",
               "ranges":"0 100",
               "engagement":190,
               "duration":190,
               "type":"ondemand",
               "playhead":189,
               "active":false,
               "source":"embed",
               "referer":"http://www.23video.com/",
               "first":"2016-02-13T19:07:24",
               "updated":"2016-02-13T20:15:07.551581"
            },
            {  
               "uuid":"48fbfc40-0d8b-03ca-9a17-9b9ef2b8f1fc",
               "site":454054,
               "object":"12098241",
               "ranges":"0 100",
               "engagement":190,
               "duration":190,
               "type":"ondemand",
               "playhead":189,
               "active":false,
               "source":"embed",
               "referer":"http://www.23video.com/",
               "first":"2016-02-13T20:42:29",
               "updated":"2016-02-13T21:42:33.016049"
            }
         ]
      }
   ],
   "realtime_url":"//dev.audience.systems/faye",
   "realtime_channel":"/audience/17480/**",
   "realtime_authorization":"1455397141 mmGoZxaogO8bVhk3S6yR2OyDX0g=",
   "timezone_offset":"-6",
   "site":{
       ...
   },
   "endpoint":"/api/viewer/list"
}

Example XML Response

This endpoint doesn't support XML responses.