Получение истории выдачи в регионе по ключевым фразам
Метод RtApiSerpResultsProcedure.getKeywordsSerpResultsHistory возвращает топ-100 выдачи в Google по региону и ключевым фразам проекта. Метод доступен только для органической выдачи.
Общие параметры запроса и инструкция по использованию Serpstat API
Параметры запроса | |||||
Параметр | Описание | Тип | Опциональный | Значение по умолчанию | Варианты значений |
id | Идентификатор запроса: ответ содержит этот же идентификатор. | int / string | нет | Любое текстовое или числовое значение. | |
method | Название метода API | string | нет | RtApiSerpResultsProcedure.getKeywordsSerpResultsHistory | |
params | Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...] |
| нет |
| |
projectId | Идентификатор проекта | int | нет |
| Числовое значение идентификатора проекта |
projectRegionId | Идентификатор региона | int | нет |
| Числовое значение идентификатора региона |
page | Номер страницы | int | нет | 1 | Числовое значение. |
pageSize | Количество результатов на странице | int | да | 100 | Числовое значение. Возможные варианты значений: 20, 50, 100, 200, 500 |
dateFrom | Дата начала периода, по которому нужны данные | date | да | Числовое значение, формат данных: yyyy-mm-dd | |
dateTo | Дата конца периода, по которому нужны данные | date | да | Числовое значение, формат данных: yyyy-mm-dd | |
sort | Сортировка по параметрам | string | да | alphabetically | "date" — Сортировка по дате, "keyword" — Сортировка по алфавиту |
order | Направление сортировки | string | да | desc | desc — по убыванию, asc — по возрастанию |
keywords | Ключевые фразы, по которым нужны страницы и позиции | array | да | Текстовое значение. Максимальное количество фраз, которые можно отфильтровать — 1000. |
Параметры ответа | |
Параметр | Описание |
id | Идентификатор запроса: соответствует id в запросе |
result | Содержит в себе ответ |
data | Объект с данными |
projectId | Идентификатор проекта |
projectRegionId | Идентификатор региона |
keywords | Массив ключевых фраз |
keyword | Ключевая фраза с данными |
frequency | Частотность ключевого слова за месяц в выбранной стране или городе |
expectedUrl | Целевая страница, которая оптимизируется под конкретную фразу (если она была добавлена в проекте) |
history | Массив дат с выдачами по ключевой фразе |
date | Дата выдачи |
positions | Массив позиций с доменом или страницей |
position | Позиция |
url | Страница, которая показывается в результатах поиска по определенной фразе. |
summary info | Блок сводной информации |
page | Текущая страница |
page_total | Количество страниц с результатами при выбранном параметре pageSize |
count | Количество результатов на страницу |
total | Общее количество результатов |
sort | Сортировка по параметрам |
order | Направление сортировки |
По этому методу лимиты не списываются.
{
"id": 1,
"method": "RtApiSerpResultsProcedure.getKeywordsSerpResultsHistory",
"params": {
"projectId": 853932,
"projectRegionId": 293402,
"page": 1,
"pageSize": 100,
"dateFrom": "2021-12-11",
"dateTo": "2021-12-12",
"sort": "date",
"order": "asc",
"keywords": ["adidas track"]
}
}
{
"id": "1",
"result": {
"data": {
"projectId": 853932,
"projectRegionId": 293402,
"keywords": [
{
"keyword": "adidas track",
"frequency": 49500,
"expectedUrl": "https://www.adidas.com/us/track",
"history": [
{
"date": "2021-12-11",
"positions": [
{
"position": 1,
"url": "https://www.adidas.com/us/track"
},
{
"position": 2,
"url": "https://www.adidas.com/us/track_suits"
},
{
"position": 3,
"url": "https://www.adidas.com/us/track_field"
},
...
{
"position": 95,
"url": "https://www.ispot.tv/ad/oI7z/adidas-worn-without-care-featuring-jay-rock"
}
]
},
{
"date": "2021-12-12",
"positions": [
{
"position": 1,
"url": "https://www.adidas.com/us/track"
},
{
"position": 2,
"url": "https://www.adidas.com/us/track_suits"
},
{
"position": 3,
"url": "https://www.adidas.com/us/track_field"
},
...
{
"position": 96,
"url": "https://www.journeys.com/track-order"
}
]
}
]
}
]
},
"summary_info": {
"page": 1,
"page_total": 1,
"count": 100,
"total": 1,
"sort": "date",
"order": "asc"
},
"spent_limits": 0
}
}