Visits | PoweredLocal API

PoweredLocal API

Welcome to our API documentation Devices Networks Pages VisitsVisitors Uploads

https://api.poweredlocal.com/v1/visits/{id}

View a list of visits for specific login page

Parameters:

Context	Name	Type	Description	Required
path	id	string		yes
form	id	string	Page ID	no

Response codes:

HTTP code	Reason	Response model
200	Returned when successful	AppBundle.Entity.Visit
404	Visit not found	N/A
500	Authorization error or any other problem	N/A

https://api.poweredlocal.com/v1/visits/{id}/stats/age

Visit statistics by age and gender

Parameters:

Context	Name	Type	Description	Required
path	id	string		yes
form	id	string	Page ID	no
form	minimum_ts	string	Timestamp of the period start	no
form	maximum_ts	string	Timestamp of the period end	no

Response codes:

HTTP code	Reason	Response model
200	Returned when successful	N/A
404	Visit not found	N/A
500	Authorization error or any other problem	N/A

https://api.poweredlocal.com/v1/visits/{id}/stats/gender

Visit statistics by gender

Parameters:

Context	Name	Type	Description	Required
path	id	string		yes
form	id	string	Page ID	no
form	minimum_ts	string	Timestamp of the period start	no
form	maximum_ts	string	Timestamp of the period end	no

Response codes:

HTTP code	Reason	Response model
200	Returned when successful	N/A
404	Visit not found	N/A
500	Authorization error or any other problem	N/A

https://api.poweredlocal.com/v1/visits/{id}/stats/returning

Visit statistics by returning/first-time visitors

Parameters:

Context	Name	Type	Description	Required
path	id	string		yes
form	id	string	Page ID	no
form	minimum_ts	string	Timestamp of the period start	no
form	maximum_ts	string	Timestamp of the period end	no

Response codes:

HTTP code	Reason	Response model
200	Returned when successful	N/A
404	Visit not found	N/A
500	Authorization error or any other problem	N/A

https://api.poweredlocal.com/v1/visits/{id}/stats/type

Visit statistics by login type

Parameters:

Context	Name	Type	Description	Required
path	id	string		yes
form	id	string	Page ID	no
form	minimum_ts	string	Timestamp of the period start	no
form	maximum_ts	string	Timestamp of the period end	no

Response codes:

HTTP code	Reason	Response model
200	Returned when successful	N/A
404	Visit not found	N/A
500	Authorization error or any other problem	N/A

AppBundle.Entity.Visitor

Visitor who made this visit

Properties:

Type	Description	Format
integer	Visitors unique Id	int32
string	Full name of the visitor
string	Internal ID (class) of the login implementation
string	User's ID in the social network (underlying system)
string	Birth date of the visitor, if known	date-time
string	Visitor's email address, if known
string	Visitor's phone number, if known
string	Visitor's home city, if known
boolean	Visitor's gender, if known
string	Link to the social profile, if applicable
integer	Estimated visitor social reach (friend count, followers, etc)	int32
string	Timestamp when the visitor was created	date-time
string	Timestamp when the visitor was last modified	date-time

AppBundle.Entity.Visit

Properties:

Type	Description	Format

string	MAC address from which the visit was made
string	ID of the wi-fi access point
integer	Client device type (eg. desktop)	int32
string	Login button type used (eg. Email, FacebookCheckIn, etc)
string	Access point session ID
string
integer	integer	int32
string	Id of the page where this visit occurred
integer	Unique visit Id	int32
boolean	First visit of this visitor at this page
string	Access point session ID
string	Timestamp when the visit was created	date-time