/suggest
Get suggested search results for a given query.
Endpoint URL
https://partners.api.vio.com/v1/suggest
HTTP Method
GET
Headers
| Name | Required | Description |
|---|---|---|
X-Partner-Key | Yes | Partner's profile key |
Accept-Encoding | No | gzip, deflate, br |
Query parameters
| Name | Required | Type | Description | Example | Default |
|---|---|---|---|---|---|
query | Yes | string | Free-text query. | "Amsterdam" | |
language | No | string | Language code to translate suggestions. See supported languages | "en" | "en" |
Dynamic Click Tracking
Click tracking is available using Dynamic Click Tracking
Examples
Suggest places
- Bash
curl --location --request GET 'https://partners.api.vio.com/v1/suggest?query=Amsterdam' \
--header 'X-Partner-Key: <profile key>'
Suggest hotels
- Bash
curl --location --request GET 'https://partners.api.vio.com/v1/suggest?query=Park plaza hotel' \
--header 'X-Partner-Key: <profile key>'
Response
The response payload has the following fields:
| Field | Required | Type | Description |
|---|---|---|---|
suggestions | Yes | Suggestion[] | The list of suggestions. |
Suggestion
| Field | Required | Type | Description |
|---|---|---|---|
objectId | Yes | string | Object ID. |
objectType | Yes | string | Object type: place, hotel. |
placeDisplayName | Yes | string | Address display name. |
placeTypeName | Yes | string | Suggested place type: property, country, city, airport, station, area. |
value | Yes | string | Full name of the suggestion. |
highlightValue | Yes | string | Markup text with occurrences highlighted. |