Felo API PlatformFelo API Platform
Все эндпоинты DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

Релевантные страницы

Сервер:https://openapi.felo.ai
Клиентские библиотеки

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

Релевантные страницы

​

Какие страницы сайта target обеспечивают его позиции, отсортированные по приносимому трафику. Постраничная выдача через limit, offset и offset_token; после первых страниц используйте токен. Ответ обёрнут в конверт DataForSEO: данные в tasks[0].result, результат в tasks[0].status_code — отклонённый запрос всё равно возвращает HTTP 200. Используйте, чтобы найти страницы, которые стоит защищать или развивать. Ключевые слова для них — post_dataforseo_labs_google_kw_for_site_live; страницы, приносящие ссылки, а не позиции, — post_dataforseo_backlinks_domain_pages_summary_live.

Справочная информация о ценах

  • Тарификация: заявленная стоимость ответа.
  • Справочная оценка запроса: USD 0.015.
  • Справочный множитель для клиента: 1.0. Не применяйте его повторно к уже рассчитанной сумме клиента.

Только справочные метаданные, а не котировка для аккаунта, гарантированная цена или лимит расходов. Кредиты ресурсов — не кредиты Felo. Итоговые списания определяются записями биллинга Felo.

Тело
application/json
  • Тип: array (object | null)[]
    • filters
      Тип: array (object | null)[] | null

      массив параметров фильтрации результатов
      необязательное поле
      можно добавить несколько фильтров одновременно (не более 8)
      между условиями нужно указать логический оператор and или or
      поддерживаются следующие операторы:
      regex, not_regex, <, <=, >, >=, =, <>, in, not_in

      пример:
      ["metrics.paid.count",">",0]

      [["metrics.organic.count",">",50],"and",["metrics.organic.pos_1","<>",0]]

      [[""metrics.organic.count",">",50"],
      "and",
      [["metrics.organic.pos_1","<>",0],"or",["metrics.organic.pos_2_3","<>",0]]]

      Подробнее о фильтрах — в Dataforseo Labs - Filters или в этом руководстве справочного центра

      Пустой объект
    • historical_serp_mode
      Тип: string | null

      режим сбора данных
      необязательное поле
      это поле можно использовать для фильтрации результатов;
      возможные типы фильтрации:
      live — возвращает метрики для SERP, в которых указанный target в настоящее время имеет результаты ранжирования;
      lost — возвращает метрики для SERP, в которых указанный target ранее имел результаты ранжирования, но не имел их во время последней проверки;
      all — возвращает метрики для SERP обоих типов.
      значение по умолчанию: live

    • ignore_synonyms
      Тип: boolean | null

      игнорировать очень похожие ключевые слова
      необязательное поле
      если задано true, будут возвращены только основные ключевые слова, а все очень похожие ключевые слова исключены;
      значение по умолчанию: false

    • include_clickstream_data
      Тип: boolean | null

      включить или исключить данные на основе кликстрим-метрик в результате
      необязательное поле
      если параметр установлен в true, вы получите в ответе поля clickstream_etv, clickstream_gender_distribution и clickstream_age_distribution с данными кликстрима
      значение по умолчанию: false
      при включении этого параметра стоимость запроса удваивается

      Подробнее о том, как рассчитываются метрики на основе кликстрима, — в этой статье справочного центра

    • item_types
      Тип: array string[] | null

      отображение результатов по типу элемента
      необязательное поле
      указывает тип результатов поиска, включаемых в ответ

      Примечание: если массив item_types содержит типы элементов, отличные от organic, результаты будут упорядочены по первому типу элемента в массиве; сортировать и фильтровать результаты по типам результатов поиска, не включённым в ответ, будет нельзя;

      возможные значения:
      ["organic", "paid", "featured_snippet", "local_pack"]
      значение по умолчанию:
      ["organic", "paid"]

    • language_code
      Тип: string | null

      код языка
      необязательное поле
      если используете это поле, language_name указывать не нужно
      список доступных языков с language_code можно получить отдельным запросом к
      https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
      игнорируйте это поле, чтобы получить результаты для всех доступных языков
      пример:
      en

    • language_name
      Тип: string | null

      полное название языка
      необязательное поле
      если используете это поле, language_code указывать не нужно
      список доступных языков с language_name можно получить отдельным запросом к
      https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
      игнорируйте это поле, чтобы получить результаты для всех доступных языков
      пример:
      English

    • limit
      Тип: integer | null

      максимальное количество возвращаемых страниц
      необязательное поле
      значение по умолчанию: 100
      максимальное значение: 1000

    • location_code
      Тип: integer | null

      код местоположения
      необязательное поле
      если используете это поле, location_name указывать не нужно
      список доступных местоположений с location_code можно получить отдельным запросом к
      https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
      игнорируйте это поле, чтобы получить результаты для всех доступных местоположений
      пример:
      2840

    • location_name
      Тип: string | null

      полное название местоположения
      необязательное поле
      если используете это поле, location_code указывать не нужно
      список доступных местоположений с location_name можно получить отдельным запросом к
      https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
      игнорируйте это поле, чтобы получить результаты для всех доступных местоположений
      пример:
      United Kingdom

    • offset
      Тип: integer | null

      смещение в массиве результатов возвращаемых страниц
      необязательное поле
      значение по умолчанию: 0
      если указать значение 10, первые десять страниц в массиве результатов будут пропущены, а данные будут предоставлены для последующих страниц

    • order_by
      Тип: array string[] | null

      правила сортировки результатов
      необязательное поле
      для сортировки результатов можно использовать те же значения, что и в массиве filters
      возможные типы сортировки:
      asc - результаты сортируются по возрастанию
      desc - результаты сортируются по убыванию
      для указания типа сортировки используйте запятую
      пример:
      ["metrics.paid.etv,asc"]
      Примечание: в одном запросе можно задать не более трёх правил сортировки
      несколько правил сортировки нужно разделять запятой
      пример:
      ["metrics.organic.etv,desc","metrics.paid.count,asc"]

      правило по умолчанию:
      ["metrics.organic.count,desc"]
      Примечание: если массив item_types содержит типы элементов, отличные от organic, результаты будут упорядочены по первому типу элемента в массиве

    • tag
      Тип: string | null

      пользовательский идентификатор задачи
      необязательное поле
      ограничение — 255 символов
      этот параметр позволяет идентифицировать задачу и сопоставить её с результатом
      указанное значение tag вы найдёте в объекте data ответа

    • target
      Тип: string

      домен
      обязательное поле
      имя домена целевого веб-сайта
      домен указывается без https:// и www.

Ответы
  • 200
    Тип: object | null · Response36Afe1097B20_DataforseoLabsGoogleRelevantPagesLiveResponseInfo
    • cost
      Тип: number | null Формат: double

      общая стоимость задач, USD

    • status_code
      Тип: integer | null

      общий код состояния. Полный список кодов ответа можно найти здесь.

    • status_message
      Тип: string | null

      общее информационное сообщение. Полный список общих информационных сообщений можно найти здесь.

    • tasks
      Тип: array (object | null)[] | null

      массив задач

      • Тип: object | null · Response36Afe1097B20_DataforseoLabsGoogleRelevantPagesLiveTaskInfo
        • cost
          Тип: number | null Формат: double

          общая стоимость задач, USD

        • data
          Тип: object | null

          содержит те же параметры, что вы указали в POST-запросе

          • propertyName
            Тип: object | null
        • id
          Тип: string | null

          идентификатор задачи уникальный идентификатор задачи в нашей системе в формате UUID

        • path
          Тип: array (string | null)[] | null

          путь URL

        • result
          Тип: array (object | null)[] | null

          массив результатов

          • items
            Тип: array (object | null)[] | null

            соответствующие страницы и связанные данные

            • metrics
              Тип: object | null

              метрики ранжирования и трафика для соответствующей страницы

              • propertyName
                Тип: object · Response36Afe1097B20_DataforseoLabsMetricsInfo
                • clickstream_age_distribution
                  Тип: object | null

                  распределение метрик на основе кликстрима по возрасту
                  чтобы получить результаты для этого поля, параметр include_clickstream_data должен быть установлен в true
                  подробнее о том, как рассчитывается метрика, — в этой статье справочного центра

                  • propertyName
                    Тип: integer | null Формат: int64

                    Signed 64-bit integers (long type).

                • clickstream_etv
                  Тип: number | null Формат: double

                  оценка объёма трафика на основе данных кликстрима
                  рассчитывается как произведение значений кликабельности и поискового объёма кликстрима по всем ключевым словам, для которых ранжируется домен
                  чтобы получить результаты для этого поля, параметр include_clickstream_data должен быть установлен в true
                  подробнее о том, как рассчитывается метрика, — в этой статье справочного центра

                • clickstream_gender_distribution
                  Тип: object | null

                  распределение оценочных метрик на основе кликстрима по полу
                  чтобы получить результаты для этого поля, параметр include_clickstream_data должен быть установлен в true
                  подробнее о том, как рассчитывается метрика, — в этой статье справочного центра

                  • propertyName
                    Тип: integer | null Формат: int64

                    Signed 64-bit integers (long type).

                • count
                  Тип: integer | null Формат: int64

                  общее количество органических SERP, содержащих домен или поддомен

                • estimated_paid_traffic_cost
                  Тип: number | null

                  оценка стоимости превращения органического поискового трафика в платный
                  представляет оценочную месячную стоимость (USD) показа рекламы по всем ключевым словам категории, в которой ранжируется домен или поддомен
                  метрика рассчитывается как произведение органического etv и платного cpc и указывает стоимость привлечения оценочного объёма месячного органического трафика через рекламу PPC в поиске Google
                  подробнее о том, как рассчитывается метрика, — в этой статье справочного центра

                • etv
                  Тип: number | null

                  оценка объёма трафика
                  оценочный органический месячный трафик на домен или поддомен
                  рассчитывается как произведение значений CTR (кликабельности) и поискового объёма по всем ключевым словам категории, в которой ранжируется домен или поддомен
                  подробнее о том, как рассчитывается метрика, — в этой статье справочного центра

                • is_down
                  Тип: integer | null

                  ранг снизился
                  указывает, сколько ранжированных элементов указанной цели снизилось

                • is_lost
                  Тип: integer | null

                  потерянные ранжированные элементы
                  указывает, сколько ранжированных элементов указанной цели ранее присутствовали в SERP, но не были найдены при последней проверке

                • is_new
                  Тип: integer | null

                  количество новых ранжированных элементов
                  указывает, сколько новых ранжированных элементов найдено для указанной цели

                • is_up
                  Тип: integer | null

                  ранг вырос
                  указывает, сколько ранжированных элементов указанной цели выросло

                • pos_1
                  Тип: integer | null

                  количество органических SERP, где домен или поддомен занимает место #1

                • pos_11_20
                  Тип: integer | null

                  количество органических SERP, где домен или поддомен занимает место #11-20

                • pos_2_3
                  Тип: integer | null

                  количество органических SERP, где домен или поддомен занимает место #2-3

                • pos_21_30
                  Тип: integer | null

                  количество органических SERP, где домен или поддомен занимает место #21-30

                • pos_31_40
                  Тип: integer | null

                  количество органических SERP, где домен или поддомен занимает место #31-40

                • pos_4_10
                  Тип: integer | null

                  количество органических SERP, где домен или поддомен занимает место #4-10

                • pos_41_50
                  Тип: integer | null

                  количество органических SERP, где домен или поддомен занимает место #41-50

                • pos_51_60
                  Тип: integer | null

                  количество органических SERP, где домен или поддомен занимает место #51-60

                • pos_61_70
                  Тип: integer | null

                  количество органических SERP, где домен или поддомен занимает место #61-70

                • pos_71_80
                  Тип: integer | null

                  количество органических SERP, где домен или поддомен занимает место #71-80

                • pos_81_90
                  Тип: integer | null

                  количество органических SERP, где домен или поддомен занимает место #81-90

                • pos_91_100
                  Тип: integer | null

                  количество органических SERP, где домен или поддомен занимает место #91-100

            • page_address
              Тип: string | null

              абсолютный URL соответствующей страницы

            • se_type
              Тип: string | null

              тип поисковой системы

          • items_count
            Тип: integer | null Формат: int64

            количество результатов, возвращённых в массиве items

          • language_code
            Тип: string | null

            код языка в массиве POST
            если данных нет, значение — null

          • location_code
            Тип: integer | null

            код местоположения в массиве POST
            если данных нет, значение — null

          • se_type
            Тип: string | null

            тип поисковой системы

          • target
            Тип: string | null

            целевой домен в POST-массиве

          • total_count
            Тип: integer | null Формат: int64

            общее количество результатов в нашей базе данных, соответствующих вашему запросу

        • result_count
          Тип: integer | null Формат: int64

          число элементов в массиве result

        • status_code
          Тип: integer | null

          код состояния задачи формируется DataForSEO, может находиться в диапазоне 10000-60000 Полный список кодов ответа можно найти здесь.

        • status_message
          Тип: string | null

          информационное сообщение задачи Полный список общих информационных сообщений можно найти здесь.

        • time
          Тип: string | null

          время выполнения, секунды

    • tasks_count
      Тип: integer | null Формат: int64

      число задач в массиве tasks

    • tasks_error
      Тип: integer | null Формат: int64

      число задач в массиве tasks, возвращённых с ошибкой

    • time
      Тип: string | null

      общее время выполнения, секунды

    • version
      Тип: string | null

      текущая версия API

    application/json
  • 400

    Запрос не удалось обработать. Проверьте параметры запроса.

  • 401

    Требуется действительный API-ключ Felo.

  • 402

    Запрос не может быть выполнен: не выполнено требование биллинга.

  • 403

    Аккаунту не разрешено выполнять эту операцию.

  • 429

    Достигнут лимит запросов или расходов.

  • 502

    Сервис не смог выполнить запрос.

  • 503

    API или сервис биллинга временно недоступны.

  • 504

    Истекло время ожидания обработки запроса.

  • default

    Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

    application/json
Request Example for post/v1/beta/dataforseo/dataforseo_labs/google/relevant_pages/live
curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/relevant_pages/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "amazon.com",
    "language_name": "English",
    "location_code": 2840,
    "filters": [
      [
        "metrics.organic.pos_1",
        "<>",
        0
      ],
      "or",
      [
        "metrics.organic.pos_2_3",
        "<>",
        0
      ]
    ],
    "limit": 3
  }
]'
{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "se_type": null,
          "target": null,
          "location_code": null,
          "language_code": null,
          "total_count": null,
          "items_count": null,
          "items": [
            {
              "se_type": null,
              "page_address": null,
              "metrics": null
            }
          ]
        }
      ]
    }
  ]
}
Relevant Pages

Нужна помощь?