geo.getUsersFromArea

Syntax

mixed geo.getUsersFromArea ( int vhost, array northEast, array southWest )

Argument Info

Name	Type	Required	Default value	Description
vhost	int	Required	none	The vhost of the application.
northEast	array	Required	none	The north-east (upper-right) point of the square that defines the area for the users. Along with $southWest, is provides the co-ordinates for the area that is to show the users. Example: $northEast[0] => 62.865220228976895, $northEast[1] => -52.44921875
southWest	array	Required	none	The south-west (lower-left) point of the square that defines the area for the users. Along with $northEast, is provides the co-ordinates for the area that is to show the users. Example: $southWest[0] => 35.08404808848904, $southWest[1] => -131.55078125

Response

Below are the fields available in the returned array.

Name	Type	Description
id	INT	The user id.
user	STRING	The user name.
firstname	STRING	The first name for the user.
lastname	STRING	The last name for the user.
city	STRING	The city in which the user lives.
gender	CHAR	The gender of the user. M for male and F for female.
country	STRING	The country in which the user lives.
avatar	INT	The media item that the user has set as their avatar.
nickname	STRING	The user's nickname.
geo_latitude	FLOAT	The geographical latitude of the user's mobile device. i.e.: 40.775729609144044
geo_longitude	FLOAT	The geographical longitude of the user's mobile device. i.e.: -84.44921875
gravatarid	INT	The id of the user's gravatar.
external_id	ARRAY	An array with the user's external login information. The array holds 2 key/value pairs witht the keys being: 'external_id_provider' and 'external_id'. An example is: [external_id] => Array(    [0] => Array(     [external_id_provider] => facebook     [external_id] => 881845421    )   )

Return Values

Field	Description	Possible Values