Search Query Tips
In most cases, the search engine will do the hard work for you and find the best matched listings to the words you have entered. However, you may sometimes have a very specific search and desire more control over how the search engine operates.
Sometimes it may be desirable to search for an entire phrase rather than individual words. Using phrases provides a hint to the search engine to find a sequence of words (in order) rather than just some of the words. To search for a phrase, surround the words in quotation marks (
If there are an odd number of quotation marks in a query, all quotation marks will be ignored and no phrase searching will be done.
For example, say there was a business called 'City Locksmiths' that you were searching for. If you were to search for the words city and locksmiths, this business may not be returned as the first result, or even on the first page of results. It is possible that you were searching from a postcode that was a long distance from the business, and that the search engine was prioritising local results. In this case, you could search for:
This should only return listings containing the entire phrase 'city locksmiths'.
Mandatory and Prohibited Words
If there are certain words or phrases that you require to be found in the returned listings, simply prefix the word or phrase with a plus
+ sign. For example:
+guitar +drums teacher
This query will return only listings with both the words 'guitar' and 'drums'.
You can do the same for entire phrases. For example:
+"bass guitar" +drums teacher
Note: Remember to URL-encode the query when using the plus
+ sign as it has a special meaning in URLs. See Technical Resources for more information.
Words and phrases can be excluded using a minus
- sign. All listings containing the phrase or word will be excluded from the results. For example:
Each search endpoint takes a parameter called
location that specifies the geographical area to search within. Locations may be searched without a query but must include at least one
categoryId to return results from. This is known as a "what-less" search. The search engine may return results from outside this region, but it will prioritise closer businesses. It is possible to use the standard filtering mechanisms with a "what-less" search.
It is also possible to search for businesses at a specific latitude/longitude or street address (i.e. without specifying a categoryId). This is known as a reverse search. The radius of results returned in this type of search is very small as its purpose is to provide businesses located at a specific address. Also, it should be noted that this type of search does not support any kind of filtering.
location parameter can accept the following types of locations:
|Suburb or Locality||Name of a suburb or locality||'Glen Waverley'|
|Geographical coordinates||Latitude and Longitude representation of a position||'-37.877089,145.165358'|
|State or Territory||Name of a state or territory||'VIC' or 'Victoria'|
- Documentation Overview
- Intro into using SAPI
- Using Endpoints
- Common Fields
- Status Codes and Messages
- Validation Errors
- Spell Checker
- Search Query Tips
- Reporting Usage Events
- Filtering Unsafe Content
- Category Filtering
- Postcode Filtering
- Radius Filtering
- Address Search
- Suburb Filtering
- State Filtering
- Bounding Box Filtering
- Filtering by Content Type
- Filtering by Product Keyword
- Location Tier Filtering
- Filtering by Polygon
- Endpoint Reference