Visitor demographics

Visitor demographics endpoint can be used to send data for detected visitor's age and gender.

Demographic data is usually obtained with different (camera) system, and only for part of the visitors. This API endpoint allows sending of the data separately, so that we can then combine data with visitor information.

Our analytics backend will use combined data to project gender & age group estimates into actual visitor counts.

Operations

Upload list of visitor demographics

Request

POST https://api.zoined.com/visitorDemographics?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"

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

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/visitorDemographics?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",
    "date": "2016-01-01",
    "time": "15:00:00",
    "gender": "m",
    "age": 25,
    "visitors": 1000,
    "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"
}