v1

latestSwagger 2.0raw.githubusercontent.com2018-12-0670110154.0 KB
dev

returns a list of events that were received for a specific user within a given date range

This endpoint allows you to retrieve the events that were captured for a specific user and within a given date range. A user is identified by the application identifier and the user identifier. You can also search for only specific type of event using the query parameter eventType. There is a restriction on the number of days that your input date range can span which at the moment is set to 7 days.

get/dev/events

Query parameters

userIdstring required

the identifier of the user for which the events were found

appIdstring required

the identifier of the application in which the user belongs

eventTypestring

if a value is set, then only events of this type will be returned.

startTimestring

Defines the start of the data range that must contain the creation date of each event. If not defined, the start time will be set to half an hour ago.

endTimestring

Defines the end of the data range that must contain the creation date of each event. If not defined it will default to one hour after the start time.

maxResultsnumber

Limits the number of events that will be returned by this call. If not set it will default to 50.

Response

A JSON document that contains the list of events that were found for that user and matching the search criteria. The list is ordered by the creation date of the events in descending order, i.e. the most recent events appear first.

eventsobject[]

A list of events that matched the input search criteria,each event is represented by a JSON object whose schema is customer specific