Docs »

Data Queries »

Calendar Availability

calendar.availability

calendar.avalability queries aggregate any number of matching calenders to display availability over a date range by hour or day.

For instance, this can be used to visualize when a group is most or least available for shift planning.

Inputs

  • calendars: (a search query of calendar records to include)
  • range: (return availability within these dates)

Response Formats

The results can be returned in these formats:

  • dictionaries (default) returns a table-based format suitable for sheets and API results.

  • timeblocks returns a blocks-based format suitable for visualizations.

Examples



type:calendar.availability
range:"this month"
calendars:(
  workerAvailability:(group:(name:"Support"))
)
format:timeblocks