v0.2.0-beta

OpenAPI 3.1.0

Content Analysis — API пошуку

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/content_analysis/search/live

Content Analysis — API пошуку

Перелічує окремі сторінки, що цитують ключове слово, замість підсумків. Кожен елемент містить url, domain, main_domain, url_rank, domain_rank, spam_score, fetch_time, country, language, score і page_category разом із total_count та items_count. filters приймає поля, перелічені get_dataforseo_content_available_filters. Для підрахунків і розподілів замість сторінок використовуйте post_dataforseo_content_summary_live.

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

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

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

Тіло

application/json

Тип: array (object | null)[]
- filters
  Тип: array (object | null)[] | null
  
  масив параметрів фільтрації результатів
  необов'язкове поле
  можна додати кілька фільтрів одразу (не більше 8 фільтрів)
  між умовами потрібно задати логічний оператор and або or
  підтримуються такі оператори:
  regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, match, not_match
  оператор % можна використовувати з like і not_like для зіставлення будь-якого рядка з нуля або більше символів
  приклад:
  ["country","=", "US"]
  
  [["domain_rank",">",800],"and",["content_info.connotation_types.negative",">",0.9]]
  
  [["domain_rank",">",800], "and", [["page_types","has","ecommerce"], "or",
  
  ["content_info.text_category","has",10994]]]
  докладніше про фільтри — в Content Analysis API - Filters
  
  Порожній об'єкт
- keyword
  Тип: string
  
  цільове ключове слово
  обов'язкове поле
  кодування UTF-8
  ключові слова переводяться в нижній регістр;
  Примітка: щоб зіставити точну фразу, а не окреме ключове слово, використовуйте подвійні лапки та зворотні скісні риски.
  приклад:
  "keyword": "\"tesla palo alto\""
  
  Докладніше про правила й обмеження полів keyword і keywords в API DataForSEO — у цій статті довідкового центру
- keyword_fields
  Тип: object | null
  
  цільові поля ключових слів і цільові ключові слова
  необов'язкове поле
  використовуйте цей параметр, щоб фільтрувати набір даних за ключовими словами, які мають містити певні поля;
  поля, які можна вказати: title, main_title, previous_title, snippet
  можна вказати кілька полів;
  Примітка: щоб зіставити точну фразу, а не окреме ключове слово, використовуйте подвійні лапки та зворотні скісні риски.
  приклад:
  "keyword_fields": {<br>"snippet": "\"logitech mouse\"",<br>"main_title": "sale"<br>}
  
  propertyName
  Тип: string | null
- limit
  Тип: integer | null
  
  максимальна кількість цитувань, що повертаються
  необов'язкове поле
  значення за замовчуванням: 100
  максимальне значення: 1000
- offset
  Тип: integer | null
  
  зміщення в масиві результатів повернутих цитувань
  необов'язкове поле
  значення за замовчуванням: 0
  якщо вказати значення 10, перші десять цитувань у масиві результатів буде пропущено, а дані буде надано для наступних цитувань
  Примітка: рекомендуємо використовувати цей параметр лише під час отримання до 10 000 результатів
  для отримання понад 10 000 результатів використовуйте натомість offset_token.
- offset_token
  Тип: string | null
  
  токен зміщення для наступних запитів
  необов'язкове поле
  повертається в однойменному полі відповіді на кожен запит;
  використовуйте цей параметр, щоб уникнути тайм-аутів під час отримання понад 10 000 результатів за один запит;
  вказавши унікальне значення offset_token з масиву відповіді, ви отримаєте наступні результати початкового завдання;
  значення offset_token унікальні для кожного наступного завдання
  Примітка: якщо в запиті вказано offset_token, під час обробки завдання всі інші параметри, крім limit, не враховуються
  докладніше про цей параметр — у нашому довідковому центрі
- order_by
  Тип: array string[] | null
  
  правила сортування результатів
  необов'язкове поле
  для сортування результатів можна використовувати ті самі значення, що й у масиві filters
  можливі типи сортування:
  asc - результати сортуються за зростанням
  desc - результати сортуються за спаданням
  тип сортування задається комою
  приклад:
  ["content_info.sentiment_connotations.anger,desc"]
  правило за замовчуванням:
  ["content_info.sentiment_connotations.anger,desc"]
  зверніть увагу: в одному запиті можна задати не більше трьох правил сортування
  кілька правил сортування розділяються комою
  приклад:
  ["content_info.sentiment_connotations.anger,desc","keyword_data.keyword_info.cpc,desc"]
- page_type
  Тип: array string[] | null
  
  цільові типи сторінок
  необов'язкове поле
  використовуйте цей параметр для фільтрації набору даних за типами сторінок
  можливі значення:
  "ecommerce", "news", "blogs", "message-boards", "organization"
- rank_scale
  Тип: string | null
  
  задає шкалу для обчислення й відображення значень domain_rank і url_rank
  необов'язкове поле
  
  цей параметр дозволяє вибрати, чи відображаються значення рейтингу за шкалою 0–100 або 0–1000
  
  можливі значення:
  one_hundred — значення рейтингу відображаються за шкалою 0–100
  one_thousand — значення рейтингу відображаються за шкалою 0–1000
  
  значення за замовчуванням: one_thousand
  
  докладніше про роботу цього параметра — у цій статті довідкового центру
- search_mode
  Тип: string | null
  
  тип групування результатів
  необов'язкове поле
  можливі типи групування:
  as_is - повертає всі цитування для цільового keyword
  one_per_domain - повертає одне цитування keyword на домен
  значення за замовчуванням: as_is
- tag
  Тип: string | null
  
  визначений користувачем ідентифікатор завдання
  необов'язкове поле
  обмеження — 255 символів
  цей параметр дає змогу ідентифікувати завдання й зіставити його з результатом
  вказане значення tag ви знайдете в об'єкті data відповіді

Відповіді

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

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

status_code
Тип: integer | null

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

status_message
Тип: string | null

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

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

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

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

містить цитування та пов'язані дані

content_info
Тип: object | null · Response36Afe1097B20_AnalysisContentInfo

містить дані про цитування з указаного url

author
Тип: string | null

автор вмісту

connotation_types
Тип: object | null

типи конотації
містить типи тональності (полярність тональності), пов'язані з наведеною цитатою, та індекс імовірності для кожного типу тональності
можливі типи конотації тональності: positive, negative, neutral

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

Signed 64-bit integers (long type).

content_quality_score
Тип: integer | null

оцінка якості вмісту
це значення розраховується на основі кількості слів, речень і символів у вмісті

content_type
Тип: string | null

тип вмісту
приклад:
page_content, comment

date_published
Тип: string | null

дата й час публікації вмісту
у форматі UTC: "yyyy-mm-dd hh-mm-ss +00:00"
приклад:
2017-01-24 13:20:59 +00:00

group_date
Тип: string | null

дата й час групи цитувань
указує дату публікації вмісту або дату й час першого відвідування сторінки нашим сканером;
це поле можна використовувати для групування цитат за датою та відображення динаміки цитувань;
дата й час наводяться у форматі UTC: "yyyy-mm-dd hh-mm-ss +00:00"
приклад:
2017-01-24 13:20:59 +00:00

highlighted_text
Тип: string | null

виділений текст із snippet

language
Тип: string | null

основна мова домену
щоб отримати повний список доступних мов, зверніться до ендпоінта Languages

level
Тип: integer | null

рівень заголовка title
указує рівень h-тегу від 1 (верхній) до 6 (нижній)

main_title
Тип: string | null

заголовок сторінки

previous_title
Тип: string | null

заголовок попереднього блоку вмісту

rating
Тип: object | null · Response36Afe1097B20_ContententRatingInfo

рейтинг вмісту
рейтинг, пов'язаний з content_info

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

максимальне значення для назви рейтингу

name
Тип: string | null

назва рейтингу тут можна знайти такі елементи: Max5, Percents, CustomMax

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

кількість голосів

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

значення рейтингу

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

відносний рейтинг

semantic_location
Тип: string | null

семантичне місцезнаходження
указує семантичний елемент HTML, у якому розташоване цитування цільового ключового слова
приклад:
article, header

sentiment_connotations
Тип: object | null

конотації тональності
містить тональності (емоційні реакції), пов'язані з наведеною цитатою, та індекс імовірності для кожної тональності
можливі конотації тональності: anger, happiness, love, sadness, share, fun

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

Signed 64-bit integers (long type).

snippet
Тип: string | null

фрагмент вмісту

snippet_length
Тип: integer | null

довжина фрагмента в символах

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

метрики залученості в соціальних мережах
дані про взаємодії в соціальних мережах, пов'язані з контентом, на основі вебвбудовувань, розроблених і підтримуваних соціальними платформами

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

кількість уподобань

type
Тип: string | null

тип елемента

text_category
Тип: array integer[] | null

категорія тексту
повний список доступних категорій див. в ендпоінті Categories

title
Тип: string | null

заголовок результату

country
Тип: string | null

код країни реєстрації домену
щоб отримати повний список доступних країн, зверніться до ендпоінта Locations

domain
Тип: string | null

ім'я домену

domain_rank
Тип: integer | null

ранг domain
це значення базується на даних про посилання для вказаного домену з DataForSEO Backlink Index;
domain_rank розраховується за методом ранжування вузлів у зв'язаній базі даних — принципом, використаним в оригінальному алгоритмі Google PageRank
Докладніше про цю метрику та спосіб її розрахунку — у цій статті довідкового центру

fetch_time
Тип: string | null

дата й час відвідування сторінки нашим краулером
у форматі UTC: "yyyy-mm-dd hh-mm-ss +00:00"
приклад:
2017-01-24 13:20:59 +00:00

language
Тип: string | null

основна мова домену
щоб отримати повний список доступних мов, зверніться до ендпоінта Languages

main_domain
Тип: string | null

основний домен

page_category
Тип: array integer[] | null

містить усі релевантні категорії сторінки
категорії продуктів і послуг, релевантні для сторінки
щоб отримати повний список доступних категорій, зверніться до ендпоінта Categories

page_types
Тип: array string[] | null

типи сторінок

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

рейтинги, знайдені на сторінці
усі рейтинги, знайдені на сторінці, на основі мікроданих

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

максимальне значення для назви рейтингу

name
Тип: string | null

назва рейтингу тут можна знайти такі елементи: Max5, Percents, CustomMax

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

кількість голосів

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

значення рейтингу

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

відносний рейтинг

score
Тип: number | null

оцінка значущості цитування
це значення базується на url_rank, domain_rank, наявності keyword у title, main_title, url, snippet
що вищий score, то цінніше відповідне цитування

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

метрики залученості в соціальних мережах
дані про взаємодії в соціальних мережах, пов'язані з контентом, на основі вебвбудовувань, розроблених і підтримуваних соціальними платформами

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

кількість уподобань

type
Тип: string | null

тип елемента

spam_score
Тип: integer | null

показник спамності зворотних посилань для url
це значення базується на даних про посилання для вказаного URL з DataForSEO Backlink Index;
Докладніше про те, як розраховується ця метрика, — на цій сторінці довідкового центру

type
Тип: string | null

тип елемента

url
Тип: string | null

URL, на якому знайдено цитування

url_rank
Тип: integer | null

ранг url
це значення базується на даних про посилання для вказаного URL з DataForSEO Backlink Index;
url_rank розраховується за методом ранжування вузлів у зв'язаній базі даних — принципом, використаним в оригінальному алгоритмі Google PageRank
Докладніше про цю метрику та спосіб її розрахунку — у цій статті довідкового центру

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

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

offset_token
Тип: string | null

токен зміщення для наступних запитів
рядок із цього поля можна використати для отримання наступних результатів початкового завдання;
примітка: значення offset_token унікальні для кожного наступного завдання

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/content_analysis/search/live

curl https://openapi.felo.ai/v1/beta/dataforseo/content_analysis/search/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "keyword_fields": {
      "snippet": "logitech"
    },
    "keyword": "logitech",
    "page_type": [
      "ecommerce",
      "news",
      "blogs",
      "message-boards",
      "organization"
    ],
    "search_mode": "as_is",
    "filters": [
      "main_domain",
      "=",
      "reviewfinder.ca"
    ],
    "order_by": [
      "content_info.sentiment_connotations.anger,desc"
    ],
    "limit": 10
  }
]'

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

{
  "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": [
        {
          "offset_token": null,
          "total_count": null,
          "items_count": null,
          "items": [
            {
              "type": null,
              "url": null,
              "domain": null,
              "main_domain": null,
              "url_rank": null,
              "spam_score": null,
              "domain_rank": null,
              "fetch_time": null,
              "country": null,
              "language": null,
              "score": null,
              "page_category": [
                "[Max Depth Exceeded]"
              ],
              "page_types": [
                "[Max Depth Exceeded]"
              ],
              "ratings": [
                "[Max Depth Exceeded]"
              ],
              "social_metrics": [
                "[Max Depth Exceeded]"
              ],
              "content_info": "[Max Depth Exceeded]"
            }
          ]
        }
      ]
    }
  ]
}

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

Content Analysis — API пошуку

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

DataForSEO

Content Analysis — API пошуку

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