com.intuit.wasabi.api

Class EventsResource

java.lang.Object

com.intuit.wasabi.api.EventsResource

public class EventsResource
extends Object

API endpoint for managing events

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getEventsQueueLength() Returns number of events currently in the queue
javax.ws.rs.core.Response	recordEvents(Application.Name applicationName, Experiment.Label experimentLabel, User.ID userID, EventList eventList) Submit events for the specified user within the context of a specific application and experiment.
javax.ws.rs.core.Response	recordExperimentsEvents(Application.Name applicationName, User.ID userID, Map<Experiment.Label,Map<User.ID,List<Event>>> eventList) Submit events for users and experiments within the context of a specific application.
javax.ws.rs.core.Response	recordUsersEvents(Application.Name applicationName, Experiment.Label experimentLabel, Map<User.ID,List<Event>> eventList) Submit events for users within the context of a specific application and experiment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

recordEvents

@Timed
public javax.ws.rs.core.Response recordEvents(Application.Name applicationName,
                                                     Experiment.Label experimentLabel,
                                                     User.ID userID,
                                                     EventList eventList)
                                              throws Exception

Submit events for the specified user within the context of a specific application and experiment. Each event is an impression or action. Example events structure "events": [ { "timestamp": "...", "name": "..." "IMPRESSION" for impressions anything else for action "payload": "..." json string (with escaped quotes). "value": ... null: binary action success number: continuous/counting action string: categorical action boolean: not currently used }

Parameters:

applicationName - the application name

experimentLabel - the experiment label

userID - the current user id

eventList - the EventList event list

Returns:

Response object

Throws:

Exception - generic exception

recordUsersEvents

@Timed
public javax.ws.rs.core.Response recordUsersEvents(Application.Name applicationName,
                                                          Experiment.Label experimentLabel,
                                                          Map<User.ID,List<Event>> eventList)

Submit events for users within the context of a specific application and experiment. Each event is an impression or action.

Parameters:

applicationName - the application name

experimentLabel - the experiment label

eventList - the EventList event list

Throws:

UnsupportedOperationException - UnsupportedOperationException

recordExperimentsEvents

@Timed
public javax.ws.rs.core.Response recordExperimentsEvents(Application.Name applicationName,
                                                                User.ID userID,
                                                                Map<Experiment.Label,Map<User.ID,List<Event>>> eventList)

Submit events for users and experiments within the context of a specific application. Each event is an impression or action.

Parameters:

applicationName - the application name

userID - the user id

eventList - the EventList event list

Throws:

UnsupportedOperationException - always throws

getEventsQueueLength

@Timed
public javax.ws.rs.core.Response getEventsQueueLength()

Returns number of events currently in the queue

Returns:

Response object