Places

When Places is selected as the search type in the General tab, the input for the activity differs from different place types.

Check the input for the activity corresponding to the following place types:

Nearby Places

When Nearby Places is selected as the search type in the General tab, the input for the activity is as follows.

Input Item Data Type Description
latitude double The latitude to search around.
This parameter is ignored in the following cases:
  • When the value is not in the range of -90.0 to +90.0 (North is positive).
  • When geo_enabled is disabled.
  • When no longitude value is specified.
longitude double The longitude to search around.
This parameter is ignored in the following cases:
  • When the value is not in the range of -180.0 to +180.0 (East is positive), or the value is not a number.
  • When geo_enabled is disabled.
  • When no latitude value is specified.
query string A UTF-8, URL-encoded search query of 1,000 characters maximum, including operators. Queries may additionally be limited by complexity.
granularity string The minimal granularity of place types to return, which is poi, neighborhood, city, admin or country.

If no granularity is provided for the request, neighborhood is assumed.

For example, to search a city, the granularity you specify is city, admin or country.

ip string An IP address. Used when attempting to fix geolocation based on the user's IP address.

For example, 74.125.19.104.

accuracy string

A hint on the "region" in which to search.

If a number, then this is a radius in meters, but it also takes a string that is suffixed with ft to specify feet. If this is not passed in, then it is assumed to be 0m.

If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).

maxResults integer A hint as to the number of results to return. This does not guarantee that the number of results returned equals max_results, but instead informs how many "nearby"results to return, only pass in the number of places you intend to display to the user here.

Similar Places

When Similar Places is selected as the search type in the General tab, the input for the activity is as follows.

Input Item Data Type Description
name string The name a place is known as.

For example, TwitterHQ.

latitude double The latitude to search around.
This parameter is ignored in the following cases:
  • When the value is not in the range of -90.0 to +90.0 (North is positive).
  • When geo_enabled is disabled.
  • When no longitude value is specified.
longitude double The longitude to search around.
This parameter is ignored in the following cases:
  • When the value is not in the range of -180.0 to +180.0 (East is positive), or the value is not a number.
  • When geo_enabled is disabled.
  • When no latitude value is specified.
containedWithin string The Place ID within which the new place is found.

For example, for a room in a building, set the place ID of building as contained_within.

streetAddress string The street to search with the specified address. Custom attributes are also supported.

For example: 795FolsomSt.