API: Events

Returns a list of events from a type in a given time range.

Request

/api/v1/event-log/{eventLogType}/list?from={fromDateTime}&to={toDateTime}

Parameter

Data

Attribut	Datentyp	Beschreibung
eventLogType	String	Requested type
fromDateTime	ISO Date / Time	From Date
toDateTime	ISO Date / Time	To Date

 

Possible event log types

USER_LOGIN

A user has done a login in the App.

USER_LOGOUT

A user has done a logout in the App. If the app is closed without logout, this event will not be recorded.

USER_LOGIN_SNCB_VIDEO_SHOWN

Special event for a customer as soon as a video is shown.

TOUR_STARTED

Tour started on the App

TOUR_STOPPED

Tour ended on the App

STOP_TOUR_SELECT_TOUR

Tour ended on the app but with redirect to the cleaning tours or economic entity view. This is alternative to the TOUR_STOPPED event.

TOUR_STOPPED_TIMEOUT

Tour stopped because of a timeout. The user didn't end the tour.

Answer

Data

Attribut	Datentyp	Beschreibung
id	Long	ID from the event
message	String	Event Text oder Null
economicEntityId	Long	ID from the economic entity
mobileDeviceId	Long	ID vom mobile device
eventDate	ISO Date / Time	Event date
eventLogType	String	Event Log Type
tourSessionId	String	Unique tour execution ID
tourId	Long	ID from the tour
userId	Long	ID from the user
employeeId	String	Employee Id from the user

Example answer

[{
"message": null,
"id": 231321,
"economicEntityId": 71,
"mobileDeviceId": 1,
"eventDate": "2023-10-14T08:12:58",
"eventLogType": "STOP_TOUR_SELECT_TOUR",
"tourSessionId": "62baf176-86d4-dc3e-a83c-0cba9771f58a",
"tourId": 2000,
"userId": 3000,
"employeeId": "SAP-23443"
}]