Calven
  1. Warehouse - HMAC Auth
Calven
  • Overview
  • Key Access Levels
  • Basic Authentication Overview
  • HMAC Authentication Overview
  • SDKs
  • Calven Data Models
  • HMAC Authentication
    • Generate a token with an API key and HMAC
      POST
    • Generate a token with an API key and client secret
      POST
  • Presence
    • Presence Overview
    • Submit presence events with BASIC auth
      POST
    • Submit presence events
      POST
  • Occupancy
    • Occupancy Overview
    • Submit occupancy events
      POST
  • Time off
    • Submit time off updates
      POST
  • Access Credentials
    • Submit access credentials
      POST
  • Warehouse - Basic Auth
    • Warehouse Overview
    • Users
      GET
    • Locations
      GET
    • Desks
      GET
    • Bookings & Attendance
      GET
    • Presence Details
      GET
    • User Actions Log
      GET
  • Warehouse - HMAC Auth
    • Warehouse Overview
    • Users
      GET
    • Locations
      GET
    • Desks
      GET
    • Bookings & Attendance
      GET
    • Presence
      GET
    • User Actions Log
      GET
  1. Warehouse - HMAC Auth

Bookings & Attendance

GET
/v1/analytics/user-booking-attendance
analytics

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
startDate
string 
required
Start date in the format YYYYMMDD or YYYY-MM-DD
Example:
20211224
endDate
string 
required
End date in the format YYYYMMDD or YYYY-MM-DD
Example:
20211224
locationId
string 
optional
Location Id to query data for. If not provided, data for all locations is queried.
Example:
3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.calven.com/v1/analytics/user-booking-attendance?startDate&endDate'

Responses

🟢200OK
application/json
Body
array of:
userId
string 
required
The ID of a user
Example:
3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b
primaryLocationId
string 
required
The primary location ID of a user
Example:
3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b
primaryLocationName
string 
required
The primary location name of a user
Example:
New York
day
string 
required
The day in the format YYYY-MM-DD
Example:
2021-12-24T00:00:00.000Z
plan
enum<string> 
required
The type of plan
Allowed values:
aor
Example:
o
bookingDepth
enum<number> 
optional
The booking depth
Allowed values:
123
Example:
1
attendanceType
enum<string> 
optional
The attendance type
Allowed values:
confirmednoShowunconfirmedwalkIn
Example:
confirmed
bookingLocationId
object 
optional
The location ID of the booking
Example:
3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b
bookingLocationName
object 
optional
The location name of the booking
Example:
New York
bookingLevelId
object 
optional
The level ID of the booking
Example:
3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b
bookingLevelName
object 
optional
The level name of the booking
Example:
Level 1
bookingZoneId
object 
optional
The zone ID of the booking
Example:
3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b
bookingZoneName
object 
optional
The zone name of the booking
Example:
Engineering Zone
bookingPlaceId
object 
optional
The place ID of the booking
Example:
3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b
bookingPlaceName
object 
optional
The place name of the booking
Example:
WD1
primaryGroupId
object 
optional
The primary group ID of a user
Example:
3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b
primaryGroupName
object 
optional
The primary group name of a user
Example:
Engineering
bookingGroupId
object 
optional
The group ID of the booking
Example:
3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b
bookingGroupName
object 
optional
The group name of the booking
Example:
Engineering
bookingSource
string 
required
The source of the booking
Example:
user
bookingReasonCode
object 
required
The reason code of the booking
Example:
userSelected
onWaitlist
boolean 
required
The waitlist status of the booking
Example:
true
Example
[
  {
    "userId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "primaryLocationId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "primaryLocationName": "New York",
    "day": "2021-12-24T00:00:00.000Z",
    "plan": "a",
    "bookingDepth": 1,
    "attendanceType": "confirmed",
    "bookingLocationId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "bookingLocationName": "New York",
    "bookingLevelId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "bookingLevelName": "Level 1",
    "bookingZoneId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "bookingZoneName": "Engineering Zone",
    "bookingPlaceId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "bookingPlaceName": "WD1",
    "primaryGroupId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "primaryGroupName": "Engineering",
    "bookingGroupId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "bookingGroupName": "Engineering",
    "bookingSource": "user",
    "bookingReasonCode": "userSelected",
    "onWaitlist": true
  }
]
Modified at 2025-04-03 13:54:25
Previous
Desks
Next
Presence
Built with