Получение результатов Парсинга Частотности V4 (SerpstatTaskProcedure.getTaskResult)
Метод SerpstatTaskProcedure.getTaskResult метод позволяет получить результаты Парсинга Частотности по идентификатору запроса "task_id", который был получен в ответе метода SerpstatTaskProcedure.addKeywordListFreq.
Общие параметры запроса и инструкция по использованию Serpstat API по Парсингу частотности
| Параметры запроса | |||||
|---|---|---|---|---|---|
| Параметр | Описание | Тип данных | Опциональный | Значение по умолчанию | Варианты значений |
| id | Идентификатор текущего запроса | string | нет | 1, test | |
| method | Имя метода | string | нет | SerpstatTaskProcedure.getTaskResult | |
| params | Объект с параметрами | object | нет | ||
| taskId | Идентификатор запроса из ответа метода SerpstatTaskProcedure.addKeywordListFreq | string | нет | 352ab0be-b8a4-4966-8d16-f9137cb93c23 | |
| page | Номер страницы | int | да | 1 | 5 |
| pageSize | Количество результатов на страницу | int | да | 100 | 10 |
| Параметры ответа | ||
|---|---|---|
| Параметр | Описание | Тип данных |
| id | Идентификатор запроса: соответствует id в запросе. | int |
| result | Объект с результатами. | json object |
| total | Суммарное количество ключевых фраз в задаче без учета blocked и дублей. | int |
| page | Порядковый номер страницы результатов. | int |
| pageSize | Количество результатов на странице. | int |
|
taskMeta
|
Объект с настройками парсинга, переданными в методе SerpstatTaskProcedure.addKeywordListFreq | json object |
| typeId | Идентификатор типа устройства: typeId=1 - Desktop typeId=2 - Mobile (работает только для Яндекса; для Google пробивка будет идти по typeId=1, независимо от указанного параметра) |
int |
| seId | Идентификатор поисковой системы: seId=1 - Google seId=2 - Yandex |
int |
| regionId | Идентификатор региона или города для Google и Yandex. Соответствие региону указано в документе (осторожно, документ тяжелый - может временно положить браузер). | int |
| match | Идентификатор типа соответствия. Этот параметр работает только для Яндекса. Для Google всегда пробивка идет с типом соответствия "extra". "extra" учитывает и словоформу, и расположение. Пример: "[!купить !слона !в !рассрочку]" "exact": не учитывает порядок слов, но учитывает словоформу. Пример: "!купить !слона !в !рассрочку" "phrase": учитывает всё, что содержит эти слова в разном расположении и разные словоформы. Пример: "купить слона в рассрочку” "wide": широкое соответствие. Пример: купить слона в рассрочку "wide-fixed": широкое соответствие с фиксированной словоформой. Пример: !купить !слона !в !рассрочку |
string |
| keywords | Массив ключевых фраз с информацией по каждому ключевому слову. | json array of objects |
| keyword | Ключевая фраза, по которой были получены параметры частотности и стоимости за клик с учетом всех фильтров. | string |
| keyword.raw | Ключевая фраза, которая пришла на пробивку частотности от пользователя. Частотность пробивается для ключевых фраз без спецсимволов (*, +, -, @, ~, !, &, |, (, ), :, ,, ., ;). | string |
| status |
Статус пробивки ключевой фразы. Статусы могут быть следующие: Подробнее тематики ключевых фраз, которые не пройдут проверку описаны тут для Google и тут для Яндекс. |
string |
| cost | Средняя стоимость за клик в Google Ads за последний год в USD (минимальная стоимость размещения в премиум блоке для Яндекс) | int |
| searchVolume | Частотность по выбранном региону и типу соответствия | int |
| searchVolumeHistory | История частотности по ключевой фразе за последние 12 месяцев. Каждый объект состоит из полей date (дата первого дня месяца в формате YYYY-MM-DDTHH:MM:SS) и value (месячная частотность). | int |
| competition | Конкуренция по ключевой фразе в Google Ads для Google (от 1 до 100%), которая показывает какой процент слотов для рекламы по этой фразе занято в данном регионе | int |
Request data:
{
"id": 1,
"method": "SerpstatTaskProcedure.getTaskResult",
"params": {
"taskId": "bc0a46cc-357e-4706-a674-1e8166f81fb2",
"page": 1,
"pageSize" : 10
}
}Response data:
{
"id": "1",
"result": {
"total": 6,
"page": 1,
"pageSize": 10,
"taskMeta": {
"typeId": "1",
"seId": "1",
"regionId": "2840",
"match": "exact"
},
"keywords": [
{
"keyword": "iphone 10",
"keyword.raw": "iphone 10",
"status": 2,
"cost": 1.01,
"searchVolume": 246000,
"searchVolumeHistory": [
{
"date": "2020-09-01T00:00:00",
"value": 246000
},
{
"date": "2020-10-01T00:00:00",
"value": 301000
},
{
"date": "2020-11-01T00:00:00",
"value": 368000
},
{
"date": "2020-12-01T00:00:00",
"value": 368000
},
{
"date": "2021-01-01T00:00:00",
"value": 246000
},
{
"date": "2021-02-01T00:00:00",
"value": 201000
},
{
"date": "2021-03-01T00:00:00",
"value": 246000
},
{
"date": "2021-04-01T00:00:00",
"value": 201000
},
{
"date": "2021-05-01T00:00:00",
"value": 246000
},
{
"date": "2021-06-01T00:00:00",
"value": 201000
},
{
"date": "2021-07-01T00:00:00",
"value": 246000
},
{
"date": "2021-08-01T00:00:00",
"value": 246000
}
],
"competition": 100
},
{
"keyword": "iphone X",
"keyword.raw": "iphone X",
"status": 2,
"cost": 0.94999999999999996,
"searchVolume": 550000,
"searchVolumeHistory": [
{
"date": "2020-09-01T00:00:00",
"value": 550000
},
{
"date": "2020-10-01T00:00:00",
"value": 673000
},
{
"date": "2020-11-01T00:00:00",
"value": 673000
},
{
"date": "2020-12-01T00:00:00",
"value": 673000
},
{
"date": "2021-01-01T00:00:00",
"value": 550000
},
{
"date": "2021-02-01T00:00:00",
"value": 450000
},
{
"date": "2021-03-01T00:00:00",
"value": 550000
},
{
"date": "2021-04-01T00:00:00",
"value": 550000
},
{
"date": "2021-05-01T00:00:00",
"value": 450000
},
{
"date": "2021-06-01T00:00:00",
"value": 450000
},
{
"date": "2021-07-01T00:00:00",
"value": 450000
},
{
"date": "2021-08-01T00:00:00",
"value": 673000
}
],
"competition": 81
}
]
}
}