v0.2.0-beta

OpenAPI 3.1.0

Live-агрегированные метрики LLM Mentions

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/ai_optimization/llm_mentions/aggregated_metrics/live

Live-агрегированные метрики LLM Mentions

Как часто ассистенты упоминают вашу цель — в виде итогов, а не отдельных ответов: total и items. ⚠️ target — это массив объектов, каждый {"domain": "..."} или {"keyword": "..."}; строка сама по себе отклоняется как неверный тип, а массив строк — с сообщением 'Each target item must be an object'. Поля фильтра берутся из get_dataforseo_ai_llm_mentions_available_filters. Упаковано в конверт DataForSEO: данные в tasks[0].result, результат в tasks[0].status_code — отклонённый запрос всё равно возвращает HTTP 200. Это главный показатель видимости; post_dataforseo_ai_llm_mentions_search_live показывает ответы за ним, а post_dataforseo_ai_llm_mentions_cross_metrics_live сравнивает несколько целей сразу.

Справочная информация о цене

Тарификация: по заявленной стоимости ответа.
Ориентировочная стоимость запроса: 0.101 USD.
Справочный коэффициент клиента: 1.0. Не применяйте его повторно к уже рассчитанной сумме клиента.

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

Тело

обязательно

application/json

Тип: array object[]
- target
  Тип: array object[]
  обязательно
  
  массив объектов с целевыми сущностями. Обязательное поле. В поле target можно указать до 10 сущностей (объектов). Одна целевая сущность может содержать либо один домен, либо одно ключевое слово и связанные параметры. Примеры: массив target с сущностью-доменом [{"domain": "en.wikipedia.org", "search_filter": "exclude"}] / массив target с сущностью-ключевым словом [{"keyword": "bmw", "search_scope": ["question"], "match_type ": "partial_match"}] / массив target с несколькими сущностями [{"domain": "en.wikipedia.org", "search_filter": "exclude"}, {"keyword": "bmw", "match_type ": "partial_match", "search_scope": ["answer"]}]
  
  domain
  Тип: string
  обязательно
  
  целевой домен. Обязательное поле, если не указано keyword. В поле domain можно указать до 63 символов; домен указывается без https:// и www.
  
  include_subdomains
  Тип: boolean
  
  указывает, будут ли поддомены целевого домена включены в поиск. Необязательное поле. Если задано true, поддомены включаются в поиск. Значение по умолчанию: false.
  
  keyword
  Тип: string
  
  целевое ключевое слово. Обязательное поле, если не указан domain. В поле keyword можно указать до 250 символов. Все %## будут декодированы (символ «+» декодируется в пробел). Если в keyword нужен символ «%», укажите его как «%25»; если нужен символ «+», укажите его как «%2B». Подробнее о правилах и ограничениях полей keyword и keywords в API DataForSEO читайте в этой статье Help Center.
  
  match_type
  Тип: string
  
  тип совпадения целевого ключевого слова. Необязательное поле. word_match — полнотекстовый поиск по терминам, совпадающим с заданным исходным ключевым словом, с дополнительными словами до, после или внутри ключевой фразы (например, по запросу «light» будут найдены результаты «light bulb», «light switch»); partial_match — поиск по подстроке, который находит все вхождения заданной последовательности символов, даже если она встречается внутри более длинного слова (например, по запросу «light» будут найдены результаты «lighting», «highlight»). Возможные значения: word_match, partial_match. Значение по умолчанию: word_match.
  
  search_filter
  Тип: string
  
  фильтр поиска сущностей: include или exclude; по умолчанию include.
  
  search_scope
  Тип: array string[]
  
  область поиска. Для сущностей-доменов: any, sources, search_results. Для сущностей-ключевых слов: any, question, answer, brand_entities, fan_out_queries. Значение по умолчанию: any.
- initial_dataset_filters
  Тип: array
  
  массив выражений фильтра, применяемых перед агрегацией. Необязательное поле. Этот массив позволяет отфильтровать выражения, применяемые к базе упоминаний до агрегации, чтобы ограничить строки, попадающие в результат. Можно добавить сразу несколько фильтров (максимум 8); между условиями следует задать логический оператор and или or. Поддерживаются следующие операторы: =, , in, not_in, like, not_like, ilike, not_ilike, match, not_match. С операторами like и not_like можно использовать оператор %, чтобы сопоставить любую строку из нуля или более символов. Пример: ["ai_search_volume",">","1000"]. Полный список возможных фильтров доступен здесь. Подробнее о фильтрах исходного набора данных см. в этой статье Help Center.
- internal_list_limit
  Тип: integer
  
  максимальное число элементов во внутренних массивах. Необязательное поле. С его помощью можно ограничить число элементов в следующих массивах: sources_domain, search_results_domain. Минимальное значение: 1, максимальное значение: 20, значение по умолчанию: 10.
- language_code
  Тип: string
  
  код языка поиска. Необязательное поле. Если используете это поле, указывать language_name не нужно. Список доступных языков поисковой системы с их language_code можно получить отдельным запросом к https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages. Значение по умолчанию: en. Примечание: данные chat_gpt доступны только для en.
- language_name
  Тип: string
  
  полное название языка поиска. Необязательное поле. Если используете это поле, указывать language_code не нужно; если поле не указано, по умолчанию используется language_code со значением en. Список доступных языков поисковой системы с их language_name можно получить отдельным запросом к https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages. Примечание: данные chat_gpt доступны только на английском языке.
- location_code
  Тип: integer
  
  код местоположения поиска. Необязательное поле. Если используете это поле, указывать location_name не нужно. Список доступных местоположений поисковой системы с их location_code можно получить отдельным запросом к https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages. Значение по умолчанию: 2840. Примечание: данные chat_gpt доступны только для 2840.
- location_name
  Тип: string
  
  полное название местоположения поиска. Необязательное поле. Если используете это поле, указывать location_code не нужно; если поле не указано, по умолчанию используется location_code со значением 2840. Список доступных местоположений поисковой системы с их location_name можно получить отдельным запросом к https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages. Примечание: данные chat_gpt доступны только для United States.
- platform
  Тип: string
  
  целевая платформа. Необязательное поле. Возможные значения: chat_gpt, google. Значение по умолчанию: google. Примечание: возвращаемые данные зависят от выбранной платформы. Примечание #2: данные chat_gpt доступны только для США и английского языка.
- tag
  Тип: string
  
  пользовательский идентификатор задачи. Необязательное поле. Ограничение — 255 символов. Этот параметр позволяет идентифицировать задачу и сопоставить её с результатом. Указанное значение tag вы найдёте в объекте data ответа.

Ответы

200
Тип: object

Успешный ответ
cost
Тип: number

общая стоимость задач, USD

status_code
Тип: integer

общий код состояния. Полный список кодов ответа можно найти здесь. Примечание: мы настоятельно рекомендуем предусмотреть систему обработки связанных исключительных ситуаций и ошибок.

status_message
Тип: string

общее информационное сообщение. Полный список общих информационных сообщений можно найти здесь.

tasks
Тип: array string[]

массив задач

tasks_count
Тип: integer

число задач в массиве tasks

tasks_error
Тип: integer

число задач в массиве tasks, возвращённых с ошибкой

tasks.cost
Тип: number

стоимость задачи, USD

tasks.data
Тип: object

содержит те же параметры, что вы указали в POST-запросе

tasks.id
Тип: string

идентификатор задачи. Уникальный идентификатор задачи в нашей системе в формате UUID.

tasks.path
Тип: array string[]

путь URL

tasks.result
Тип: array string[]

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

tasks.result_count
Тип: integer

число элементов в массиве result

tasks.result.items
Тип: array string[]

массив результатов по отдельным страницам с подробными метриками упоминаний для каждой найденной верхней страницы; в данном случае равен null.

tasks.result.total
Тип: object

сводка агрегированных метрик упоминаний. Содержит общие агрегированные метрики LLM-упоминаний по всем найденным доменам с группировкой по различным измерениям.

tasks.result.total.brand_entities_category
Тип: array string[]

данные о сущностях брендов, относящихся к цели. Массив объектов с данными о категориях сущностей брендов, встречающихся в результатах поиска по LLM-запросам.

tasks.result.total.brand_entities_category.ai_search_volume
Тип: integer

текущий показатель объёма AI-поиска для ключевого слова. Подробнее об этой метрике здесь.

tasks.result.total.brand_entities_category.impressions
Тип: integer

текущий показатель AI-показов для ключевого слова.

tasks.result.total.brand_entities_category.key
Тип: string

идентификатор группировки. Конкретный идентификатор измерения группировки; в данном случае поле содержит найденную категорию сущности бренда.

tasks.result.total.brand_entities_category.mentions
Тип: integer

общее число LLM-упоминаний. Количество упоминаний целевого ключевого слова или домена в связи с конкретным доменом.

tasks.result.total.brand_entities_category.type
Тип: string

тип элемента = 'group_element'

tasks.result.total.brand_entities_title
Тип: array string[]

данные о сущностях брендов, относящихся к цели. Массив объектов с данными о названиях сущностей брендов, встречающихся в результатах поиска по LLM-запросам.

tasks.result.total.brand_entities_title.ai_search_volume
Тип: integer

текущий показатель объёма AI-поиска для ключевого слова. Подробнее об этой метрике здесь.

tasks.result.total.brand_entities_title.impressions
Тип: integer

текущий показатель AI-показов для ключевого слова.

tasks.result.total.brand_entities_title.key
Тип: string

идентификатор группировки. Конкретный идентификатор измерения группировки; в данном случае поле содержит найденное название сущности бренда.

tasks.result.total.brand_entities_title.mentions
Тип: integer

общее число LLM-упоминаний. Количество упоминаний целевого ключевого слова или домена в связи с конкретным доменом.

tasks.result.total.brand_entities_title.type
Тип: string

тип элемента = 'group_element'

tasks.result.total.language
Тип: array string[]

группировка по языку. Массив объектов с метриками упоминаний в разрезе языка контента.

tasks.result.total.language.ai_search_volume
Тип: integer

текущий показатель объёма AI-поиска для ключевого слова. Подробнее об этой метрике здесь.

tasks.result.total.language.impressions
Тип: integer

текущий показатель AI-показов для ключевого слова.

tasks.result.total.language.key
Тип: string

идентификатор группировки. Конкретный идентификатор измерения группировки.

tasks.result.total.language.mentions
Тип: integer

общее число LLM-упоминаний. Количество упоминаний целевого ключевого слова или домена в связи с данным ключом группировки.

tasks.result.total.language.type
Тип: string

тип элемента = 'group_element'

tasks.result.total.location
Тип: array string[]

группировка по местоположению. Массив объектов с метриками упоминаний в разрезе географического местоположения.

tasks.result.total.location.ai_search_volume
Тип: integer

текущий показатель объёма AI-поиска для ключевого слова. Подробнее об этой метрике здесь.

tasks.result.total.location.impressions
Тип: integer

текущий показатель AI-показов для ключевого слова.

tasks.result.total.location.key
Тип: string

идентификатор группировки. Конкретный идентификатор измерения группировки.

tasks.result.total.location.mentions
Тип: integer

общее число LLM-упоминаний. Количество упоминаний целевого ключевого слова или домена в связи с данным ключом группировки.

tasks.result.total.location.type
Тип: string

тип элемента = 'group_element'

tasks.result.total.platform
Тип: array string[]

группировка по платформе. Массив групповых элементов с метриками упоминаний в разрезе AI-платформы.

tasks.result.total.platform.ai_search_volume
Тип: integer

текущий показатель объёма AI-поиска для ключевого слова. Подробнее об этой метрике здесь.

tasks.result.total.platform.impressions
Тип: integer

текущий показатель AI-показов для ключевого слова.

tasks.result.total.platform.key
Тип: string

идентификатор группировки. Конкретный идентификатор измерения группировки.

tasks.result.total.platform.mentions
Тип: integer

общее число LLM-упоминаний. Количество упоминаний целевого ключевого слова или домена в связи с данным ключом группировки.

tasks.result.total.platform.type
Тип: string

тип элемента = 'group_element'

tasks.result.total.search_results_domain
Тип: array string[]

найденные верхние домены результатов поиска, относящиеся к цели. Массив объектов с данными о верхних доменах, встречающихся в результатах поиска по LLM-запросам.

tasks.result.total.search_results_domain.ai_search_volume
Тип: integer

текущий показатель объёма AI-поиска для ключевого слова. Подробнее об этой метрике здесь.

tasks.result.total.search_results_domain.impressions
Тип: integer

текущий показатель AI-показов для ключевого слова.

tasks.result.total.search_results_domain.key
Тип: string

идентификатор группировки. Конкретный идентификатор измерения группировки; в данном случае поле содержит найденное имя домена.

tasks.result.total.search_results_domain.mentions
Тип: integer

общее число LLM-упоминаний. Количество упоминаний целевого ключевого слова или домена в связи с конкретным доменом.

tasks.result.total.search_results_domain.type
Тип: string

тип элемента = 'group_element'

tasks.result.total.sources_domain
Тип: array string[]

найденные верхние домены-источники, относящиеся к цели. Массив объектов с данными о верхних доменах, которые цитируются как источники в ответах LLM.

tasks.result.total.sources_domain.ai_search_volume
Тип: integer

текущий показатель объёма AI-поиска для ключевого слова. Подробнее об этой метрике здесь.

tasks.result.total.sources_domain.impressions
Тип: integer

текущий показатель AI-показов для ключевого слова.

tasks.result.total.sources_domain.key
Тип: string

идентификатор группировки. Конкретный идентификатор измерения группировки; в данном случае поле содержит найденное имя домена.

tasks.result.total.sources_domain.mentions
Тип: integer

общее число LLM-упоминаний. Количество упоминаний целевого ключевого слова или домена в связи с конкретным доменом.

tasks.result.total.sources_domain.type
Тип: string

тип элемента = 'group_element'

tasks.status_code
Тип: integer

код состояния задачи, сформированный DataForSEO; может находиться в диапазоне 10000-60000. Полный список кодов ответа можно найти здесь.

tasks.status_message
Тип: string

информационное сообщение задачи. Полный список общих информационных сообщений можно найти здесь.

tasks.time
Тип: string

время выполнения, секунды

time
Тип: string

время выполнения, секунды

version
Тип: string

текущая версия API
application/json
400

Запрос не удалось обработать. Проверьте параметры запроса.
401

Требуется действительный API-ключ Felo.
402

Запрос не может быть выполнен: не выполнено требование биллинга.
403

Аккаунту не разрешено выполнять эту операцию.
429

Достигнут лимит запросов или расходов.
502

Сервис не смог выполнить запрос.
503

API или сервис биллинга временно недоступны.
504

Истекло время ожидания обработки запроса.
default

Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

application/json

post/v1/beta/dataforseo/ai_optimization/llm_mentions/aggregated_metrics/live

curl https://openapi.felo.ai/v1/beta/dataforseo/ai_optimization/llm_mentions/aggregated_metrics/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": [
      {
        "domain": "en.wikipedia.org"
      }
    ]
  }
]'

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

{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.total": {},
  "tasks.result.total.location": [
    "string"
  ],
  "tasks.result.total.location.type": "string",
  "tasks.result.total.location.key": "string",
  "tasks.result.total.location.mentions": 1,
  "tasks.result.total.location.ai_search_volume": 1,
  "tasks.result.total.location.impressions": 1,
  "tasks.result.total.language": [
    "string"
  ],
  "tasks.result.total.language.type": "string",
  "tasks.result.total.language.key": "string",
  "tasks.result.total.language.mentions": 1,
  "tasks.result.total.language.ai_search_volume": 1,
  "tasks.result.total.language.impressions": 1,
  "tasks.result.total.platform": [
    "string"
  ],
  "tasks.result.total.platform.type": "string",
  "tasks.result.total.platform.key": "string",
  "tasks.result.total.platform.mentions": 1,
  "tasks.result.total.platform.ai_search_volume": 1,
  "tasks.result.total.platform.impressions": 1,
  "tasks.result.total.sources_domain": [
    "string"
  ],
  "tasks.result.total.sources_domain.type": "string",
  "tasks.result.total.sources_domain.key": "string",
  "tasks.result.total.sources_domain.mentions": 1,
  "tasks.result.total.sources_domain.ai_search_volume": 1,
  "tasks.result.total.sources_domain.impressions": 1,
  "tasks.result.total.search_results_domain": [
    "string"
  ],
  "tasks.result.total.search_results_domain.type": "string",
  "tasks.result.total.search_results_domain.key": "string",
  "tasks.result.total.search_results_domain.mentions": 1,
  "tasks.result.total.search_results_domain.ai_search_volume": 1,
  "tasks.result.total.search_results_domain.impressions": 1,
  "tasks.result.total.brand_entities_title": [
    "string"
  ],
  "tasks.result.total.brand_entities_title.type": "string",
  "tasks.result.total.brand_entities_title.key": "string",
  "tasks.result.total.brand_entities_title.mentions": 1,
  "tasks.result.total.brand_entities_title.ai_search_volume": 1,
  "tasks.result.total.brand_entities_title.impressions": 1,
  "tasks.result.total.brand_entities_category": [
    "string"
  ],
  "tasks.result.total.brand_entities_category.type": "string",
  "tasks.result.total.brand_entities_category.key": "string",
  "tasks.result.total.brand_entities_category.mentions": 1,
  "tasks.result.total.brand_entities_category.ai_search_volume": 1,
  "tasks.result.total.brand_entities_category.impressions": 1,
  "tasks.result.items": [
    "string"
  ]
}

Успешный ответ

Нужна помощь?

По вопросам API, оплаты и аккаунта пишите в поддержку.
Общайтесь с разработчиками Felo в Discord.
Загляните в наш журнал изменений.
Нужны цены за объём или помощь с закупкой? Связаться с отделом продаж.
Создаёте на LLM? Прочитайте llms.txt.

Live-агрегированные метрики LLM Mentions

АутентификацияRequired

DataForSEO

Live-агрегированные метрики LLM Mentions

Справочная информация о цене

Нужна помощь?