Presence Details

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

endDate

string

required

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

Example:

2023-12-31T00:00:00.000Z

locationIds

string

optional

Comma separated list of locationIds to fetch the change log for. If not provided, all locations are queried.

Example:

location1,location2

startDate

string

required

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

Example:

2023-01-01T00:00:00.000Z

userIds

string

optional

Comma separated list of user ids to fetch the change log for. If not provided, all users are queried.

Example:

uid1,uid2

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.calven.com/v1/analytics/presence/basic?endDate&startDate' \
--header 'Authorization: Basic Og=='

Responses

🟢200OK

application/json

Body

array of:

levelId

object

required

The levelId of a presence event

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

levelName

object

required

The name of a level for a presence event

Example:

Level 1

locationDay

string

required

The DATE portion of the timestamp of a presence event in location's timezone. Format: YYYY-MM-DD

Example:

2023-12-31T00:00:00.000Z

locationId

string

required

The locationId of a presence event

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

locationName

string

required

The name of a location for a presence event

Example:

Main Office

locationTime

string

required

The TIME portion of the timestamp of a presence event in location's timezone. Format: HH:MM:SS

Example:

14:30:00

placeId

object

required

The placeId of a presence event

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

placeName

object

required

The name of a place for a presence event

Example:

Desk 1

source

string

required

The source of a presence event

Example:

sensor

timestamp

string

required

The timestamp of a presence event. Format: ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)

Example:

2023-12-31T14:30:00.000Z

userId

string

required

The uid of a user record

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

zoneId

object

required

The zoneId of a presence event

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

zoneName

object

required

The name of a zone for a presence event

Example:

Zone A

Example

[
    {
        "levelId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
        "levelName": "Level 1",
        "locationDay": "2023-12-31T00:00:00.000Z",
        "locationId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
        "locationName": "Main Office",
        "locationTime": "14:30:00",
        "placeId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
        "placeName": "Desk 1",
        "source": "sensor",
        "timestamp": "2023-12-31T14:30:00.000Z",
        "userId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
        "zoneId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
        "zoneName": "Zone A"
    }
]