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

Content Analysis — API розподілу рейтингів

Розбиває цитування ключового слова на діапазони рейтингу й повідомляє повний набір метрик для кожного. Повертає по одному запису на діапазон із min, max та об'єктом metrics, що містить total_count, rank, top_domains (кожен — domain і count), sentiment_connotations (anger, happiness, love, sadness, share, fun), connotation_types (positive, negative, neutral), text_categories, page_categories, page_types, countries і languages. rank_scale вибирає розбиття. Ті самі метрики без розбиття — post_dataforseo_content_summary_live; лише тональність — post_dataforseo_content_sentiment_analysis_live.

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

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

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

Тіло

application/json

Тип: array (object | null)[]
- initial_dataset_filters
  Тип: array (object | null)[] | null
  
  параметри фільтрації початкового набору даних
  необов'язкове поле
  початкові параметри фільтрації, що застосовуються до полів ендпоінта Search
  можна додати кілька фільтрів одразу (не більше 8 фільтрів)
  між умовами потрібно задати логічний оператор and або or
  підтримуються такі оператори:
  regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not, match, not_match
  оператор % можна використовувати з like і not_like для зіставлення будь-якого рядка з нуля або більше символів
  приклад:
  ["domain","<>", "logitech.com"]
  
  [["domain","<>","logitech.com"],"and",["content_info.connotation_types.negative",">",1000]]
  
  [["domain","<&gt","logitech.com"]], "and", [["content_info.connotation_types.negative",">",1000], "or",
  
  ["content_info.text_category","has",10994]]]
  докладніше про фільтри — в Content Analysis API - Filters
  докладніше про фільтри початкового набору даних — у цій статті довідкового центру.
  
  Порожній об'єкт
- internal_list_limit
  Тип: integer | null
  
  максимальна кількість елементів у внутрішніх масивах
  необов'язкове поле
  за допомогою цього поля можна обмежити кількість елементів у таких масивах:
  top_domains
  text_categories
  page_categories
  countries
  languages
  значення за замовчуванням: 1
  максимальне значення: 20
- 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
- page_type
  Тип: array string[] | null
  
  цільові типи сторінок
  необов'язкове поле
  використовуйте цей параметр для фільтрації набору даних за типами сторінок
  можливі значення:
  "ecommerce", "news", "blogs", "message-boards", "organization"
- positive_connotation_threshold
  Тип: number | null
  
  поріг позитивної конотації
  необов'язкове поле
  задається як поріг індексу ймовірності позитивної тональності, пов'язаної зі змістом цитування
  якщо вказати це поле, об'єкт connotation_types у відповіді міститиме лише дані про цитування з імовірністю positive тональності більшою або рівною вказаному значенню
  можливі значення: від 0 до 1
  значення за замовчуванням: 0.4
- rank_scale
  Тип: string | null
  
  задає шкалу для обчислення й відображення значень 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
- sentiments_connotation_threshold
  Тип: number | null
  
  поріг сентимент-конотації
  необов'язкове поле
  задається як поріг індексу ймовірності сентимент-конотацій, пов'язаних зі змістом цитування
  якщо вказати це поле, об'єкт sentiment_connotations у відповіді міститиме лише дані про цитування, у яких імовірність кожного сентименту більша або рівна вказаному значенню
  можливі значення: від 0 до 1
  значення за замовчуванням: 0.4
- tag
  Тип: string | null
  
  визначений користувачем ідентифікатор завдання
  необов'язкове поле
  обмеження — 255 символів
  цей параметр дає змогу ідентифікувати завдання й зіставити його з результатом
  вказане значення tag ви знайдете в об'єкті data відповіді

Відповіді

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

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

status_code
Тип: integer | null

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

status_message
Тип: string | null

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

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

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

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

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

max
Тип: number | null

максимальний рейтинг на шкалі розподілу

metrics
Тип: object | null · Response36Afe1097B20_ContentAnalysisSummaryInfo

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

connotation_types
Тип: object | null

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

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

Signed 64-bit integers (long type).

countries
Тип: object | null

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

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

Signed 64-bit integers (long type).

languages
Тип: object | null

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

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

Signed 64-bit integers (long type).

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

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

category
Тип: array (integer | null)[] | null
count
Тип: integer | null Формат: int64

Signed 64-bit integers (long type).

page_types
Тип: object | null

типи сторінок
містить типи сторінок і кількість цитувань за кожним типом сторінок

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

Signed 64-bit integers (long type).

rank
Тип: integer | null

ранг усіх URL, що цитують keyword
нормалізована сума рангів усіх URL, що цитують цільовий keyword

sentiment_connotations
Тип: object | null

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

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

Signed 64-bit integers (long type).

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

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

category
Тип: array (integer | null)[] | null
count
Тип: integer | null Формат: int64

Signed 64-bit integers (long type).

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

топдомени, що цитують цільове ключове слово
містить об'єкти з топдоменами, що цитують цільове ключове слово, та кількістю цитувань за кожним доменом

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

Signed 64-bit integers (long type).

domain
Тип: string | null
total_count
Тип: integer | null Формат: int64

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

type
Тип: string | null

тип елемента

min
Тип: number | null

мінімальний рейтинг на шкалі розподілу

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

post/v1/beta/dataforseo/content_analysis/rating_distribution/live

curl https://openapi.felo.ai/v1/beta/dataforseo/content_analysis/rating_distribution/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "keyword": "logitech",
    "search_mode": "as_is",
    "internal_list_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": [
        {
          "type": null,
          "min": null,
          "max": null,
          "metrics": {
            "type": null,
            "total_count": null,
            "rank": null,
            "top_domains": [
              "[Max Depth Exceeded]"
            ],
            "sentiment_connotations": null,
            "connotation_types": null,
            "text_categories": [
              "[Max Depth Exceeded]"
            ],
            "page_categories": [
              "[Max Depth Exceeded]"
            ],
            "page_types": null,
            "countries": null,
            "languages": null
          }
        }
      ]
    }
  ]
}

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

Content Analysis — API розподілу рейтингів

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

DataForSEO

Content Analysis — API розподілу рейтингів

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