Predict Space Type Category Distribution

Returns occupancy distribution histograms for spaces on a floor, grouped by space type category and capacity.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
❗️

This endpoint requires Predict API access. Contact VergeSense to discuss availability for your organization.

Given a geojson of spaces on a floor, this endpoint returns person-count occupancy
distribution histograms per space type category, grouped by capacity. For each
combination of space type category and capacity, the response describes what percentage of 1,000 Monte Carlo
simulation runs resulted in each possible occupancy level (0 to capacity), pooled across all
spaces sharing that space type category and capacity.

Request Body

The supplied input is expected to be valid GeoJSON. At the top level, there is expected to be a person_count attribute whose value has the following specification:

  • person_count (int, required) person count value to model

Within the GeoJSON specification, this type of attribute is considered a "foreign member". See the Predict API GeoJSON section for more information regarding the input expectations.

Response

The response will conform to the JSON API spec. The top-level keys will be data and meta.

data contains one object of type space_type_category_distribution_prediction. Its attributes are person_count and space_type_categories.

  • person_count: The person count simulated.
  • space_type_categories: An object keyed by snake_case space type category (e.g. enclosed_collab). Each value is an array of capacity-group objects, one per distinct capacity found among spaces of that category.
    • capacity: (int) The capacity shared by all spaces in this group.
    • spaces: An array of the constituent spaces in this group, each with:
      • id: The original space ID supplied through the GeoJSON.
      • name: The original space name supplied through the GeoJSON.
    • avg_person_count: (float) The average occupancy across all spaces and simulation runs in the group.
    • avg_person_count_when_used: (float) The average occupancy, counting only runs where a space was occupied.
    • histogram: An array of objects covering occupancy levels 0 through capacity (inclusive). Each entry has:
      • person_count: (int) The occupancy level (0..capacity).
      • pct: (float) The percentage of simulation instances in which this occupancy level occurred across all spaces in the group. Values sum to 100 within each capacity group.

The meta object includes:

  • person_count: The requested person count.
  • model_version: The model version string.
  • building_profile: The building profile used for the prediction.
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json