Felo API PlatformFelo API Platform
Усі endpoint DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

Налаштування live-завдань «Пошуковий обсяг»

Felo API Support
MIT
Сервер:https://openapi.felo.ai
Клієнтські бібліотеки
Shell Curl

DataForSEO

​

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

DataForSEO Операції

Налаштування 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

    Відповідь із помилкою; наскрізні відповіді апстріму можуть використовувати формати постачальника

    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