v0.2.0-beta

OpenAPI 3.1.0

Конкуренти в SERP

Felo API Support

MIT

Сервер

https://openapi.felo.ai

Клієнтські бібліотеки

Shell Curl

DataForSEO

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

DataForSEO Операції

post/v1/beta/dataforseo/dataforseo_labs/google/serp_competitors/live

Конкуренти в SERP

Домени, що ранжуються поруч із вами за набором keywords, і кількість спільних ключових слів. Повертає se_type, seed_keywords, total_count, items_count і items. Відповідь обгорнуто в конверт DataForSEO: дані в tasks[0].result, результат у tasks[0].status_code — відхилений запит усе одно повертає HTTP 200. ⚠️ Це пошукові конкуренти, визначені спільними позиціями. Еквівалент за графом посилань — post_dataforseo_backlinks_competitors_live, і ці два списки часто розходяться, що саме по собі інформативно.

Довідкова інформація про ціни

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

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

Тіло

application/json

Тип: array (object | null)[]
- filters
  Тип: array (object | null)[] | null
  
  масив параметрів фільтрації результатів
  необов'язкове поле
  можна додати кілька фільтрів одночасно (не більше 8)
  між умовами потрібно вказати логічний оператор and або or
  підтримуються такі оператори:
  regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like
  оператор % можна використовувати з like і not_like, а також з ilike і not_ilike для зіставлення будь-якого рядка з нуля або більше символів
  приклад:
  ["median_position","in",[1,10]]
  
  [["median_position","in",[1,10]],"and",["domain","not_like","%wikipedia.org%"]]
  
  [["domain","not_like","%wikipedia.org%"], "and", [["relevant_serp_items",">",0],"or",["median_position","in",[1,10]]]]
  Докладніше про фільтри — у Dataforseo Labs - Filters або в цьому посібнику довідкового центру
  
  Порожній об'єкт
- include_subdomains
  Тип: boolean | null
  
  вказує, чи буде включено піддомени в пошук
  необов'язкове поле
  якщо задано false, піддомени буде проігноровано
  значення за замовчуванням: true
- item_types
  Тип: array string[] | null
  
  тип результатів пошуку
  вказує тип результатів пошуку, що включаються у відповідь
  необов'язкове поле
  
  можливі значення:
  ["organic", "paid", "featured_snippet", "local_pack"]
  значення за замовчуванням:
  ["organic", "paid"]
- keywords
  Тип: array string[]
  
  масив ключових слів
  обов'язкове поле
  результати будуть ґрунтуватися на ключових словах, указаних у цьому масиві
  кодування UTF-8;
  ключові слова переводяться в нижній регістр;
  можна вказати не більше 200 ключових слів
  
  Докладніше про правила й обмеження полів keyword і keywords в API DataForSEO — у цій статті довідкового центру
- language_code
  Тип: string | null
  
  унікальний ідентифікатор мови
  обов'язкове поле, якщо не вказано language_name
  Примітка: необхідно вказати language_name або language_code
  список доступних мов із параметрами language_code можна отримати окремим запитом
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
  приклад:
  en
- language_name
  Тип: string
  
  повна назва мови
  обов'язкове поле, якщо не вказано language_code
  Примітка: необхідно вказати language_name або language_code
  список доступних мов із параметрами language_name можна отримати окремим запитом
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
  приклад:
  English
- limit
  Тип: integer | null
  
  максимальна кількість доменів, що повертаються
  необов'язкове поле
  значення за замовчуванням: 100
  максимальне значення: 1000
- location_code
  Тип: integer
  
  унікальний ідентифікатор місцезнаходження
  обов'язкове поле, якщо не вказано location_name
  Примітка: необхідно вказати location_name або location_code
  список доступних місцезнаходжень із параметрами location_code можна отримати окремим запитом
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
  приклад:
  2840
- location_name
  Тип: string
  
  повна назва місцезнаходження
  обов'язкове поле, якщо не вказано location_code
  Примітка: необхідно вказати location_name або 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 - результати сортуються за спаданням
  кома використовується як роздільник
  приклад:
  ["avg_position,asc"]
  правило за замовчуванням:
  ["rating,desc"]
  в одному запиті можна задати не більше трьох правил сортування
  кілька правил сортування потрібно розділяти комою
  приклад:
  ["avg_position,asc","etv,desc"]
- tag
  Тип: string | null
  
  визначений користувачем ідентифікатор завдання
  необов'язкове поле
  обмеження — 255 символів
  цей параметр дає змогу ідентифікувати завдання й зіставити його з результатом
  вказане значення tag ви знайдете в об'єкті data відповіді

Відповіді

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

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

status_code
Тип: integer | null

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

status_message
Тип: string | null

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

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

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

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

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

avg_position
Тип: number | null Формат: float

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

domain
Тип: string | null

ім'я домену виявленого конкурента в SERP

etv
Тип: number | null

оцінка обсягу трафіку
становить оцінюваний місячний трафік, який вказані ключові слова приводять на сайт
розраховується як сума добутків значень пошукового обсягу вказаних ключових слів і CTR (клікабельності) на певних позиціях у SERP
докладніше про те, як розраховується метрика, — у цій статті довідкового центру

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

кількість вказаних ключових слів, за якими домен має позиції в SERP

keywords_positions
Тип: object | null

позиції ключових слів
позиції в SERP, які відповідний домен займає за вказаними ключовими словами

propertyName
Тип: array (integer | null)[] | null
median_position
Тип: number | null

медіанна позиція домену за вказаними ключовими словами
медіана значень у масиві keywords_positions

rating
Тип: number | null

різниця між максимально можливою та фактичною позицією ключового слова
становить відносний показник видимості домену в SERP за вказаними ключовими словами
розраховується як sum(100-keywords_positions)

relevant_serp_items
Тип: integer | null

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

se_type
Тип: string | null

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

visibility
Тип: number | null

показник видимості в SERP
становить показник видимості сайту на основі позицій вказаних ключових слів у SERP
ключовим словам із позиціями в діапазоні від 1 до 10 присвоюється індекс видимості від 1 до 0,1 відповідно
ключові слова з позиціями від 11 до 20 мають фіксований індекс видимості 0,05
ключові слова з позиціями від 20 до 100 мають індекс видимості 0

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

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

language_code
Тип: string | null

код мови в масиві POST
якщо даних немає, значення — null

location_code
Тип: integer | null

код локації в масиві POST
якщо даних немає, значення — null

se_type
Тип: string | null

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

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

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

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

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

application/json

post/v1/beta/dataforseo/dataforseo_labs/google/serp_competitors/live

curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/serp_competitors/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "keywords": [
      "phone"
    ],
    "language_name": "English",
    "location_code": 2840,
    "item_types": [
      "organic"
    ],
    "limit": 5
  }
]'

Показати схему

{
  "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,
          "seed_keywords": [
            null
          ],
          "location_code": null,
          "language_code": null,
          "total_count": null,
          "items_count": null,
          "items": [
            {
              "se_type": null,
              "domain": null,
              "avg_position": null,
              "median_position": null,
              "rating": null,
              "etv": null,
              "keywords_count": null,
              "visibility": null,
              "relevant_serp_items": null,
              "keywords_positions": null
            }
          ]
        }
      ]
    }
  ]
}

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

Конкуренти в SERP

АвтентифікаціяRequired

DataForSEO

Конкуренти в SERP

Довідкова інформація про ціни