Skip to content
/
Download visitors as JSON

Download visitors as JSON

Request

GET https://api.zoined.com/v2/download/visitors.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
startstring

Return data starting from given date

Example:start=2017-01-01
endstring

Return data ending to given date

Example:end=2017-01-31
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/visitors.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
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"
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"
visitorsnumberrequired

Number of visitors at given time

Example:1000
queue_area_namestring

For a queue camera, the name of the queue area

Example:"Area 1"
low_queuenumber

Threshold for low queue.

Example:1
high_queuenumber

Threshold for high queue.

Example:5
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"
Response
{
  "organisation_id": "540",
  "department_id": "540",
  "counter_id": "540",
  "product_id": "ABC-123",
  "date": "2016-01-01",
  "time": "15:00:00",
  "time_zone": "02:00",
  "visit_type": "in",
  "vehicle_type": "car",
  "visitors": 1000,
  "queue_area_name": "Area 1",
  "low_queue": 1,
  "high_queue": 5,
  "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"
}