Skip to main content

suggest

Creates, updates, deletes, gets or lists a suggest resource.

Overview

Namesuggest
TypeResource
Idgodaddy.domains.suggest

Fields

The following fields are returned by SELECT queries:

Request was successful

NameDatatypeDescription
domainstringSuggested domain name

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
suggestselectX-Shopper-Id, query, country, city, sources, tlds, lengthMax, lengthMin, limit, waitMsSuggest 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.

NameDatatypeDescription
X-Shopper-IdstringShopper ID for which the suggestions are being generated
citystring (city-name)Name of city to be used as a hint for target region
countrystring (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
lengthMaxintegerMaximum length of second-level domain
lengthMinintegerMinimum length of second-level domain
limitintegerMaximum number of suggestions to return
querystringDomain name or set of keywords for which alternative domain names will be suggested
sourcesarraySources 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
tldsarrayTop-level domains to be included in suggestions NOTE: These are sample values, there are many more
waitMsinteger (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 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 }}'
;