WhatTheShop API

Get authentication token from login and password

Headers

Parameters

Name	Type	Required	Description
login	string	Yes	Login
password	string	Yes	Password
isEncryptedPassword	integer	No	Is hashed password

Body

Headers

Response

HTTP 200 OK

{'token':'string'}

GET /1/user/zones

Get available user zones linked to current account

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Body

Headers

Response

HTTP 200 OK

{'result':{'4242':{'id': '4242', 'type':'store', 'name':'My Store', 'fullname':'My Brand - My Store'}}}

GET /1/user/zoneinfos

Get informations about user zone in permission list

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zoneId	string	Yes	Unique identifier of zone (integer)

Body

Headers

Response

HTTP 200 OK

{'result':{'id':'42','type':'store','name':'My Store','fullname':'Ile-de-France - My Store','address':'42, boulevard de démonstration','zipcode':'92240','city':'MALAKOFF','country':'FRA','lat':'48.819615','lon':'2.303562','children':['12','75','145'],'sensors':['1234','4567']}}

GET /1/user/devices

Get the list of devices depending on zones permissions

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Body

Headers

Response

HTTP 200 OK

{'result': {'devices': ['DEV-001', 'DEV-002'], 'auth': {'ts':12345, 'maxDuration':604800, 'cryptToken':['ABCDEFGH', '....']}}}

GET /1/user/monitoring

Get the number of devices up/total and sensors

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
userId	string	Yes	user id
zoneId	string	No	specific zone id to fetch monitoring info from

Body

Headers

Response

HTTP 200 OK

{'result': {'devices': {'on': 10, 'total': 12}, 'sensors': {'total': 3}}}

GET /1/analytic/passerby/count

Retrieve passerby global count and frequency for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'total':7605,'frequent':2045,'low':2444,'new':3116}}

GET /1/analytic/passerby/countdetails

Retrieve passerby per day count and frequency for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'new':{'2016-10-01 00:00:00':793,'2016-10-02 00:00:00':588,'2016-10-03 00:00:00':580,'2016-10-04 00:00:00':790,'2016-10-05 00:00:00':666},'low':{'2016-10-01 00:00:00':466,'2016-10-02 00:00:00':497,'2016-10-03 00:00:00':385,'2016-10-04 00:00:00':552,'2016-10-05 00:00:00':762},'frequent':{'2016-10-01 00:00:00':449,'2016-10-02 00:00:00':291,'2016-10-03 00:00:00':473,'2016-10-04 00:00:00':728,'2016-10-05 00:00:00':743},'all':{'2016-10-01 00:00:00':1708,'2016-10-02 00:00:00':1376,'2016-10-03 00:00:00':1438,'2016-10-04 00:00:00':2070,'2016-10-05 00:00:00':2171}}}

GET /1/analytic/passerby/counthour

Retrieve passerby per hour average for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'00':135.2,'01':126.6,'02':106,'03':104.8,'04':102.4,'05':50.2,'06':28.2,'07':52.4,'08':182.2,'09':248.4,'10':237.4,'11':221.2,'12':261.4,'13':275,'14':255.6,'15':226.4,'16':229.2,'17':247.6,'18':257.2,'19':194.8,'20':170.6,'21':183,'22':161.2,'23':127.2}}

GET /1/analytic/passerby/counthourday

Retrieve passerby per half hour average for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'02':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'03':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'04':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'05':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'06':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'07':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'01':{'00':1,'01':1,'02':1,'03':1,'05':1,'06':2,'07':1,'08':1,'09':1,'10':1,'11':1,'12':1,'13':1,'14':1,'15':1,'16':1,'17':1,'18':1,'19':1,'20':1,'21':2,'22':2,'23':3,'24':2,'25':1,'26':1,'28':1,'29':1,'30':3,'31':3,'32':1,'33':2,'34':3,'35':3,'36':2,'37':1,'38':2,'39':2,'40':1,'41':1,'42':1,'43':1,'44':1,'45':1,'46':1,'47':1,'04':0,'27':0}}}

GET /1/analytic/passerby/countsum

Retrieve passerby per hour total for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'00':135.2,'01':261.8,'02':367.8,'03':472.6,'04':575,'05':625.2,'06':653.4,'07':705.8,'08':888,'09':1136.4,'10':1373.8,'11':1595,'12':1856.4,'13':2131.4,'14':2387,'15':2613.4,'16':2842.6,'17':3090.2,'18':3347.4,'19':3542.2,'20':3712.8,'21':3895.8,'22':4057,'23':4184.2}}

GET /1/analytic/passerby/besttimes

Retrieve time shortest ranges to match 25% and 80% passerby

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'best':{'startTime':'07:35:00','endTime':'23:59:00'}, 'peak':{'startTime':'09:35:00','endTime':'14:59:00'}}}

GET /1/analytic/passerby/countcommon

Count common passerbys between 2 zones

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available
commonZones	array	Yes	JSON-encoded array of extra zones array to consider

Body

Headers

Response

HTTP 200 OK

{'result':704}

GET /1/analytic/passing/count

Retrieve passing global count for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'total':230}}

GET /1/analytic/passing/countdetails

Retrieve passing per day count for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'all':{'2016-10-01 00:00:00':23,'2016-10-02 00:00:00':19,'2016-10-03 00:00:00':33,'2016-10-04 00:00:00':113,'2016-10-05 00:00:00':94}}}

GET /1/analytic/passing/counthourdetails

Retrieve passing per day and hour count for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
period	integer	No	Define custom granularity. Optional - default : 3600
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'all':{'2016-10-01 00:00:00':23,'2016-10-01 01:00:00':19,'2016-10-01 02:00:00':33,'2016-10-01 03:00:00':113,'2016-10-01 04:00:00':94}}}

GET /1/analytic/visitor/count

Retrieve visitor global count and frequency for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'total':230,'frequent':61,'low':53,'new':116}}

GET /1/analytic/visitor/countdetails

Retrieve visitor per day count and frequency for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'low':{'2016-10-01 00:00:00':4,'2016-10-02 00:00:00':1,'2016-10-03 00:00:00':1,'2016-10-04 00:00:00':26,'2016-10-05 00:00:00':23},'all':{'2016-10-01 00:00:00':23,'2016-10-02 00:00:00':19,'2016-10-03 00:00:00':33,'2016-10-04 00:00:00':113,'2016-10-05 00:00:00':94},'frequent':{'2016-10-01 00:00:00':12,'2016-10-02 00:00:00':12,'2016-10-03 00:00:00':19,'2016-10-04 00:00:00':31,'2016-10-05 00:00:00':26},'new':{'2016-10-01 00:00:00':7,'2016-10-02 00:00:00':6,'2016-10-03 00:00:00':13,'2016-10-04 00:00:00':56,'2016-10-05 00:00:00':45}}}

GET /1/analytic/visitor/duration

Retrieve visitor count duration for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-01 00:00:00':1557.8260869565,'2016-10-02 00:00:00':1314.2631578947,'2016-10-03 00:00:00':627.21212121212,'2016-10-04 00:00:00':1317.3805309735,'2016-10-05 00:00:00':1489.5319148936}}

GET /1/analytic/visitor/durationdetails

Retrieve visitor count duration details for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
periods	array	No	JSON-encoded array of periods to consider [0,300,900,1800] by default with 4 values in seconds
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-01 00:00:00':{'0':0.478, '300':0.282, '900':0.124, '1800':0.113}}}

GET /1/analytic/visitor/besttimes

Retrieve time shortest range to match 25% and 80% visitor

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'best':{'startTime':'07:35:00','endTime':'23:59:00'}, 'peak':{'startTime':'09:35:00','endTime':'14:59:00'}}}

GET /1/analytic/visitor/counthour

Retrieve visitor per hour average for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'10': 4.75, '11': 4.2413793103448, '12': 2.7083333333333}}

GET /1/analytic/visitor/counthourday

Retrieve visitor per half hour average for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'02':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'03':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'04':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'05':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'06':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'07':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'01':{'00':1,'01':1,'02':1,'03':1,'05':1,'06':2,'07':1,'08':1,'09':1,'10':1,'11':1,'12':1,'13':1,'14':1,'15':1,'16':1,'17':1,'18':1,'19':1,'20':1,'21':2,'22':2,'23':3,'24':2,'25':1,'26':1,'28':1,'29':1,'30':3,'31':3,'32':1,'33':2,'34':3,'35':3,'36':2,'37':1,'38':2,'39':2,'40':1,'41':1,'42':1,'43':1,'44':1,'45':1,'46':1,'47':1,'04':0,'27':0}}}

GET /1/analytic/visitor/counthourdetails

Retrieve visitor per hour count and frequency for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-01 00:00:00':5,'2016-10-01 01:00:00':2,'2016-10-01 03:00:00':1,'2016-10-01 04:00:00':1,'2016-10-01 05:00:00':2,'2016-10-01 08:00:00':3,'2016-10-01 10:00:00':1,'2016-10-01 11:00:00':1,'2016-10-01 12:00:00':1,'2016-10-01 13:00:00':2,'2016-10-01 15:00:00':1,'2016-10-01 16:00:00':2,'2016-10-01 17:00:00':1,'2016-10-01 18:00:00':3,'2016-10-01 19:00:00':4,'2016-10-01 20:00:00':2,'2016-10-01 21:00:00':2,'2016-10-02 00:00:00':3,'2016-10-02 01:00:00':1,'2016-10-02 02:00:00':1,'2016-10-02 03:00:00':2,'2016-10-02 04:00:00':2,'2016-10-02 08:00:00':2,'2016-10-02 09:00:00':1,'2016-10-02 10:00:00':1,'2016-10-02 13:00:00':1,'2016-10-02 14:00:00':2,'2016-10-02 16:00:00':2,'2016-10-02 17:00:00':3,'2016-10-02 18:00:00':2,'2016-10-02 19:00:00':2,'2016-10-02 20:00:00':1,'2016-10-03 00:00:00':6,'2016-10-03 03:00:00':1,'2016-10-03 06:00:00':1,'2016-10-03 07:00:00':1,'2016-10-03 08:00:00':4,'2016-10-03 09:00:00':1,'2016-10-03 11:00:00':4,'2016-10-03 12:00:00':1,'2016-10-03 13:00:00':2,'2016-10-03 14:00:00':2,'2016-10-03 15:00:00':2,'2016-10-03 16:00:00':2,'2016-10-03 17:00:00':2,'2016-10-03 18:00:00':1,'2016-10-03 20:00:00':1,'2016-10-03 21:00:00':2,'2016-10-03 23:00:00':1,'2016-10-04 00:00:00':7,'2016-10-04 01:00:00':3,'2016-10-04 06:00:00':1,'2016-10-04 07:00:00':3,'2016-10-04 08:00:00':7,'2016-10-04 09:00:00':17,'2016-10-04 10:00:00':10,'2016-10-04 11:00:00':9,'2016-10-04 12:00:00':16,'2016-10-04 13:00:00':8,'2016-10-04 14:00:00':3,'2016-10-04 15:00:00':2,'2016-10-04 16:00:00':3,'2016-10-04 17:00:00':1,'2016-10-04 18:00:00':3,'2016-10-04 19:00:00':3,'2016-10-04 20:00:00':24,'2016-10-04 21:00:00':13,'2016-10-04 22:00:00':11,'2016-10-04 23:00:00':5,'2016-10-05 00:00:00':14,'2016-10-05 01:00:00':5,'2016-10-05 02:00:00':3,'2016-10-05 03:00:00':2,'2016-10-05 04:00:00':3,'2016-10-05 06:00:00':1,'2016-10-05 07:00:00':1,'2016-10-05 08:00:00':6,'2016-10-05 09:00:00':13,'2016-10-05 10:00:00':6,'2016-10-05 11:00:00':6,'2016-10-05 12:00:00':2,'2016-10-05 13:00:00':2,'2016-10-05 14:00:00':7,'2016-10-05 15:00:00':2,'2016-10-05 16:00:00':10,'2016-10-05 17:00:00':5,'2016-10-05 18:00:00':12,'2016-10-05 19:00:00':6,'2016-10-05 20:00:00':4,'2016-10-05 21:00:00':4,'2016-10-05 22:00:00':4,'2016-10-05 23:00:00':3}}

GET /1/analytic/visitor/counthourdaystart

Retrieve visit start per hour count and frequency for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-01 00:00:00':5,'2016-10-01 01:00:00':2,'2016-10-01 03:00:00':1,'2016-10-01 04:00:00':1,'2016-10-01 05:00:00':2,'2016-10-01 08:00:00':3,'2016-10-01 10:00:00':1,'2016-10-01 11:00:00':1,'2016-10-01 12:00:00':1,'2016-10-01 13:00:00':2,'2016-10-01 15:00:00':1,'2016-10-01 16:00:00':2,'2016-10-01 17:00:00':1,'2016-10-01 18:00:00':3,'2016-10-01 19:00:00':4,'2016-10-01 20:00:00':2,'2016-10-01 21:00:00':2,'2016-10-02 00:00:00':3,'2016-10-02 01:00:00':1,'2016-10-02 02:00:00':1,'2016-10-02 03:00:00':2,'2016-10-02 04:00:00':2,'2016-10-02 08:00:00':2,'2016-10-02 09:00:00':1,'2016-10-02 10:00:00':1,'2016-10-02 13:00:00':1,'2016-10-02 14:00:00':2,'2016-10-02 16:00:00':2,'2016-10-02 17:00:00':3,'2016-10-02 18:00:00':2,'2016-10-02 19:00:00':2,'2016-10-02 20:00:00':1,'2016-10-03 00:00:00':6,'2016-10-03 03:00:00':1,'2016-10-03 06:00:00':1,'2016-10-03 07:00:00':1,'2016-10-03 08:00:00':4,'2016-10-03 09:00:00':1,'2016-10-03 11:00:00':4,'2016-10-03 12:00:00':1,'2016-10-03 13:00:00':2,'2016-10-03 14:00:00':2,'2016-10-03 15:00:00':2,'2016-10-03 16:00:00':2,'2016-10-03 17:00:00':2,'2016-10-03 18:00:00':1,'2016-10-03 20:00:00':1,'2016-10-03 21:00:00':2,'2016-10-03 23:00:00':1,'2016-10-04 00:00:00':7,'2016-10-04 01:00:00':3,'2016-10-04 06:00:00':1,'2016-10-04 07:00:00':3,'2016-10-04 08:00:00':7,'2016-10-04 09:00:00':17,'2016-10-04 10:00:00':10,'2016-10-04 11:00:00':9,'2016-10-04 12:00:00':16,'2016-10-04 13:00:00':8,'2016-10-04 14:00:00':3,'2016-10-04 15:00:00':2,'2016-10-04 16:00:00':3,'2016-10-04 17:00:00':1,'2016-10-04 18:00:00':3,'2016-10-04 19:00:00':3,'2016-10-04 20:00:00':24,'2016-10-04 21:00:00':13,'2016-10-04 22:00:00':11,'2016-10-04 23:00:00':5,'2016-10-05 00:00:00':14,'2016-10-05 01:00:00':5,'2016-10-05 02:00:00':3,'2016-10-05 03:00:00':2,'2016-10-05 04:00:00':3,'2016-10-05 06:00:00':1,'2016-10-05 07:00:00':1,'2016-10-05 08:00:00':6,'2016-10-05 09:00:00':13,'2016-10-05 10:00:00':6,'2016-10-05 11:00:00':6,'2016-10-05 12:00:00':2,'2016-10-05 13:00:00':2,'2016-10-05 14:00:00':7,'2016-10-05 15:00:00':2,'2016-10-05 16:00:00':10,'2016-10-05 17:00:00':5,'2016-10-05 18:00:00':12,'2016-10-05 19:00:00':6,'2016-10-05 20:00:00':4,'2016-10-05 21:00:00':4,'2016-10-05 22:00:00':4,'2016-10-05 23:00:00':3}}

GET /1/analytic/visitor/countsum

Retrieve visitor per hour count sum for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'00':7.2,'01':10.4,'03':13,'04':14.2,'05':14.8,'06':15.6,'08':22.2,'10':35.8,'11':40.6,'12':46,'13':50.6,'14':54.4,'15':56.6,'16':60.6,'17':64.2,'18':69.2,'19':73.2,'20':80.6,'21':87.8,'22':91.8,'02':11.8,'09':30.2,'07':16.6,'23':94.2}}

GET /1/analytic/visitor/countcommon

Count common visitors between 2 zones

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available
commonZones	array	Yes	JSON-encoded array of extra zones array to consider

Body

Headers

Response

HTTP 200 OK

{'result':704}

GET /1/analytic/visit/count

Retrieve visit global count for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'total':230}}

GET /1/analytic/visit/countdetails

Retrieve visit per day count for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'all':{'2016-10-01 00:00:00':23,'2016-10-02 00:00:00':19,'2016-10-03 00:00:00':33,'2016-10-04 00:00:00':113,'2016-10-05 00:00:00':94}}}

GET /1/analytic/visit/counthourdetails

Retrieve visit per day and hour count for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
period	integer	No	Define custom granularity. Optional - default : 3600
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'all':{'2016-10-01 00:00:00':23,'2016-10-01 01:00:00':19,'2016-10-01 02:00:00':33,'2016-10-01 03:00:00':113,'2016-10-01 04:00:00':94}}}

GET /1/analytic/visit/duration

Retrieve visit count duration for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-01 00:00:00':1557.8260869565,'2016-10-02 00:00:00':1314.2631578947,'2016-10-03 00:00:00':627.21212121212,'2016-10-04 00:00:00':1317.3805309735,'2016-10-05 00:00:00':1489.5319148936}}

GET /1/analytic/visit/durationdetails

Retrieve visit count duration details for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
periods	array	No	JSON-encoded array of periods to consider [0,300,900,1800] by default with 4 values in seconds
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-01 00:00:00':{'0':0.478, '300':0.282, '900':0.124, '1800':0.113}}}

GET /1/analytic/visit/counthour

Retrieve visit per hour average for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'10': 4.75, '11': 4.2413793103448, '12': 2.7083333333333}}

GET /1/analytic/visit/counthourday

Retrieve visit per half hour average for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'02':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'03':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'04':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'05':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'06':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'07':{'00':0,'01':0,'02':0,'03':0,'04':0,'05':0,'06':0,'07':0,'08':0,'09':0,'10':0,'11':0,'12':0,'13':0,'14':0,'15':0,'16':0,'17':0,'18':0,'19':0,'20':0,'21':0,'22':0,'23':0,'24':0,'25':0,'26':0,'27':0,'28':0,'29':0,'30':0,'31':0,'32':0,'33':0,'34':0,'35':0,'36':0,'37':0,'38':0,'39':0,'40':0,'41':0,'42':0,'43':0,'44':0,'45':0,'46':0,'47':0},'01':{'00':1,'01':1,'02':1,'03':1,'05':1,'06':2,'07':1,'08':1,'09':1,'10':1,'11':1,'12':1,'13':1,'14':1,'15':1,'16':1,'17':1,'18':1,'19':1,'20':1,'21':2,'22':2,'23':3,'24':2,'25':1,'26':1,'28':1,'29':1,'30':3,'31':3,'32':1,'33':2,'34':3,'35':3,'36':2,'37':1,'38':2,'39':2,'40':1,'41':1,'42':1,'43':1,'44':1,'45':1,'46':1,'47':1,'04':0,'27':0}}}

GET /1/analytic/visit/counthourdaystart

Retrieve visit start per hour count and frequency for selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-01 00:00:00':5,'2016-10-01 01:00:00':2,'2016-10-01 03:00:00':1,'2016-10-01 04:00:00':1,'2016-10-01 05:00:00':2,'2016-10-01 08:00:00':3,'2016-10-01 10:00:00':1,'2016-10-01 11:00:00':1,'2016-10-01 12:00:00':1,'2016-10-01 13:00:00':2,'2016-10-01 15:00:00':1,'2016-10-01 16:00:00':2,'2016-10-01 17:00:00':1,'2016-10-01 18:00:00':3,'2016-10-01 19:00:00':4,'2016-10-01 20:00:00':2,'2016-10-01 21:00:00':2,'2016-10-02 00:00:00':3,'2016-10-02 01:00:00':1,'2016-10-02 02:00:00':1,'2016-10-02 03:00:00':2,'2016-10-02 04:00:00':2,'2016-10-02 08:00:00':2,'2016-10-02 09:00:00':1,'2016-10-02 10:00:00':1,'2016-10-02 13:00:00':1,'2016-10-02 14:00:00':2,'2016-10-02 16:00:00':2,'2016-10-02 17:00:00':3,'2016-10-02 18:00:00':2,'2016-10-02 19:00:00':2,'2016-10-02 20:00:00':1,'2016-10-03 00:00:00':6,'2016-10-03 03:00:00':1,'2016-10-03 06:00:00':1,'2016-10-03 07:00:00':1,'2016-10-03 08:00:00':4,'2016-10-03 09:00:00':1,'2016-10-03 11:00:00':4,'2016-10-03 12:00:00':1,'2016-10-03 13:00:00':2,'2016-10-03 14:00:00':2,'2016-10-03 15:00:00':2,'2016-10-03 16:00:00':2,'2016-10-03 17:00:00':2,'2016-10-03 18:00:00':1,'2016-10-03 20:00:00':1,'2016-10-03 21:00:00':2,'2016-10-03 23:00:00':1,'2016-10-04 00:00:00':7,'2016-10-04 01:00:00':3,'2016-10-04 06:00:00':1,'2016-10-04 07:00:00':3,'2016-10-04 08:00:00':7,'2016-10-04 09:00:00':17,'2016-10-04 10:00:00':10,'2016-10-04 11:00:00':9,'2016-10-04 12:00:00':16,'2016-10-04 13:00:00':8,'2016-10-04 14:00:00':3,'2016-10-04 15:00:00':2,'2016-10-04 16:00:00':3,'2016-10-04 17:00:00':1,'2016-10-04 18:00:00':3,'2016-10-04 19:00:00':3,'2016-10-04 20:00:00':24,'2016-10-04 21:00:00':13,'2016-10-04 22:00:00':11,'2016-10-04 23:00:00':5,'2016-10-05 00:00:00':14,'2016-10-05 01:00:00':5,'2016-10-05 02:00:00':3,'2016-10-05 03:00:00':2,'2016-10-05 04:00:00':3,'2016-10-05 06:00:00':1,'2016-10-05 07:00:00':1,'2016-10-05 08:00:00':6,'2016-10-05 09:00:00':13,'2016-10-05 10:00:00':6,'2016-10-05 11:00:00':6,'2016-10-05 12:00:00':2,'2016-10-05 13:00:00':2,'2016-10-05 14:00:00':7,'2016-10-05 15:00:00':2,'2016-10-05 16:00:00':10,'2016-10-05 17:00:00':5,'2016-10-05 18:00:00':12,'2016-10-05 19:00:00':6,'2016-10-05 20:00:00':4,'2016-10-05 21:00:00':4,'2016-10-05 22:00:00':4,'2016-10-05 23:00:00':3}}

GET /1/analytic/record/visitor

Retrieve visitor record date on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-04 00:00:00':'113'}}

GET /1/analytic/record/visit

Retrieve visit record date on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-04 00:00:00':'113'}}

GET /1/analytic/record/day

Retrieve visitor record day on period - alias of record/visitorday

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'4':94,'3':113,'2':33,'1':19,'7':23}}

GET /1/analytic/record/visitday

Retrieve visit record day on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'4':94,'3':113,'2':33,'1':19,'7':23}}

GET /1/analytic/record/time

Retrieve visitor record time on period - alias of record/visitortime

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'20:40':19}}

GET /1/analytic/record/passerby

Retrieve passerby record date on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-04 00:00:00':'113'}}

GET /1/analytic/record/passerbyday

Retrieve passerby record day on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'4':94,'3':113,'2':33,'1':19,'7':23}}

GET /1/analytic/record/passerbytime

Retrieve passerby record time on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'20:40':19}}

GET /1/analytic/instore/count

Retrieve instore count on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'connect':1,'email':1,'optinNewsletter':1}}

GET /1/analytic/instore/countnew

Retrieve instore new users count on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'connect':1,'email':1,'optinNewsletter':1}}

GET /1/analytic/instore/countdetails

Retrieve instore details count on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-03 00:00:00':{'connect':1,'email':1,'optinNewsletter':1}}}

GET /1/analytic/instore/duration

Retrieve instore visit duration count on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-03 00:00:00':'61.0000'}}

GET /1/analytic/instore/pageview

Retrieve instore page views on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'2016-10-03 00:00:00':'5.0000'}}

GET /1/analytic/instore/subscribe

Retrieve instore subscribe method count on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'email':2,'facebook':0,'google':0,'twitter':0}}

GET /1/analytic/instore/users

Retrieve instore users on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'email':2,'facebook':0,'google':0,'twitter':0}}

GET /1/analytic/instore/opinions

Retrieve instore opinions on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'email':2,'facebook':0,'google':0,'twitter':0}}

GET /1/analytic/instore/gains

Retrieve instore gains on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'email':2,'facebook':0,'google':0,'twitter':0}}

GET /1/analytic/zone/general

Retrieve zone general statistics

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'percentage':0,'cnt':'230 \/ 0 \/ 230','average':1,'min':'DEV-001','max':'DEV-001'}}

GET /1/analytic/zone/venn

Retrieve zone visits

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'DEV-001':109, 'DEV-002':210, 'DEV-001#DEV-002':18, 'N/A':0}}

GET /1/analytic/zone/sankey

Retrieve zone sankey

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
firstDeviceId	string	No	Defines the deviceId of the central device in store (ex: DEV-001)
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'inputs':[{'deviceId':'input','count':282}],'outputs':[{'deviceId':'output','count':282}],'deviceId':'DEV-001'}}

GET /1/analytic/raw/passerby

Fetch raw passerby datas on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
excludeLocalUsers	integer	No	(Internal) Only retrieve local mac addresses
striptUid	integer	No	(Internal) Remove every tUid from result
doNotEncryptUID	integer	No	(Internal) Do not encrypt tUid
useCache	integer	No	(Internal) Use cache data if available
page	integer	No	(Internal) Use pagination for huge set of result

Body

Headers

Response

HTTP 200 OK

{'result':[{'uid': '', 'dateStart': '2016-09-01 18:35:00', 'dateEnd': '2016-09-01 18:45:00', 'frequency': '', 'maxProximity':20}]}

GET /1/analytic/raw/visitor

Fetch raw visitor datas on period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
excludeLocalUsers	integer	No	(Internal) Only retrieve local mac addresses
striptUid	integer	No	(Internal) Remove every tUid from result
doNotEncryptUID	integer	No	(Internal) Do not encrypt tUid
dismissMaxVisitDuration	integer	No	(Internal) Dismiss the maximum visit duration filtering
useCache	integer	No	(Internal) Use cache data if available
page	integer	No	(Internal) Use pagination for huge set of result

Body

Headers

Response

HTTP 200 OK

{'result':[{'uid': '', 'dateStart': '2016-09-01 18:35:00', 'dateEnd': '2016-09-01 18:45:00', 'frequency': '', 'maxProximity':20}]}

GET /1/analytic/raw/visitorLight

Fetch raw visitor dateSeen by dateDay and uid

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
excludeLocalUsers	integer	No	(Internal) Only retrieve local mac addresses
striptUid	integer	No	(Internal) Remove every tUid from result
doNotEncryptUID	integer	No	(Internal) Do not encrypt tUid
dismissMaxVisitDuration	integer	No	(Internal) Dismiss the maximum visit duration filtering
useCache	integer	No	(Internal) Use cache data if available
page	integer	No	(Internal) Use pagination for huge set of result

Body

Headers

Response

HTTP 200 OK

{'result':[{'uid': '', 'dateStart': '2016-09-01 18:35:00', 'dateEnd': '2016-09-01 18:45:00'}]}

GET /1/analytic/raw/visitorMacList

Fetch raw visitor macList

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
excludeLocalUsers	integer	No	(Internal) Only retrieve local mac addresses
striptUid	integer	No	(Internal) Remove every tUid from result
doNotEncryptUID	integer	No	(Internal) Do not encrypt tUid
dismissMaxVisitDuration	integer	No	(Internal) Dismiss the maximum visit duration filtering
useCache	integer	No	(Internal) Use cache data if available
page	integer	No	(Internal) Use pagination for huge set of result

Body

Headers

Response

HTTP 200 OK

{'result':[{'userMac': 'xxx'}]}

GET /1/analytic/raw/passerbyMacList

Fetch raw passerby macList

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
excludeLocalUsers	integer	No	(Internal) Only retrieve local mac addresses
striptUid	integer	No	(Internal) Remove every tUid from result
doNotEncryptUID	integer	No	(Internal) Do not encrypt tUid
dismissMaxVisitDuration	integer	No	(Internal) Dismiss the maximum visit duration filtering
useCache	integer	No	(Internal) Use cache data if available
page	integer	No	(Internal) Use pagination for huge set of result

Body

Headers

Response

HTTP 200 OK

{'result':[{'userMac': 'xxx'}]}

GET /1/analytic/devices/count

Retrieve OS count dispatch on selected period

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode
useCache	integer	No	(Internal) Use cache data if available

Body

Headers

Response

HTTP 200 OK

{'result':{'android':'94','ios':'72','wp':'2'}}

GET /1/analytic/system/lastupdate

Get the date of last update date

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode

Body

Headers

Response

HTTP 200 OK

{'result':{'date':'2016-09-01 18:35:00'}}

GET /1/analytic/system/quicklastupdate

Get the date of last update date without using TMP tables

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode

Body

Headers

Response

HTTP 200 OK

{'result':{'date':'2016-09-01 18:35:00'}}

GET /1/analytic/system/forceRefresh

Force the temporary table refresh

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode

Body

Headers

Response

HTTP 200 OK

{'result':true}

GET /1/analytic/system/temporaryTable

Retrieve temporary table infos

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
days	array	Yes	JSON-encoded array of days to consider [1..7] (1 = Sunday, 2 = Monday, …, 7 = Saturday). Examples: - All days: [] - Sunday, Monday, Wednesday, Saturday: [1, 2, 3, 7]
openingTimes	integer	Yes	Defines if point of sale opening times need to be consider or not. Explanations: - 1: Consider opening times - 0: Do not consider opening times
frequency	string	No	Frequency mode to consider from new, low and frequent. Default value is empty in order to retrieve every frequency modes. Explanations: - new: Only retrieve entries never seen before - low: Only retrieve entries with low captation frequency - frequent: Only retrieve entries with frequent captation frequency - [empty]: Retrieve every frequency modes
openings	array	No	(Internal) JSON-encoded array of openings
precountParams	array	No	(Internal) JSON-encoded array of precount parameters
temporaryParams	array	No	(Internal) JSON-encoded array of temporary parameters
strict	integer	No	(Internal) Strict mode is used to wait for fully loaded precount tables
debug	integer	No	(Internal) debug mode

Body

Headers

Response

HTTP 200 OK

{'result':true}

GET /1/media/visit/count

Retrieve visit global count for selected period and zone

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss

Body

Headers

Response

HTTP 200 OK

{'result':{'facebook':7605,'google':2045,'teemo':2444}}

GET /1/media/visit/countdetails

Retrieve visit detailed count for selected period and zone

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss

Body

Headers

Response

HTTP 200 OK

{'result':{'facebook':{'2016-10-01 00:00:00':793,'2016-10-02 00:00:00':588,'2016-10-03 00:00:00':580,'2016-10-04 00:00:00':790,'2016-10-05 00:00:00':666},'google':{'2016-10-01 00:00:00':466,'2016-10-02 00:00:00':497,'2016-10-03 00:00:00':385,'2016-10-04 00:00:00':552,'2016-10-05 00:00:00':762},'teemo':{'2016-10-01 00:00:00':449,'2016-10-02 00:00:00':291,'2016-10-03 00:00:00':473,'2016-10-04 00:00:00':728,'2016-10-05 00:00:00':743}}}

GET /1/media/campaign/list

Retrieve the list of available campaigns for period and zones

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss

Body

Headers

Response

HTTP 200 OK

{'result':['Campaign 1', 'Campaign 2']}

GET /1/media/campaign/count

Retrieve count of given campaign for period and zones

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zones	array	Yes	JSON-encoded array of zones to consider
startDate	string	Yes	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	Yes	End date of period. Format : YYYY-MM-DD hh:mm:ss
campaign	string	Yes	CampaignId of campaign to retrieve
minTargetDuration	integer	No	Minimum target duration

Body

Headers

Response

HTTP 200 OK

{'result':{'total':7605,'confirmed':2045,'target':2444,'target-duration':54}}

GET /1/analytic/sensor/count

Get the total count for period of presence / in / out

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zoneId	integer	No	Primary zone ID
deviceId	string	No	Device ID
startDate	string	No	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	No	End date of period. Format : YYYY-MM-DD hh:mm:ss
ignoreOpenings	integer	No	If sensorConfiguration is set in automatic opening times mode, this option permits to dismiss it before calculation
mode	string	No	Default is all, accepted options are all \| presence \| in \| out
ignoreConstraints	bool	No	Default is false, If true returns real presence value

Body

Headers

Response

HTTP 200 OK

{'result':{'presence':{'value':0,'maxValue':'1000','lastUpdate':'2020-12-25 00:00:00'},'in':{'value':0},'out':{'value':0}}}

GET /1/analytic/sensor/countdetails

Get the detailed count for period of presence / in / out

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zoneId	integer	No	Primary zone ID
deviceId	string	No	Device ID
startDate	string	No	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	No	End date of period. Format : YYYY-MM-DD hh:mm:ss
period	integer	No	Period length in seconds
ignoreOpenings	integer	No	If sensorConfiguration is set in automatic opening times mode, this option permits to dismiss it before calculation
mode	string	No	Default is all, accepted options are all \| presence \| in \| out

Body

Headers

Response

HTTP 200 OK

{'result':{'presence':{'2021-02-04 00:00:00':0,'2021-02-04 01:00:00':0,'2021-02-04 02:00:00':0,'2021-02-04 03:00:00':0,'2021-02-04 04:00:00':0,'2021-02-04 05:00:00':0,'2021-02-04 06:00:00':0,'2021-02-04 07:00:00':0,'2021-02-04 08:00:00':0,'2021-02-04 09:00:00':267,'2021-02-04 10:00:00':267},'in':{'2021-02-04 00:00:00':0,'2021-02-04 01:00:00':0,'2021-02-04 02:00:00':0,'2021-02-04 03:00:00':0,'2021-02-04 04:00:00':0,'2021-02-04 05:00:00':0,'2021-02-04 06:00:00':0,'2021-02-04 07:00:00':0,'2021-02-04 08:00:00':0,'2021-02-04 09:00:00':267,'2021-02-04 10:00:00':0},'out':{'2021-02-04 00:00:00':0,'2021-02-04 01:00:00':0,'2021-02-04 02:00:00':0,'2021-02-04 03:00:00':0,'2021-02-04 04:00:00':0,'2021-02-04 05:00:00':0,'2021-02-04 06:00:00':0,'2021-02-04 07:00:00':0,'2021-02-04 08:00:00':0,'2021-02-04 09:00:00':0,'2021-02-04 10:00:00':0}}}

GET /1/analytic/sensor/countRaw

Get the total count for period of in / out for given sensor

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
sensorId	integer	No	Primary sensor ID
hardwareId	string	No	Computation of sensor type (camera / ir) and hardwareId separated by ':'
startDate	string	No	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	No	End date of period. Format : YYYY-MM-DD hh:mm:ss
mode	string	No	Default is all, accepted options are all \| in \| out
useOpenings	integer	No	Use the first sensor configuration in exploitation for opening times calculation

Body

Headers

Response

HTTP 200 OK

{'result':{'in':{'value':0},'out':{'value':0}}}

GET /1/analytic/sensor/countdetailsRaw

Get the detailed count for period of in / out for given sensor

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
sensorId	integer	No	Primary sensor ID
hardwareId	string	No	Computation of sensor type (camera / ir) and hardwareId separated by ':'
startDate	string	No	Start date of period. Format : YYYY-MM-DD hh:mm:ss
endDate	string	No	End date of period. Format : YYYY-MM-DD hh:mm:ss
period	integer	No	Period length in seconds
mode	string	No	Default is all, accepted options are all \| in \| out
useOpenings	integer	No	Use the first sensor configuration in exploitation for opening times calculation

Body

Headers

Response

HTTP 200 OK

{'result':{'in':{'2021-02-04 00:00:00':0,'2021-02-04 01:00:00':0,'2021-02-04 02:00:00':0,'2021-02-04 03:00:00':0,'2021-02-04 04:00:00':0,'2021-02-04 05:00:00':0,'2021-02-04 06:00:00':0,'2021-02-04 07:00:00':0,'2021-02-04 08:00:00':0,'2021-02-04 09:00:00':267,'2021-02-04 10:00:00':0},'out':{'2021-02-04 00:00:00':0,'2021-02-04 01:00:00':0,'2021-02-04 02:00:00':0,'2021-02-04 03:00:00':0,'2021-02-04 04:00:00':0,'2021-02-04 05:00:00':0,'2021-02-04 06:00:00':0,'2021-02-04 07:00:00':0,'2021-02-04 08:00:00':0,'2021-02-04 09:00:00':0,'2021-02-04 10:00:00':0}}}

POST /1/analytic/sensor/setMaxPeople

Setup a new value for maximum people inside the room

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zoneId	integer	No	Primary zone ID
deviceId	string	No	Device ID
maxPeople	integer	Yes	New value for maxPeople

Body

Headers

Response

HTTP 200 OK

{'result':true}

POST /1/analytic/sensor/setValue

Setup a new value for maximum people inside the room

Headers

Name	Type	Required	Description
wts_token	string	Yes	Authentication token

Parameters

Name	Type	Required	Description
zoneId	integer	No	Primary zone ID
deviceId	string	No	Device ID
value	integer	Yes	New absolute value to set for presence count
date	string	No	Date of given value (default is now). Format : YYYY-MM-DD hh:mm:ss

Body

Headers

Response

HTTP 200 OK

{'result':true}

Api URL

User

Analytic - passerby

Analytic - passing

Analytic - visitor

Analytic - visit

Analytic - record

Analytic - instore

Analytic - zones

Analytic - raw

Analytic - device

Analytic - System

Media - Visits

Media - Campaign

Analytic - sensor