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

Настройка live-задач «Поисковый объём»

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

DataForSEO

​

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

Настройка live-задач «Поисковый объём»

​

Поисковый объём Bing для списка keywords. Возвращает keyword, location_code, language_code, search_partners, device, competition, cpc, search_volume, categories и monthly_searches — обратите внимание на categories, которых нет в эквиваленте для Google, и на отсутствие competition_index. Ответ обёрнут в конверт DataForSEO: данные в tasks[0].result, результат в tasks[0].status_code — отклонённый запрос всё равно возвращает HTTP 200. Двойник для Google — post_dataforseo_keywords_gads_search_volume_live; запускайте оба, когда аудитория не только в Google. Парные эндпоинты submit и fetch выполняют ту же работу асинхронно и по той же цене — для пакетов, которые слишком велики, чтобы дожидаться их завершения.

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

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

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

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

      начальная дата временного диапазона
      необязательное поле
      минимальное значение: 24 месяца от сегодняшней даты;
      если не указать это поле, данные будут предоставлены за последние 12 месяцев;
      минимальное значение: два года назад от сегодняшней даты;
      если эндпоинт Status возвращает false в поле actual_data, date_from можно установить на позапрошлый месяц и ранее;
      если эндпоинт Status возвращает true в поле actual_data, date_from можно установить на прошлый месяц и ранее;
      формат даты: "yyyy-mm-dd"
      пример:
      "2020-01-01"Примечание: мы не рекомендуем задавать собственный временной диапазон для дат прошлого года

    • date_to
      Тип: string | null

      конечная дата временного диапазона
      необязательное поле
      если не указать это поле, данные будут предоставлены за последние 12 месяцев;
      минимальное значение: два года назад от сегодняшней даты;
      максимальное значение: один месяц от сегодняшней даты;
      примечание: мы не рекомендуем задавать собственный временной диапазон для дат прошлого года;
      формат даты: "yyyy-mm-dd"
      пример:
      "2020-03-15"Примечание: мы не рекомендуем задавать собственный временной диапазон для дат прошлого года

    • device
      Тип: string | null

      тип устройства
      необязательное поле
      укажите это поле, чтобы получить данные для определённого типа устройства;
      возможные значения: all, mobile, desktop, tablet
      значение по умолчанию: all

    • keywords
      Тип: array string[]

      ключевые слова
      обязательное поле
      максимальное количество ключевых слов: 1000
      максимальное количество символов в каждом ключевом слове: 100
      указанные ключевые слова приводятся к нижнему регистру, данные предоставляются в отдельном массиве. Подробнее о правилах и ограничениях полей keyword и keywords в API DataForSEO читайте в статье Help Center

    • language_code
      Тип: string

      код языка поисковой системы
      обязательное поле, если не указан language_name
      если используете это поле, language_name указывать не нужно
      поддерживаемые языки:
      en, fr, de

    • language_name
      Тип: string

      полное название языка поисковой системы
      обязательное поле, если не указан language_code
      если используете это поле, language_code указывать не нужно
      поддерживаемые языки:
      English, French, German

    • location_code
      Тип: integer

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

    • location_coordinate
      Тип: string

      GPS-координаты местоположения
      обязательное поле, если не указаны location_name или location_code
      если используете это поле, location_name или location_code указывать не нужно
      параметр location_coordinate указывается в формате "широта,долгота"
      данные будут предоставлены для страны, к которой относятся указанные координаты
      пример:
      52.6178549,-155.352142

    • location_name
      Тип: string

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

    • search_partners
      Тип: boolean | null

      тип партнёров поиска Bing
      необязательное поле
      если указать true, результаты будут предоставлены для собственных, управляемых и синдицированных сетей Bing, Yahoo, AOL и партнёрских сайтов, размещающих поиск Bing, AOL и Yahoo.
      значение по умолчанию: false — результаты возвращаются для поисковых сетей Bing, AOL и Yahoo

    • sort_by
      Тип: string | null

      параметры сортировки результатов
      необязательное поле
      Используйте эти параметры для сортировки результатов по search_volume, cpc, competition или relevance по убыванию
      значение по умолчанию: relevance

    • tag
      Тип: string | null

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

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

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

    • status_code
      Тип: integer | null

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

    • status_message
      Тип: string | null

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

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

      массив задач

      • Тип: object | null · Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveTaskInfo
        • 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

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

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

            категории товаров и услуг
            наш API не возвращает категории для этого эндпоинта: параметр всегда равен null

          • competition
            Тип: number | null

            конкуренция
            относительный уровень конкуренции по указанному ключевому слову только в платной выдаче SERP. Значение основано на данных Bing Ads.
            Возможные значения: 0.1, 0.5,0.90.1 — низкая конкуренция,
            0.5 — средняя конкуренция,
            0.9 — высокая конкуренция;
            если данных нет, значение — null

          • cpc
            Тип: number | null

            цена за клик
            средняя цена за клик (USD), исторически уплаченная за ключевое слово.
            если данных нет, значение —_nulln

          • device
            Тип: string | null

            тип устройства в массиве POST
            если данных нет, значение —_nulln

          • keyword
            Тип: string | null

            ключевое слово в массиве POST

          • language_code
            Тип: string | null

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

          • location_code
            Тип: integer | null

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

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

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

            • month
              Тип: integer | null

              месяц

            • search_volume
              Тип: integer | null

              среднемесячный показатель поискового объёма

            • year
              Тип: integer | null

              год

          • search_partners
            Тип: boolean | null

            указывает, включены ли в ответ данные партнёрских сетей

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

            среднемесячный показатель поискового объёма
            приблизительное количество поисковых запросов по указанной идее ключевого слова в поисковой системе Bing с учётом таргетинга пользователя;
            поисковый объём округляется до ближайших десятков;
            если данных нет, значение —_nulln

        • 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/keywords_data/bing/search_volume/live
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/bing/search_volume/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "location_name": "United States",
    "language_code": "en",
    "keywords": [
      "tom and jerry",
      "silicon valley",
      "spider man"
    ]
  }
]'
{
  "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": [
        {
          "keyword": null,
          "location_code": null,
          "language_code": null,
          "search_partners": null,
          "device": null,
          "competition": null,
          "cpc": null,
          "search_volume": null,
          "categories": [
            null
          ],
          "monthly_searches": [
            {
              "year": null,
              "month": null,
              "search_volume": null
            }
          ]
        }
      ]
    }
  ]
}
Setting Live ‘Search Volume’ Tasks

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