suggest
Creates, updates, deletes, gets or lists a suggest
resource.
Overview
Name | suggest |
Type | Resource |
Id | godaddy.domains.suggest |
Fields
The following fields are returned by SELECT
queries:
- suggest
Request was successful
Name | Datatype | Description |
---|---|---|
domain | string | Suggested domain name |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
suggest | select | X-Shopper-Id , query , country , city , sources , tlds , lengthMax , lengthMin , limit , waitMs | Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
X-Shopper-Id | string | Shopper ID for which the suggestions are being generated |
city | string (city-name) | Name of city to be used as a hint for target region |
country | string (iso-country-code) | Two-letter ISO country code to be used as a hint for target region NOTE: These are sample values, there are many more |
lengthMax | integer | Maximum length of second-level domain |
lengthMin | integer | Minimum length of second-level domain |
limit | integer | Maximum number of suggestions to return |
query | string | Domain name or set of keywords for which alternative domain names will be suggested |
sources | array | Sources to be queried CC_TLD - Varies the TLD using Country Codes EXTENSION - Varies the TLD KEYWORD_SPIN - Identifies keywords and then rotates each one PREMIUM - Includes variations with premium prices |
tlds | array | Top-level domains to be included in suggestions NOTE: These are sample values, there are many more |
waitMs | integer (integer-positive) | Maximum amount of time, in milliseconds, to wait for responses If elapses, return the results compiled up to that point |
SELECT
examples
- suggest
Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history
SELECT
domain
FROM godaddy.domains.suggest
WHERE X-Shopper-Id = '{{ X-Shopper-Id }}'
AND query = '{{ query }}'
AND country = '{{ country }}'
AND city = '{{ city }}'
AND sources = '{{ sources }}'
AND tlds = '{{ tlds }}'
AND lengthMax = '{{ lengthMax }}'
AND lengthMin = '{{ lengthMin }}'
AND limit = '{{ limit }}'
AND waitMs = '{{ waitMs }}'
;