keywords.suggest
Suggest a new keyword based on some phrase.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
|
} |
|
|
| struct |
restrictionFilter { |
(optional) Options
|
| int |
offset |
(optional) How many results to skip; default: 0
|
| int |
limit |
(optional) How many results to return; default: 50 max:10000
|
| bool |
related |
(optional) Return also related keywords; default: false
|
| string |
orderBy |
(optional) Sorted by: [default: avgSearchCount]
-
avgSearchCount:
Search count (default)
-
cpc:
Cost per click
-
score:
Competition score
-
keyword:
Query text
|
| string |
orderDirection |
(optional) Sorting direction: [default: desc]
-
desc:
descending order direction (default)
-
asc:
ascending order direction
|
|
} |
|
|
Response
| struct |
{ |
|
| string |
statusMessage |
Status code description
|
| string |
session |
Refreshed session
|
| array |
suggestions ( |
|
| struct |
{ |
|
| string |
query |
Suggested query
|
| int |
avgSearchCount |
Average search count of keyword during last two months.
|
| int |
cpc |
Average price per click of keyword (in halers) during last two months.
|
| array |
searchCountInTime ( |
Search count per particular months during last year
|
| struct |
{ |
|
| string |
timePeriod |
Month identification in format Year-Month ("2014-02")
|
| int |
searchCount |
Search count of keyword per month (identification of month is in timePeriod field)
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
|
) |
|
|
| int |
total |
How many records is available
|
| array |
diagnostics ( |
(optional) Various diagnostics(warnings, errors, other information)
|
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK206: Partially OK301: User is serviced400: Bad arguments401: Invalid session403: Access Denied404: Not found406: Bad values of attributes413: Too many items requested.429: Too many requests. Has to wait.500: Server Error.409: Conflict
Diagnostics:
List of all possible diagnostics:
