Отримання списку сторінок та їх позицій для домену
Метод RtApiSerpResultsProcedure.getUrlsSerpResultsHistory повертає історію позицій та сторінки відстежуваного домену за ключовими фразами проєкту у заданому регіоні. Аналогічний до звіту Моніторинг позицій - Історія позицій.
Загальні параметри запиту та інструкція щодо використання Serpstat API
Доступні пошукові бази
| Параметри запиту | |||||
| Параметр | Опис | Тип | Обов'язковий | Значення за замовчуванням | Варіанти значень |
| id | Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор | int/string | так | Будь-яке числове або текстове значення. | |
| method | Назва методу API | string | так | RtApiSerpResultsProcedure.getKeywordsSerpResultsHistory | |
| params | Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...] |
| так | ||
| projectId | Ідентифікатор проєкту | number | так | Числове значення ідентифікатору проєкту | |
| projectRegionId | Ідентифiкатор регіону | number | так | Числове значення ідентифікатору регіону | |
| page | Номер сторінки | number | так | 1 | Числове значення |
| pageSize | Кількість результатів на сторінку | number | ні | 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. |
| domain | Домен або сторінка, за якими потрібні дані | string | ні | project domain | Текстове значення. Формат даних: domain.com — домен, https://domain.com/ — сторінка |
| withTags | Відображення тегів ключових фраз | string | ні | false | Текстове значення. "true" або "false" |
| Параметри відповіді | |
| Параметр | Опис |
| id | Ідентифікатор відповіді: відповідає id в запиті |
| result | Містить в собі відповідь |
| data | Об'єкт з даними |
| projectId | Ідентифікатор проєкту |
| projectRegionId | Ідентифікатор регіону |
| domain | Домен або сторінка, за якими робили запит |
| keywords | Масив ключових фраз |
| keyword | Ключова фраза |
| frequency | Частотність ключової фрази за місяць в обраній країні чи місті |
| expectedUrl | Цільова сторінка, яка оптимізується під конкретну фразу (якщо вона була додана у проєкті) |
| tags | Масив ідентифікаторів тегів та їх значення (назв тегів) |
| history | Масив дат з видачею по ключовій фразі |
| date | Дата видачі |
| positions | Масив позицій з доменом або сторінкою |
| position | Позиція |
| url | Сторінка, яка показується у результатах пошуку за певною фразою |
| positionBlock (тiльки для PPC) | Блок контекстної реклами: * top — верхній блок реклами; * sidebar — бічний блок реклами; * bottom — нижній блок реклами |
| summary info | Блок зведеної інформації |
| page | Поточна сторінка |
| page_total | Кількість сторінок з результатами при обраному параметрі page size |
| count | Кількість результатів на сторінку |
| total | Загальна кількість результатів |
| sort | Сортування за параметрами |
| order | Напрям сортування |
| Можливі помилки у відповіді | |
| Код помилки | Опис |
| -32009\-32602 | Невалідні параметри запиту. Опис які параметри та в чому проблема |
| -33054 | Проєкт видалений |
| -34001 | Невірний projectRegionId для проєкту |
| -34002 | Діапазон дат повинен містити менше 30 дат аналізу |
| -34003 | Ключові фрази не знайдено в проєкті |
| -32002 | Порожній результат |
За цим методом ліміти API не списуються.
Request data:
{
"id": 1,
"method": "RtApiSerpResultsProcedure.getUrlsSerpResultsHistory",
"params": {
"projectId": 930722,
"projectRegionId": 309245,
"page": 1,
"pageSize": 500,
"dateFrom": "2023-10-09",
"dateTo": "2023-10-23",
"sort": "date",
"order": "desc",
"keywords": [],
"withTags": false,
"domain": "https://makeup.com.ua/brand/29737/"
}
}Response data:
{
"id": "1",
"result": {
"data": {
"projectId": 930722,
"projectRegionId": 309245,
"domain": "https://makeup.com.ua/brand/29737/",
"keywords": [
{
"keyword": "фрэнчи",
"frequency": 27100,
"expectedUrl": "https://makeup.com.ua/",
"history": [
{
"date": "2023-10-23",
"positions": [
{
"position": 1,
"url": "https://makeup.com.ua/brand/29737/"
}
]
},
{
"date": "2023-10-16",
"positions": [
{
"position": 2,
"url": "https://makeup.com.ua/brand/29737/"
}
]
},
{
"date": "2023-10-09",
"positions": [
{
"position": 2,
"url": "https://makeup.com.ua/brand/29737/"
}
]
}
]
},
{
"keyword": "френчи",
"frequency": 27100,
"expectedUrl": "",
"history": [
{
"date": "2023-10-23",
"positions": []
},
{
"date": "2023-10-16",
"positions": [
{
"position": 2,
"url": "https://makeup.com.ua/brand/29737/"
}
]
},
{
"date": "2023-10-09",
"positions": [
{
"position": 2,
"url": "https://makeup.com.ua/brand/29737/"
}
]
}
]
},
{
"keyword": "главкома",
"frequency": 165000,
"expectedUrl": "",
"history": [
{
"date": "2023-10-23",
"positions": []
},
{
"date": "2023-10-16",
"positions": []
},
{
"date": "2023-10-09",
"positions": []
}
]
},
{
"keyword": "мейкап украина",
"frequency": 0,
"expectedUrl": "https://www.americanhorror.fans/",
"history": [
{
"date": "2023-10-23",
"positions": []
},
{
"date": "2023-10-16",
"positions": []
},
{
"date": "2023-10-09",
"positions": []
}
]
},
{
"keyword": "косметика для всей семьи и не только покупайте и радуйтесь",
"frequency": 0,
"expectedUrl": "",
"history": [
{
"date": "2023-10-23",
"positions": []
},
{
"date": "2023-10-16",
"positions": []
},
{
"date": "2023-10-09",
"positions": []
}
]
},
"summary_info": {
"page": 1,
"page_total": 1,
"count": 500,
"total": 44,
"sort": "date",
"order": "desc"
},
"spent_limits": 0
}
}