# Create occupancy report

Create a report of occupancy counts for a given time range and set of monitors.

Endpoint: POST /occupancy-reports
Version: 0.0.1
Security: o_auth

## Request fields (application/json):

  - `endDate` (string)
    It is the upper bound of the date range for which to return data. The endDate is non-inclusive; i.e, the returned data will be for dates from startDate to endDate-1.

  - `isOpen` (boolean)
    Flag to filter output within site opening hour window

  - `limit` (integer)
    Number of rows of returned data. A 0 value returns all rows in the requested time range.

  - `metrics` (array)
    List of metrics associated with the monitors.
    Enum: "occupancy_avg", "occupancy_max", "in_count_sum", "out_count_sum"

  - `occupancyMonitorIds` (array)
    List of occupancy monitor ids in the report. At least one id is required.

  - `startDate` (string)
    It is the lower bound of the date range for which to return data. The startDate is inclusive; i.e, the returned data will be for dates from startDate to endDate-1.

  - `timeGrain` (string)
    The time window in the requested range for data aggregation.
    Enum: "1m", "5m", "15m", "30m", "1h", "6h", "24h"

## Response 200 fields (application/json):

  - `inCountSum` (integer,null)

  - `occupancyAvg` (integer,null)

  - `occupancyMax` (integer,null)

  - `occupancyMonitorId` (string)

  - `outCountSum` (integer,null)

  - `time` (string)

## Response 400 fields (application/json):

  - `code` (integer)

  - `message` (string)

## Response 401 fields (application/json):

  - `code` (integer)

  - `message` (string)

## Response 403 fields (application/json):

  - `code` (integer)

  - `message` (string)

## Response 413 fields (application/json):

  - `code` (integer)

  - `message` (string)

## Response 422 fields (application/json):

  - `code` (integer)

  - `message` (string)

## Response 500 fields (application/json):

  - `code` (integer)

  - `message` (string)