Connectors Reference

Occuspace

The Occuspace connector provides real-time and historical occupancy data for Occuspace-enabled locations. Show how many people are in your space in real-time and learn from past trends to let people know when to expect busy times.

 

Status: Preview

Tier: Premium

Version: 0.1

 

Actions:

Name

Summary

LocationList ()

Location List

Real-TimeData (integer id)

Real-Time Data

HistoricalData (integer id, string start, string end)

Historical Data

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

HistoricalDataResponse

 

LocationListResponse

 

Real-TimeDataResponse

 

 

Actions:

LocationList

Summary: Location List

Description: An overall list of the spaces that Occuspace measures for a customer.

 

Syntax:

Occuspace.LocationList ()

 

Returns:

          Type:LocationListResponse

 

Real-TimeData

Summary: Real-Time Data

Description: The real-time occupancy count for a specific location being measured by Occuspace.

 

Syntax:

Occuspace.Real-TimeData (integer id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

integer(int64)

(ID of zone being queried for count data. Can be retrieved from location list.)

ID of the location being queried for real-time data.

True

 

Returns:

          Type:Real-TimeDataResponse

 

HistoricalData

Summary: Historical Data

Description: Historical occupancy data for a specific location being measured by Occuspace.

 

Syntax:

Occuspace.HistoricalData (integer id, string start, string end)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

integer(int64)

(ID of zone being queried for count data. Can be retrieved from location list.)

ID of zone being queried for count data.

True

start

string

(UTC ISO timestamp of start date.)

UTC ISO timestamp of start date.

True

end

string

(UTC ISO timestamp of end date.)

UTC ISO timestamp of end date.

True

 

Returns:

          Type:HistoricalDataResponse

 


 

HistoricalDataResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

 

message

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

counts

array of (CountsItem)

 

counts

maximum

Maximum

 

maximum

minimum

Minimum

 

minimum

average

integer(int32)

 

average

 

CountsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

percentage

number(float)

 

percentage

count

integer(int32)

 

count

timestamp

string

 

timestamp

normalizedDate

string

 

normalizedDate

normalizedTime

string

 

normalizedTime

 

Maximum

Summary:

Description: maximum

 

          Properties:

Name

Type

Summary

percentage

number(float)

 

percentage

count

integer(int32)

 

count

timestamp

string

 

timestamp

normalizedDate

string

 

normalizedDate

normalizedTime

string

 

normalizedTime

 

Minimum

Summary:

Description: minimum

 

          Properties:

Name

Type

Summary

percentage

number(float)

 

percentage

count

integer(int32)

 

count

timestamp

string

 

timestamp

normalizedDate

string

 

normalizedDate

normalizedTime

string

 

normalizedTime

 


 

LocationListResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

 

message

data

array of (DataItem)

 

data

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

id

name

string

 

name

parentId

integer(int32)

 

parentId

capacity

integer(int32)

 

capacity

earliestCount

string

 

earliestCount

 


 

Real-TimeDataResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

 

message

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

id

name

string

 

name

count

integer(int32)

 

count

percentage

number(float)

 

percentage

timestamp

string

 

timestamp

childCounts

array of (ChildCountsItem)

 

childCounts

 

ChildCountsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

id

name

string

 

name

count

integer(int32)

 

count

percentage

number(float)

 

percentage