v0.2.0-beta

OpenAPI 3.1.0

Піддомени

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/subdomains/live

Піддомени

Піддомени target і пошуковий слід кожного. Посторінкова видача через limit, offset і offset_token; після перших сторінок використовуйте токен. Відповідь обгорнуто в конверт DataForSEO: дані в tasks[0].result, результат у tasks[0].status_code — відхилений запит усе одно повертає HTTP 200. Корисно, коли трафік домену зосереджений не на www: піддомен документації або блогу, що несе сайт, невидимий у post_dataforseo_labs_google_domain_rank_overview_live.

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

Тарифікація: заявлена вартість відповіді.
Довідкова оцінка запиту: USD 0.1356.
Довідковий множник для клієнта: 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.paid.count",">",0],"and",["metrics.paid.etv",">","50"]]
  
  [["metrics.organic.count",">","10"], "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_DataforseoLabsGoogleSubdomainsLiveResponseInfo
cost
Тип: number | null Формат: double

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

status_code
Тип: integer | null

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

status_message
Тип: string | null

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

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

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

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

se_type
Тип: string | null

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

subdomain
Тип: string | null

повернутий піддомен

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

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

language_code
Тип: string | null

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

location_code
Тип: integer | null

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

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

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

application/json

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

curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/subdomains/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "dataforseo.com",
    "language_name": "English",
    "location_code": 2840,
    "filters": [
      [
        "metrics.organic.pos_1",
        "<>",
        0
      ],
      "or",
      [
        "metrics.organic.pos_2_3",
        "<>",
        0
      ]
    ]
  }
]'

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

{
  "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,
              "subdomain": null,
              "metrics": null
            }
          ]
        }
      ]
    }
  ]
}

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

Піддомени

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

DataForSEO

Піддомени

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