Web Search API, gRPC: WordstatService.GetRegionsDistribution

Статья создана

Обновлена 15 декабря 2025 г.

Not implemented.
The method returns the distribution of the number of queries containing the given keyword globally by region for the last 30 days.

gRPC request

{
  "phrase": "string",
  "region": "Region",
  "devices": [
    "Device"
  ],
  "folder_id": "string"
}

Field	Description
phrase	string Required field. Keyword The maximum string length in characters is 400.
region	enum Region Show query distribution only by city, only by region, or everywhere. `REGION_ALL`: Show distribution everywhere. `REGION_CITIES`: Show distribution by cities. `REGION_REGIONS`: Show distribution by regions.
devices[]	enum Device A list of device types a query was made from. `DEVICE_ALL`: All devices. `DEVICE_DESKTOP`: Desktop computers. `DEVICE_PHONE`: Phones. `DEVICE_TABLET`: Tablets.
folder_id	string ID of the folder. The maximum string length in characters is 50.

{
  "results": [
    {
      "region": "string",
      "count": "int64",
      "share": "double",
      "affinity_index": "double"
    }
  ]
}

Field

Description

results[]

Results.

Field	Description
region	string Region ID
count	int64 Number of queries containing the given keyword.
share	double The share of the number of such queries from the total number of queries to Yandex in the region.
affinity_index	double The ratio between the share of the selected queries in the region and their share across the country.