Guests
List
List of Guest [ids] that have connected through the login experience
GET /api/social-user-list
Auth [Identifier], Scope [User]
Params
Name | Required | Type | Default | Comment |
---|---|---|---|---|
identifier | yes | string | ||
location_ids | yes | string | ||
campaign_id | no | integer | ||
from_date | yes | string | ||
to_date | yes | string | ||
social_network | no | string |
Notes:
location_ids
The location_ids is either a single location_id integer or a comma separated list of location_idsfrom_date
The from_date format should be YYY-MM-DDto_date
The to_date format should be YYY-MM-DDfrom_date
to_date
The range between the from_date to to_date cannot be greater than 90 dayssocial_network
The social_network should be from this string option list: FBUser, Cuser, IGuser, TWuser, Twilio, FWuser, Muser
Success [200]
{
"status": "success",
"data": [
“social_user_id”:”[social_user_id]",
“location_id”:”[location_id”],
“campaign_id”:”[campaign-id]”,
“added_datetime”:”[datetime]”
]
}
Error [400]
{
"status": "error",
"message": {
[error_msgs]
}
}
Profiles
Retrieve Guest Profile(s) data for one or multiple Guest(s) that have connected through the login experience
GET /api/get-social-user-profile
Auth [Identifier], Scope [SocialUser]
Params
Name | Required | Type | Default | Comment |
---|---|---|---|---|
identifier | yes | string | ||
user_ids | yes | string |
Notes:
user_ids
The user_ids is either a single social_user_id integer or a comma separated list of social_user_ids
Success [200]
{
"status": "success",
"data": [
{
"social_user_id": [id],
"age": "[Age]",
"access_token": "",
"app_info_id": [integer],
"browser_name": "[string]",
"campaign_id": [campaign_id],
"campaign_name": "[Campaign Name]",
"device_id": [device_id],
"device_mac": "[string]",
"email": "[string]",
"full_name": "[string]",
"gender": "[string]",
"phone_number": "[string]",
"birthdate": "[string]",
"locale": "[string]",
"location_id": [location_id],
"location_name": "[Location Name]",
"picture_url": "[picture url]",
"location_access": null,
"return": "[integer]",
"radius_session_total_time": "[integer]",
"radius_total_bandwidth_input": "[integer]",
"radius_total_bandwidth_output": "[integer]",
"radius_session_first_datetime": "[datetime]",
"radius_session_last_datetime": "[datetime]",
"social_network": "[Social User Network]",
"social_network_id": "[string]",
"timezone": "[timezone]",
"updated_at": "[datetime]",
"user_id": "[user_id]",
"user_device_agent": "[string]",
"user_device_brand": "[string]",
"user_device_os_name": "[string]",
"user_device_os_version": "[string]",
"user_device_type": "[string]",
"user_mac": "[string]",
"username": "[string]"
}
],
}
Error [400]
{
"status": "error",
"message": {
[error_msgs]
}
}