User Actions Log

The user action log contains events about user's plans and bookings. This information is helpful when investigating why a user may have been booked in a specific location.

It is recommended that you are familiar with Calven's data model before utilizing this endpoint. Users have 2 related features - plans and bookings. When a user's plan is updated to/from the office, they will also have their booking updated. Because of this, you will often see pairs of events together that are triggered from the same system action.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

startDate

string

required

Start date in the format of YYYYMMDD or YYYY-MM-DD

Example:

20211224

endDate

string

required

End date in the format of YYYYMMDD or YYYY-MM-DD

Example:

20211224

userIds

string

required

Comma separated list of user Ids to fetch the change log for

Example:

uid1,uid2

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

array of:

eventTime

string

required

The time the event occurred

Example:

2022-06-05T00:00:00.000Z

eventType

enum<string>

required

The type of event

Allowed values:

calven.booking.fact.locationBookingCreatedcalven.booking.fact.locationBookingDeletedcalven.booking.fact.locationBookingUpdatedcalven.booking.fact.placeBookingCreatedcalven.booking.fact.placeBookingDeletedcalven.booking.fact.placeBookingUpdatedcalven.booking.fact.releasedPlaceCreatedcalven.booking.fact.releasedPlaceDeletedcalven.booking.fact.userPlanCreatedcalven.booking.fact.userPlanDeletedcalven.booking.fact.userPlanUpdatedcalven.booking.fact.userPresenceUpdatedcalven.booking.fact.zoneBookingCreatedcalven.booking.fact.zoneBookingDeletedcalven.booking.fact.zoneBookingUpdated

Example:

calven.booking.fact.releasedPlaceCreated

userId

string

required

The id of the user associated with the event

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

day

string

required

The day the event occurred, in the format of YYYY-MM-DD

Example:

2022-06-05T00:00:00.000Z

reasonCode

object

required

The reason code assigned to the event

Example:

userSelected

source

enum<string>

required

The source of the event

Allowed values:

adminpublishschedulesensoruserwaitlist

Example:

user

locationId

object

required

The location id associated with the event

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

locationName

object

required

The name of the location associated with the event

Example:

New York

zoneId

object

required

The zone id associated with the event

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

zoneName

object

required

The name of the zone associated with the event

Example:

New York

placeId

object

required

The place id associated with the event

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

placeName

object

required

The name of the place associated with the event

Example:

New York

bookingId

object

required

The booking id associated with the event

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

placeBookingGroupId

object

required

The place booking group id associated with the event

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

plan

enum<string>

required

The plan associated with the event

Allowed values:

aor

Example:

calven.booking.plan.basic

bookingDepth

enum<number>

required

The booking depth associated with the event

Allowed values:

123

Example:

bookingIntentGroupId

object

required

The group id on booking intent when user chooses a group to sit with

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

isTentative

object

required

Whether the booking is tentative

Example:

true

isBookingConfirmed

object

required

Whether the booking is manually confirmed by the user after no-show notification

Example:

true

updatedBy

string

required

The id of the user or service account that updated the booking

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

Example

[
    {
        "eventTime": "2022-06-05T00:00:00.000Z",
        "eventType": "calven.booking.fact.locationBookingCreated",
        "userId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
        "day": "2022-06-05T00:00:00.000Z",
        "reasonCode": "userSelected",
        "source": "admin",
        "locationId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
        "locationName": "New York",
        "zoneId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
        "zoneName": "New York",
        "placeId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
        "placeName": "New York",
        "bookingId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
        "placeBookingGroupId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
        "plan": "a",
        "bookingDepth": 1,
        "bookingIntentGroupId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
        "isTentative": true,
        "isBookingConfirmed": true,
        "updatedBy": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b"
    }
]