Skip to content

Visitors

Visitor count information from anti-theft gates or camera systems. Five different types of visitors can be reported: visitors coming in, visitors going out, visitors passing by, visitor average occupancy and visitor average visit time.

You can also send data for visiting cars & bicycles for all of these five metrics but default is people.

Visitor data can be sent either on store or department level. If department is empty visitors are considered to be entering/leaving/passing/visiting store. If department is specified then visitor entry is considered to be person moving inside the store.

When showing visitor counts on portal store-level visitor counts are used, unless data is viewed on department level.

Operations

Upload list of visitors

Request

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

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
organisation_idstringrequired

Organisation/Store ID

Example:"540"
department_idstring

Department ID

Example:"540"
counter_idstring

Counter ID

Example:"540"
product_idstring

Optional product id associated to this visitor (eg. ticket)

Example:"ABC-123"
customer_idstring

Optional customer associated to this visitor (ticket etc.)

Example:"1234"
datestringrequired

Date of visit (yyyy-mm-dd)

Example:"2016-01-01"
timestringrequired

Time of visit (HH:mm:ss)

Example:"15:00:00"
time_zonestring

Optional location time zone.

Example:"02:00"
visit_typestring

Type of visitor record ('in', 'out', 'pass', 'occupancy', 'visit_time', 'queue')

Example:"in"
vehicle_typestring

Optional field for vehicle type. Supported values are car & bicycle.

Example:"car"
queue_area_namestring

Optional area name for queue cameras.

Example:"Area 1"
low_queuenumber

Threshold for low queue.

Example:1
high_queuenumber

Threshold for high queue.

Example:5
visitorsnumberrequired

Number of visitors at given time

Example:1000
custom_metric_1number

Custom metric 1

Example:1
custom_metric_2number

Custom metric 2

Example:100
custom_metric_3number

Custom metric 3

Example:2.2
custom_metric_4number

Custom metric 4

Example:1.05
custom_metric_5number

Custom metric 5

Example:10000
custom_field_1string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_2string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_3string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_4string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_5string

Field that can be used for custom dimensions

Example:"XYZ"
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/visitors?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organisation_id": "540",
    "department_id": "540",
    "counter_id": "540",
    "product_id": "ABC-123",
    "customer_id": "1234",
    "date": "2016-01-01",
    "time": "15:00:00",
    "time_zone": "02:00",
    "visit_type": "in",
    "vehicle_type": "car",
    "queue_area_name": "Area 1",
    "low_queue": 1,
    "high_queue": 5,
    "visitors": 1000,
    "custom_metric_1": 1,
    "custom_metric_2": 100,
    "custom_metric_3": 2.2,
    "custom_metric_4": 1.05,
    "custom_metric_5": 10000,
    "custom_field_1": "XYZ",
    "custom_field_2": "XYZ",
    "custom_field_3": "XYZ",
    "custom_field_4": "XYZ",
    "custom_field_5": "XYZ",
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
statusstringrequired

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}