Description
Searches the venue directory for active venues with the given parameters.
General
| End Point | https://www.mogl.com/api/v2/venues/search |
| HTTP Method | POST |
| Requires SSL | true |
| Requires Acting User | false |
| Scope(s) | None |
Path Parameters
Path parameters are ALWAYS required.
None
Request Parameters
Parameters are NOT REQUIRED unless noted otherwise.
| query | A user entered query to search venues by. |
| queryLocation | A user entered location to search venues by (could be a city/state or zip). |
| city | The name of a city to search in. Not required if lat and long are provided. |
| state | The two letter abbreviation of the state. Required if city is provided. |
| lat | Specific latitude to search within. If specified then requires long and distance. |
| long | Specific longitude to search within. If specified then requires lat and distance. |
| page | Page number of results. |
| numResults | Number of results to return per page. |
| checkBookmarks | Whether to check whether the results are in bookmarks (and mark them) |
| checkLinks | Whether to check whether the offers have links to the current user. |
| featured | Whether to only return featured businesses. If true, only featured venues are returned. If false, only non-featured venues are returned. If empty, all venues are returned. |
| sort | The sort order for the business. |
| cities | multi A list of cities to restrict the results to. (Use facet filtering). |
| distance | A distance filter to restrict results to. |
| attributes | multi A list of attributes to restrict the results to. (Use facet filtering). |
| categories | multi A list of categories to restrict the results to. (Use facet filtering). |
| features | multi A list of features to restrict the results to. (Use facet filtering). |
| ambiances | multi A list of ambiances to restrict the results to. (Use facet filtering). |
| serves | multi A list of serves to restrict the results to. (Use facet filtering). |
| priceRanges | multi A list of priceranges to restrict the results to. (Use facet filtering). |
| bestNights | multi A list of best nights to restrict the results to. (Use facet filtering). |
| minRating | Minimum rating for the business. |
| facet | Return a facet map for filtering results. Defaults to false for better performance. |
Response Fields
| results | A list of venues. See searchResults details, See venue details |