Data API / DataForSEO / AI Optimization

Live LLM Mentions Aggregated Metrics

How often assistants mention your target, as totals rather than individual answers: total and items. ⚠️ target is an array of objects, each {"domain": "..."} or {"keyword": "..."}; a bare string is rejected as the wrong type and an array of strings as 'Each target item must be an object'. Filter fields come from get_dataforseo_ai_llm_mentions_available_filters. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. This is the headline visibility number; post_dataforseo_ai_llm_mentions_search_live shows the answers behind it, and post_dataforseo_ai_llm_mentions_cross_metrics_live compares several targets at once.

Параметры

Параметров пути, запроса и заголовков нет.

Тело запроса

targetobject[]Обязательный
array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parametersexamples: target array with a domain entity [{"domain": "en.wikipedia.org", "search_filter": "exclude"}] target array with a keyword entity [{"keyword": "bmw", "search_scope": ["question"], "match_type ": "partial_match"}] target array with multiple entities [{"domain": "en.wikipedia.org", "search_filter": "exclude"}, {"keyword": "bmw", "match_type ": "partial_match", "search_scope": ["answer"]}]
domainstringНеобязательный
target domain required field if you don't specify keyword you can specify up to 63 characters in the domain field; a domain should be specified without https:// and www.
keywordstringНеобязательный
target keyword required field if you don't specify domain you can specify up to 250 characters in the keyword field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
search_filterstringНеобязательный
Entity search filter: include or exclude; defaults to include.
search_scopestring[]Необязательный
Search scope. Domain entities: any, sources, search_results. Keyword entities: any, question, answer, brand_entities, fan_out_queries. Default: any.
include_subdomainsbooleanНеобязательный
indicates if the subdomains of the target domain will be included in the search optional field if set to true, the subdomains will be included in the search default value: false
match_typestringНеобязательный
target keyword match type optional field word_match - full-text search for terms that match the specified seed keyword with additional words included before, after, or within the key phrase (e.g., search for “light” will return results with “light bulb”, “light switch”); partial_match - substring search that finds all instances containing the specified sequence of characters, even if it appears inside a longer word (e.g., search for “light” will return results with “lighting”, “highlight”); possible values: word_match, partial_match default value: word_match
location_namestringНеобязательный
full name of search location optional field if you use this field, you don't need to specify location_code if you don't specify this field, the location_code with 2840 value will be used by default; you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages Note: chat_gpt data is available for United States only
location_codeintegerНеобязательный
search location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages default value: 2840 Note: chat_gpt data is available for 2840 only
language_namestringНеобязательный
full name of search language optional field if you use this field, you don't need to specify language_code; if you don't specify this field, the language_code with en value will be used by default; you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages Note: chat_gpt data is available for English only
language_codestringНеобязательный
search language code optional field if you use this field, you don't need to specify language_name; you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages default value: en Note: chat_gpt data is available for en onlyn
platformstringНеобязательный
target platform optional field possible values: chat_gpt, google default value: google Note: the data returned depends on the selected platform Note #2:chat_gpt data is available for the United States and English only
initial_dataset_filtersarrayНеобязательный
array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: =, , in, not_in, like, not_like, ilike, not_ilike, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["ai_search_volume",">","1000"]the full list of possible filters is available here. learn more about the initial dataset filters in this help center article.
internal_list_limitintegerНеобязательный
maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain search_results_domain minimum value: 1 maximum value: 20 default value: 10
tagstringНеобязательный
user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response

Пример запроса

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/ai_optimization/llm_mentions/aggregated_metrics/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": [
    {}
  ],
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "platform": "<string>",
  "initial_dataset_filters": "<string>",
  "internal_list_limit": 0
}'

Ответ

Поля ответа

versionstringНеобязательный
the current version of the API
status_codeintegerНеобязательный
general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_messagestringНеобязательный
general informational message you can find the full list of general informational messages here
timestringНеобязательный
execution time, seconds
costnumberНеобязательный
total tasks cost, USD
tasks_countintegerНеобязательный
the number of tasks in the tasks array
tasks_errorintegerНеобязательный
the number of tasks in the tasks array returned with an error
tasksstring[]Необязательный
array of tasks
idstringНеобязательный
task identifier unique task identifier in our system in the UUID format
status_codeintegerНеобязательный
status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here
status_messagestringНеобязательный
informational message of the task you can find the full list of general informational messages here
timestringНеобязательный
execution time, seconds
costnumberНеобязательный
cost of the task, USD
result_countintegerНеобязательный
number of elements in the result array
pathstring[]Необязательный
URL path
dataobjectНеобязательный
contains the same parameters that you specified in the POST request
resultstring[]Необязательный
array of results
totalobjectНеобязательный
aggregated mentions metrics summary contains overall aggregated LLM mention metrics across all found domains, grouped by various dimensions
locationstring[]Необязательный
location-based grouping array of objects containing mention metrics segmented by geographical location
typestringНеобязательный
type of the element = 'group_element'
keystringНеобязательный
grouping identifier the specific identifier for the grouping dimension
mentionsintegerНеобязательный
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key
ai_search_volumeintegerНеобязательный
current AI search volume rate of a keyword learn more about this metric here
impressionsintegerНеобязательный
current AI impressions rate of a keyword
languagestring[]Необязательный
language-based grouping array of objects containing mention metrics segmented by content language
typestringНеобязательный
type of the element = 'group_element'
keystringНеобязательный
grouping identifier the specific identifier for the grouping dimension
mentionsintegerНеобязательный
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key
ai_search_volumeintegerНеобязательный
current AI search volume rate of a keyword learn more about this metric here
impressionsintegerНеобязательный
current AI impressions rate of a keyword
platformstring[]Необязательный
platform-based grouping array of group elements containing mention metrics segmented by AI platform
typestringНеобязательный
type of the element = 'group_element'
keystringНеобязательный
grouping identifier the specific identifier for the grouping dimension
mentionsintegerНеобязательный
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key
ai_search_volumeintegerНеобязательный
current AI search volume rate of a keyword learn more about this metric here
impressionsintegerНеобязательный
current AI impressions rate of a keyword
sources_domainstring[]Необязательный
found top source domains relevant to the target array of objects containing data on top domains that are cited as sources in LLM responses
typestringНеобязательный
type of the element = 'group_element'
keystringНеобязательный
grouping identifier the specific identifier for the grouping dimension in this case the field displays a found domain name
mentionsintegerНеобязательный
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain
ai_search_volumeintegerНеобязательный
current AI search volume rate of a keyword learn more about this metric here
impressionsintegerНеобязательный
current AI impressions rate of a keyword
search_results_domainstring[]Необязательный
found top search results domains relevant to the target array of objects containing data on top domains that appear in search results related to LLM queries
typestringНеобязательный
type of the element = 'group_element'
keystringНеобязательный
grouping identifier the specific identifier for the grouping dimension in this case the field displays a found domain name
mentionsintegerНеобязательный
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain
ai_search_volumeintegerНеобязательный
current AI search volume rate of a keyword learn more about this metric here
impressionsintegerНеобязательный
current AI impressions rate of a keyword
brand_entities_titlestring[]Необязательный
data on brand entities relevant to the target array of objects containing data on brand entity titles that appear in search results related to LLM queries
typestringНеобязательный
type of the element = 'group_element'
keystringНеобязательный
grouping identifier the specific identifier for the grouping dimension in this case the field displays a found brand entity title
mentionsintegerНеобязательный
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain
ai_search_volumeintegerНеобязательный
current AI search volume rate of a keyword learn more about this metric here
impressionsintegerНеобязательный
current AI impressions rate of a keyword
brand_entities_categorystring[]Необязательный
data on brand entities relevant to the target array of objects containing data on brand entity categories that appear in search results related to LLM queries
typestringНеобязательный
type of the element = 'group_element'
keystringНеобязательный
grouping identifier the specific identifier for the grouping dimension in this case the field displays a found brand entity category
mentionsintegerНеобязательный
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain
ai_search_volumeintegerНеобязательный
current AI search volume rate of a keyword learn more about this metric here
impressionsintegerНеобязательный
current AI impressions rate of a keyword
itemsstring[]Необязательный
individual pages results array containing detailed mention metrics for each of the found top pages in this case, equals null