Visitor demographics

Returns list of visitor demographics in the system. Returned data can be limited with start and end query parameters.

Operations

Download visitor demographics as JSON

Request

GET https://api.zoined.com/v2/download/visitorDemographics.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/visitorDemographics.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"

visitor_idstring

Visitor ID

Example:"540"

datestringrequired

Date of visit (yyyy-mm-dd)

Example:"2016-01-01"

timestringrequired

Time of visit (HH:mm:ss)

Example:"15:00:00"

genderstring

Gender of visitor. 'm' for male, 'f' for female and 'u' for unknown.

Example:"m"

agenumber

Age of the visitor.

Example:25

visitorsnumberrequired

Number of visitors for given age & gender for time specified.

Example:1000

Response

{
  "organisation_id": "540",
  "department_id": "540",
  "counter_id": "540",
  "visitor_id": "540",
  "date": "2016-01-01",
  "time": "15:00:00",
  "gender": "m",
  "age": 25,
  "visitors": 1000
}