Switch to english interface?

Получение истории выдачи в регионе по ключевым фразам

Метод RtApiSerpResultsProcedure.getKeywordsSerpResultsHistory возвращает топ-100 выдачи в Google по региону и ключевым фразам проекта. Метод доступен только для органической выдачи. Аналогичен отчету Мониторинг позиций - История выдачи.

Общие параметры запроса и инструкция по использованию Serpstat API
Перечень доступных баз и стран

Параметры запроса

Параметр

Описание

Тип

Обязательный

Значение по умолчанию

Варианты значений

id

Идентификатор запроса: ответ содержит этот же идентификатор.

int / string

да

Любое текстовое или числовое значение.
Например: 1, test, тест

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.
withTags Отображение тегов ключевых фраз string нет false Текстовое значение.
"true" или "false"


Параметры ответа
Параметр Описание
id Идентификатор запроса: соответствует id в запросе
result Содержит в себе ответ
data
Объект с данными
projectId Идентификатор проекта
projectRegionId Идентификатор региона
keywords Массив ключевых фраз
keyword Ключевая фраза с данными
frequency
Частотность ключевого слова за месяц в выбранной стране или городе
expectedUrl
Целевая страница, которая оптимизируется под конкретную фразу (если она была добавлена в проекте)
tags
Массив идентификаторов тегов и их значений (названия тегов)
history Массив дат с выдачами по ключевой фразе
date Дата выдачи
positions Массив позиций с доменом или страницей
position Позиция
url Страница, которая показывается в результатах поиска по определенной фразе.
summary info Блок сводной информации
page Текущая страница
page_total Количество страниц с результатами при выбранном параметре pageSize
count Количество результатов на страницу
total Общее количество результатов
sort Сортировка по параметрам
order Направление сортировки

Возможные ошибки в ответе
Код ошибки Описание
-32009\-32602 Невалидные параметры запроса. Описание какие параметры и в чем проблема
-33054 Проект удален
-34001 Неправильный projectRegionId для проекта
-34002 Диапазон дат должен содержать менее 30 дат анализа
-34003 Ключевые фразы не найдены в проекте
-32002 Пустой результат

По этому методу лимиты не списываются.

Example
Request data:
{
    "id": 1,
    "method": "RtApiSerpResultsProcedure.getKeywordsSerpResultsHistory",
    "params": {
        "projectId": 715910,
        "projectRegionId": 262189,
        "page": 1,
        "pageSize": 500,
        "dateFrom": "2020-05-19",
        "dateTo": "2020-05-21",
        "sort": "date",
        "order": "asc",
        "keywords": ["1"],

        "withTags": true
    }
}
Response data:
{
  "id": "test_id",
  "result": {
    "data": {
      "projectId": 715910,
      "projectRegionId": 262189,
      "keywords": [
        {
          "keyword": "1",
          "frequency": 30,
          "expectedUrl": "https://1plus1.video/fungicid-strobi-200-gr-upakovka-instrukciya-primenenienorma.html",
          "tags": [
                        {
                            "id": "4d94e7e6-e32f-4889-b8e4-ac4142ed1f34",
                            "value": "other tag"
                        },
                        {
                            "id": "f5acf3a9-d67b-468d-8d36-23eca82b1eb4",
                            "value": "test tag"
                        }
                    ]
          "history": [
            {
              "date": "2020-05-21",
              "positions": [
                {
                  "position": 1,
                  "url": "https://1plus1.video/tvguide/1plus1/online"
                },
                {
                  "position": 2,
                  "url": "https://1plus1.video/"
                }
              ]
            }
          ]
        }
      ]
    },
    "summary_info": {
      "page": 1,
      "page_total": 1,
      "count": 500,
      "total": 1,
      "sort": "date",
      "order": "asc"
    }
  }
}                         

Поделитесь статьей с вашими друзьями

Вы уверены?

Знакомство с Serpstat

Узнайте об основных возможностях сервиса удобным способом!

Отправьте заявку и наш специалист предложит вам варианты обучения: персональную демонстрацию, пробный период или материалы для самостоятельного изучения и повышения экспертизы. Все для комфортного начала работы с Serpstat.

Имя

Email

Телефон

Будем рады вашему комментарию
Я принимаю условия Политики конфиденциальности.

Спасибо, мы сохранили ваши новые настройки рассылок.

Открыть чат технической поддержки