# Upload list of visitors

**POST** `https://api.zoined.com/visitors?dryRun=false&separator=%3B&encoding=utf-8`

Endpoint: POST /visitors
Security: bearerAuth

## Security:

  - `bearerAuth` (unknown)
    http bearer token

## Query parameters:

  - `dryRun` (boolean, required)
    Only validate the request without storing the data

  - `separator` (string, required)
    Column separator used when loading CSV data

  - `encoding` (string, required)
    Character encoding used in the CSV data (default is utf-8)

## Request fields (application/json):

  - `organisation_id` (string, required)
    Organisation/Store ID
    Example: 540

  - `department_id` (string)
    Department ID
    Example: 540

  - `counter_id` (string)
    Counter ID
    Example: 540

  - `product_id` (string)
    `Optional product id associated to this visitor (eg. ticket)`
    Example: ABC-123

  - `customer_id` (string)
    Optional customer associated to this visitor (ticket etc.)
    Example: 1234

  - `date` (string, required)
    Date of visit (yyyy-mm-dd)
    Example: 2016-01-01

  - `time` (string, required)
    Time of visit (HH:mm:ss)
    Example: 15:00:00

  - `time_zone` (string)
    Optional location time zone.
    Example: 02:00

  - `visit_type` (string)
    `Type of visitor record ('in', 'out', 'pass', 'occupancy', 'visit_time', 'queue')`
    Example: in

  - `vehicle_type` (string)
    Optional field for vehicle type. Supported values are car & bicycle.
    Example: car

  - `queue_area_name` (string)
    Optional area name for queue cameras.
    Example: Area 1

  - `low_queue` (number)
    Threshold for low queue.
    Example: 1

  - `high_queue` (number)
    Threshold for high queue.
    Example: 5

  - `visitors` (number, required)
    Number of visitors at given time
    Example: 1000

  - `custom_metric_1` (number)
    Custom metric 1
    Example: 1

  - `custom_metric_2` (number)
    Custom metric 2
    Example: 100

  - `custom_metric_3` (number)
    Custom metric 3
    Example: 2.2

  - `custom_metric_4` (number)
    Custom metric 4
    Example: 1.05

  - `custom_metric_5` (number)
    Custom metric 5
    Example: 10000

  - `custom_field_1` (string)
    Field that can be used for custom dimensions
    Example: XYZ

  - `custom_field_2` (string)
    Field that can be used for custom dimensions
    Example: XYZ

  - `custom_field_3` (string)
    Field that can be used for custom dimensions
    Example: XYZ

  - `custom_field_4` (string)
    Field that can be used for custom dimensions
    Example: XYZ

  - `custom_field_5` (string)
    Field that can be used for custom dimensions
    Example: XYZ

  - `source_system` (string)
    Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.
    Example: ABCDEF

## Response 200:

  - `200` (unknown)
    Request has been processed successfully.
**Headers**
- `Content-Type: application/json`

## Response 200 fields (application/json):

  - `status` (string, required)
    Status of the operation OK / Not OK
    Example: OK

  - `msg` (string, required)
    Message describing result of operation
    Example: 1 entity added

## Response 400:

  - `400` (unknown)
    Invalid, malformed or missing JSON-data in request
**Headers**
- `Content-Type: application/json`

## Response 400 fields (application/json):

  - `status` (string, required)
    Status of the operation OK / Not OK
    Example: Not OK

  - `msg` (string, required)
    Message describing result of operation
    Example: Reason for error

## Response 401:

  - `401` (unknown)
    Missing or invalid authorization token in header
**Headers**
- `Content-Type: application/json`

## Response 401 fields (application/json):

  - `status` (string, required)
    Status of the operation OK / Not OK
    Example: Not OK

  - `msg` (string, required)
    Message describing result of operation
    Example: Unauthorized

## Response 500:

  - `500` (unknown)
    Internal error or exception
**Headers**
- `Content-Type: application/json`

## Response 500 fields (application/json):

  - `status` (string, required)
    Status of the operation OK / Not OK
    Example: Not OK

  - `msg` (string, required)
    Message describing result of operation
    Example: Reason for error

## Response 200 examples:

  - `response` (unknown)

## Response 400 examples:

  - `response` (unknown)

## Response 401 examples:

  - `response` (unknown)

## Response 500 examples:

  - `response` (unknown)