The KeywordsSuggest service accepts POST requests and returns suggested keywords for an account. The service endpoint is:
https://platform.oddbytes.com/api/v1/{accountID}/KeywordsSuggest
Parameters
Parameter | Required | Description |
| No | Suggestion mode. Defaults to |
| Yes | Creative type used to calculate activity and opening bid values. Supported values: |
| Required for | Search phrase used for keyword suggestions. For |
Activity Suggestions
Use activity to get suggestions related to a search keyword. If suggestionType is omitted, this mode is used by default.
POST Method
curl -X POST \
--data '{"suggestionType":"activity","creative_type":"POPUP","search_keyword":"travel"}' \
-c cf.log -b cf.log \
https://platform.oddbytes.com/api/v1/123/KeywordsSuggest
JSON Response
{
"success": true,
"data": [
{
"keyword": "travel deals",
"activity": 82,
"opening_bid": "0.0250"
},
{
"keyword": "cheap flights",
"activity": 76,
"opening_bid": "0.0300"
}
],
"total": 2
}
Top 1000 Keywords
Use top1000keywords to fetch high-volume keywords for the selected creative type.
POST Method
curl -X POST \
--data '{"suggestionType":"top1000keywords","creative_type":"POPUP"}' \
-c cf.log -b cf.log \
https://platform.oddbytes.com/api/v1/123/KeywordsSuggest
Top 1000 Domains
Use top1000domains to fetch high-volume site domains for the selected creative type.
POST Method
curl -X POST \
--data '{"suggestionType":"top1000domains","creative_type":"POPUP"}' \
-c cf.log -b cf.log \
https://platform.oddbytes.com/api/v1/123/KeywordsSuggest
Inventory Suggestions
Use inventory to fetch keywords with available inventory for the selected creative type.
POST Method
curl -X POST \
--data '{"suggestionType":"inventory","creative_type":"PUSH"}' \
-c cf.log -b cf.log \
https://platform.oddbytes.com/api/v1/123/KeywordsSuggest
NLP Keyword Suggestions
Use nlp_keywords to get topic-based keyword suggestions. This option requires the user to have the add_nlp_keywords permission.
POST Method
curl -X POST \
--data '{"suggestionType":"nlp_keywords","creative_type":"POPUP","search_keyword":"sports"}' \
-c cf.log -b cf.log \
https://platform.oddbytes.com/api/v1/123/KeywordsSuggest
Invalid Suggestion Type
If an unsupported suggestionType is sent, the service returns an API error.
POST Method
curl -X POST \
--data '{"suggestionType":"google_keywords","creative_type":"POPUP","search_keyword":"travel"}' \
-c cf.log -b cf.log \
https://platform.oddbytes.com/api/v1/123/KeywordsSuggest
JSON Response
{
"success": false,
"messages": [
{
"message": "Suggestion type 'google_keywords' is not supported.",
"scope": "API",
"level": "error"
}
]
}