Измените язык, если вам нужно работать с Топвизором на другом языке. Язык интерфейса можно изменить в любое время в настройках аккаунта. Измените язык, если вам нужно работать с Топвизором на другом языке. ru Русский Выбрать

Ключевые фразы

  • Ключевая фраза должна связываться с определенной группой, добавление ключевой фразы без указания группы невозможно.

Структура объекта: "Ключевая фраза"

Поле Тип Описание
Основные
id int ID ключевой фразы
project_id int ID проекта
group_id int ID группы
name string Имя ключевой фразы
tags set(от 1 до 10) Номер тега
target string Целевая ссылка
ord int Порядковый номер сортировки
Дополнительные
group_name string Имя группы, в которой находится ключевая фраза
group_on boolean Активность группы, в которой находится ключевая фраза
group_ord int Порядковый номер сортировки группы, в которой находится ключевая фраза
group_folder_id int ID папки, в которой находится группа с ключевой фразой

При фильтрации может использоваться в связке с дополнительным параметром запроса group_folder_id_depth:
  • 0 - не искать в попдапках (по умолчанию)
  • 1 - искать в подпапках
group_folder_path string Путь к группе, в которой находится ключевая фраза (без имени группы)
target_status enum(‑2, ‑1, 0, 1)

Статус целевой ссылки, является составным полем.

Определители поля:

  • region_index — индекс региона

Описание значений:

  • 1 — целевая ссылка совпадает с релевантной;
  • 0 — целевая ссылка не совпадает с релевантной;
  • 1 — релевантная страница не определена;
  • ‑2 — целевая ссылка не указана.
position int или string('‑‑')

Позиция сайта, является составным полем.

Определители поля:

  • date — дата проверки
  • project_id — id проекта / конкурента
  • region_index — индекс региона

В методах get будет возвращаться строка "‑‑" в случаях, если сайт не был найден в выдаче

relevant_url int

Релевантная страница, является составным полем.

Определители поля такие же, как у поля position.

snippet_title string

Заголовок сниппета, является составным полем.

Определители поля такие же, как у поля position.

snippet_body string

Описание сниппета, является составным полем.

Определители поля такие же, как у поля position.

visitors int

Визиты являются составным полем.

Определители поля такие же, как у поля position.

Визиты собираются автоматически в момент проверки позиций, если в проекте интегрированы Яндекс Метрика или Google Analytics.

volume int

Частота, является составным полем.

Определители поля:

  • region_key — ключ региона
  • searcher_key — ключ ПС
  • type — форма частоты, возможные значения:

    Для Яндекс: 1, 2, 3, 5, 6 (Ч, "Ч", "!Ч", "[Ч]", "[!Ч]")
    Для Google: 3
    Для go.Mail: 2
cost_forecast int

Прогнозируемая цена клика, является составным полем.

Определители поля:

  • position — Место показа, возможные значения:

    Для Яндекс:
    • P11 — 1 спец. размещение
    • P12 — 2 спец. размещение
    • P13 — 3 спец. размещение (предусмотрен в API, но в данный момент не собирается)
    • P1L — Вход в спец. размещение
    • P21 — Гарантированные показы
    • P2L — Вход в гарантированные показы

    Для Google:
    • P11 — 1 место
    • P1L — Верх страницы
    • P2L — 1 страница
  • region_key — ключ региона
  • searcher_key — ключ ПС
COUNT(*) int

Число найденных объектов

  • Не имеет смысла использовать с другими полями
  • В результате будет возвращен один объект

Методы для работы с запросами