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

Жива видача Google AI Mode

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

DataForSEO

​

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

DataForSEO Операції

Жива видача Google AI Mode

​

Синхронно повертає відповідь AI Mode Google на запит разом із джерелами, на які він посилається. Повертає keyword, type, se_domain, location_code, language_code, check_url, datetime, spell, refinement_chips, item_types, items_count і items. advanced — варіант за замовчуванням; беріть regular, коли потрібен лише ранжований список, і html — лише щоб перевірити, що загубив парсер. Відповідь обгорнуто в конверт DataForSEO: дані в tasks[0].result, результат у tasks[0].status_code — відхилений запит усе одно повертає HTTP 200.

Довідкові ціни

  • Тарифікація: вартість відповіді за даними постачальника.
  • Довідкова оцінка запиту: USD 0.004.
  • Довідковий множник для клієнта: 1.0. Не застосовуйте його повторно до вже розрахованої суми клієнта.

Довідкові метадані, а не котирування для облікового запису, гарантована ціна чи ліміт витрат. Кредити ресурсів — це не кредити Felo. Остаточні списання здійснюються за записами білінгу Felo.

Тіло
application/json
  • Тип: array (object | null)[]
    • browser_screen_height
      Тип: integer | null

      висота екрана браузера

      необов'язкове поле

      можна задати власну висоту екрана браузера для розрахунку піксельних позицій для конкретного пристрою;

      можна вказати в такому діапазоні: 240-9999;

      за замовчуванням параметр встановлено в:

      1080 для desktop;

      640 для mobile на android;

      812 для mobile на iOS;

      Примітка: щоб використовувати цей параметр, задайте для calculate_rectangles значення true

    • browser_screen_resolution_ratio
      Тип: integer | null

      коефіцієнт роздільної здатності екрана браузера

      необов'язкове поле

      можна задати власний коефіцієнт роздільної здатності екрана браузера для розрахунку піксельних позицій для конкретного пристрою;

      можна вказати в такому діапазоні: 0.5-3;

      за замовчуванням параметр встановлено в:

      1 для desktop;

      3 для mobile на android;

      3 для mobile на iOS;

      Примітка: щоб використовувати цей параметр, задайте для calculate_rectangles значення true

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

      ширина екрана браузера

      необов'язкове поле

      можна задати власну ширину екрана браузера для розрахунку піксельних позицій для конкретного пристрою;

      можна вказати в такому діапазоні: 240-9999;

      за замовчуванням параметр встановлено в:

      1920 для desktop;

      360 для mobile на android;

      375 для mobile на iOS;

      Примітка: щоб використовувати цей параметр, задайте для calculate_rectangles значення true

    • calculate_rectangles
      Тип: boolean | null

      розрахунок піксельних позицій для елементів SERP у розширених результатах

      необов'язкове поле

      піксельна позиція — це відстань між снипетом результату та верхнім лівим кутом екрана;

      Докладніше в Help Center>>

      за замовчуванням параметр встановлено в false

      Примітка: якщо задати true, вартість завдання множиться на 2

    • device
      Тип: string | null

      тип пристрою

      необов'язкове поле

      повертати результати для певного типу пристрою

      може набувати значень:desktop, mobile

      значення за замовчуванням: desktop

    • keyword
      Тип: string

      ключове слово

      обов'язкове поле

      у полі keyword можна вказати до 700 символів

      усі %## декодуються (символ «+» декодується в пробіл)

      якщо в keyword потрібен символ «%», вкажіть його як «%25»;

      якщо в keyword потрібен символ «+», вкажіть його як «%2B»


      Докладніше про правила й обмеження полів keyword і keywords в API DataForSEO читайте в статті Help Center

    • language_code
      Тип: string

      код мови пошукової системи

      обов'язкове поле, якщо не вказано language_name;

      якщо використовуєте це поле, language_name вказувати не потрібно;

      список доступних мов з їхнім language_code можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/ai_mode/languages

    • language_name
      Тип: string

      повна назва мови пошукової системи

      обов'язкове поле, якщо не вказано language_code;

      якщо використовуєте це поле, language_code вказувати не потрібно;

      список доступних мов з їхньою language_name можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/ai_mode/languages;

    • location_code
      Тип: integer

      код місцезнаходження пошукової системи

      обов'язкове поле, якщо не вказано location_name або location_coordinate

      якщо використовуєте це поле, location_name або location_coordinate вказувати не потрібно

      список доступних місцезнаходжень пошукових систем і відповідних location_code можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/locations

      Примітка: список країн, де AI Mode зараз доступний, див. у Google Search Help

    • location_coordinate
      Тип: string

      GPS-координати місцезнаходження

      обов'язкове поле, якщо не вказано location_name або location_code

      якщо використовуєте це поле, location_name або location_code вказувати не потрібно

      параметр location_coordinate потрібно вказувати у форматі "latitude,longitude,zoom"

      якщо "zoom" не вказано, за замовчуванням застосовується 9z

      максимальна кількість десяткових знаків для "latitude" і "longitude": 7

      мінімальне значення для "zoom": 4z

      максимальне значення для "zoom": 18z

      приклад:

      52.6178549,-155.352142,18z

    • location_name
      Тип: string

      повна назва місцезнаходження пошукової системи

      обов'язкове поле, якщо не вказано location_code або location_coordinate

      якщо використовуєте це поле, location_code або location_coordinate вказувати не потрібно

      список доступних місцезнаходжень пошукової системи й відповідних location_name можна отримати окремим запитом до https://api.dataforseo.com/v3/serp/google/locations

      Примітка: список країн, де AI Mode зараз доступний, див. у Google Search Help

    • os
      Тип: string | null

      операційна система пристрою

      необов'язкове поле

      якщо desktop вказано в полі device, вибирайте зі значень: windows, macos

      значення за замовчуванням: windows

      якщо mobile вказано в полі device, вибирайте зі значень: android, ios

      значення за замовчуванням: android

    • tag
      Тип: string | null

      визначений користувачем ідентифікатор завдання

      необов'язкове поле

      обмеження — 255 символів

      цей параметр дає змогу ідентифікувати завдання та зіставити його з результатом

      вказане значення tag ви знайдете в об'єкті data відповіді

Відповіді
  • 200
    Тип: object | null · Response36Afe1097B20_SerpGoogleAiModeLiveAdvancedResponseInfo
    • cost
      Тип: number | null Формат: double

      загальна вартість завдань, USD

    • status_code
      Тип: integer | null

      загальний код стану. Повний список кодів відповіді можна знайти тут.

    • status_message
      Тип: string | null

      загальне інформаційне повідомлення. Повний список загальних інформаційних повідомлень можна знайти тут.

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

      масив завдань

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

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

          • check_url
            Тип: string | null

            прямий URL до результатів пошукової системи
            за його допомогою можна переконатися, що ми надали точні результати

          • datetime
            Тип: string | null

            дата й час отримання результату
            у форматі UTC: “yyyy-mm-dd hh-mm-ss +00:00”
            приклад:
            2019-11-15 12:57:46 +00:00

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

            типи результатів пошуку в SERP
            містить типи результатів пошуку (items), знайдених у SERP.
            можливі типи елементів:
            ai_overview

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

            елементи, що входять до елемента

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

              елементи, що містяться в елементі

              • position
                Тип: string | null

                вирівнювання елемента в SERP
                може набувати таких значень:
                left, right

              • type
                Тип: string | null

                тип елемента

            • markdown
              Тип: string | null

              вміст елемента у форматі markdown
              текст ai_overview, відформатований мовою розмітки markdown

            • page
              Тип: integer | null

              сторінка SERP
              сторінка SERP, на якій ранжується елемент

            • position
              Тип: string | null

              вирівнювання елемента в SERP
              може набувати таких значень:
              left, right

            • rank_absolute
              Тип: integer | null

              абсолютний ранг у SERP
              абсолютна позиція серед усіх елементів у SERP

            • rank_group
              Тип: integer | null

              груповий ранг у SERP
              позиція всередині групи елементів з однаковими значеннями type
              позиції елементів з іншими значеннями type не враховуються в rank_group

            • rectangle
              Тип: object | null · Response36Afe1097B20_AiModeRectangleInfo

              параметри прямокутника
              містить декартові координати та розміри в пікселях сніпета результату в SERP
              дорівнює null, якщо calculate_rectangles у POST-запиті не встановлено в true

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

                висота елемента в пікселях

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

                ширина елемента в пікселях

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

                координата по осі x координата x лівого верхнього кута фрагмента результату, де початком координат є лівий верхній кут екрана

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

                координата по осі y координата y лівого верхнього кута фрагмента результату, де початком координат є лівий верхній кут екрана

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

              додаткові посилання, пов'язані з елементом
              містить посилання на вебсторінки, які могли використовуватися для генерації ai_overview

              • domain
                Тип: string | null

                доменне ім'я посилання

              • position
                Тип: string | null

                вирівнювання елемента в SERP
                може набувати таких значень:
                left, right

              • source
                Тип: string | null

                назва або заголовок джерела посилання

              • text
                Тип: string | null

                текст компонента

              • title
                Тип: string | null

                текст посилання (анкор)

              • type
                Тип: string | null

                тип елемента

              • url
                Тип: string | null

                URL посилання

            • type
              Тип: string | null

              тип елемента

            • xpath
              Тип: string | null

              XPath елемента

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

            кількість результатів, повернутих у масиві items

          • keyword
            Тип: string | null

            ключове слово, отримане в масиві POST
            ключове слово повертається з декодованими %## (символ '+' буде декодовано в пробіл)

          • language_code
            Тип: string | null

            код мови в масиві POST

          • location_code
            Тип: integer | null

            код місцеположення в масиві POST

          • refinement_chips
            Тип: object | null · Response36Afe1097B20_RefinementChipsInfo

            чипи уточнення пошуку
            у цьому випадку значення буде null

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

              дочірні елементи

              • domain
                Тип: string | null

                домен у SERP

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

                додаткові параметри уточнення пошуку

                • domain
                  Тип: string | null

                  домен у SERP

                • title
                  Тип: string | null

                  заголовок елемента

                • type
                  Тип: string | null

                  тип елемента

                • url
                  Тип: string | null

                  URL пошуку з параметрами уточнення

              • title
                Тип: string | null

                заголовок елемента

              • type
                Тип: string | null

                тип елемента

              • url
                Тип: string | null

                URL пошуку з параметрами уточнення

            • type
              Тип: string | null

              тип елемента

            • xpath
              Тип: string | null

              XPath елемента

          • se_domain
            Тип: string | null

            домен пошукової системи в масиві POST

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

            загальна кількість результатів у SERP

          • spell
            Тип: object | null · Response36Afe1097B20_SpellInfo

            автокорекція пошукової системи
            якщо пошукова система надала результати за виправленим ключовим словом, ми вкажемо виправлене пошуковою системою ключове слово та тип автокорекції;
            у цьому випадку значення буде null

            • keyword
              Тип: string | null

              ключове слово, отримане в результаті автокорекції пошукової системи результати буде надано для виправленого ключового слова

            • type
              Тип: string | null

              тип автокорекції можливі значення: did_you_mean, showing_results_for, no_results_found_for, including_results_for примітка: Yahoo і Yandex підтримують лише такий тип автокорекції: including_results_for

          • type
            Тип: string | null

            тип елемента

        • 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/serp/google/ai_mode/live/advanced
curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/ai_mode/live/advanced \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "keyword": "what is google ai mode"
  }
]'

{
  "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,
          "type": null,
          "se_domain": null,
          "location_code": null,
          "language_code": null,
          "check_url": null,
          "datetime": null,
          "spell": {
            "keyword": null,
            "type": null
          },
          "refinement_chips": {
            "type": null,
            "xpath": null,
            "items": [
              "[Max Depth Exceeded]"
            ]
          },
          "item_types": [
            null
          ],
          "se_results_count": null,
          "items_count": null,
          "items": [
            {
              "type": null,
              "rank_group": null,
              "rank_absolute": null,
              "page": null,
              "position": null,
              "xpath": null,
              "markdown": null,
              "items": [
                "[Max Depth Exceeded]"
              ],
              "references": [
                "[Max Depth Exceeded]"
              ],
              "rectangle": "[Max Depth Exceeded]"
            }
          ]
        }
      ]
    }
  ]
}

Успішна операція

Live Google AI Mode SERP