Web Search API, gRPC: WordstatService.GetTop
The method returns the last 30 days data about popular queries containing the specified keyword and queries that are similar to the specified one.
gRPC request
rpc GetTop (GetTopRequest) returns (GetTopResponse)
GetTopRequest
{
"phrase": "string",
"num_phrases": "int64",
"regions": [
"string"
],
"devices": [
"Device"
],
"folder_id": "string"
}
|
Field |
Description |
|
phrase |
string Required field. Keyword The maximum string length in characters is 400. |
|
num_phrases |
int64 Number of the phrases in the response. Acceptable values are 1 to 2000, inclusive. |
|
regions[] |
string A list of IDs of the regions a query was made from. The maximum number of elements is 100. |
|
devices[] |
enum Device A list of device types a query was made from. The maximum number of elements is 3.
|
|
folder_id |
string ID of the folder. The maximum string length in characters is 50. |
GetTopResponse
{
"total_count": "int64",
"results": [
{
"phrase": "string",
"count": "int64"
}
],
"associations": [
{
"phrase": "string",
"count": "int64"
}
]
}
|
Field |
Description |
|
total_count |
int64 Total number of the queries that contain all the keywords, regardless of their order. |
|
results[] |
Results. |
|
associations[] |
Queries that are similar to the specified one. |
PhraseInfo
|
Field |
Description |
|
phrase |
string Keyword. |
|
count |
int64 Number of queries made. |