Live LLM Mentions Cross Aggregated Metrics
Live LLM Mentions endpoint provides aggregated metrics grouped by custom keys for mentions of the keywords or domains specified in the target array of the …
Documentation Index
Fetch the complete documentation index at: https://aisa.one/docs/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
array of objects containing target entities with aggregation keys required field you can specify up to 10, but not less than 2 target sets of parameters, each with its aggregation_key;example of a targets array with multiple entities: [{"aggregation_key":"bmw","target":[{"domain":"en.wikipedia.org","search_filter":"exclude"},{"keyword":"m5","match_type":"partial_match","search_scope":["answer"]}]},{"aggregation_key":"mercedes","target":[{"domain":"www.mercedes-benz.com","search_filter":"exclude"},{"keyword":"GLC","match_type":"word_match [blocked]"}]}]
aggregation key for grouping the results required field groups results for comparison and serves as a label for the group; you can specify up to 250 characters in the aggregation_key field
array of objects containing target entities required field a single target can contain up to 10 domain and/or keyword entities
target keyword required field if you don't specify a 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
domain entity in the target array example: {"domain": "en.wikipedia.org", "search_filter": "exclude", "search_scope": ["sources"]}
target keyword search filter optional field possible values: include, exclude default value: include
target keyword search scope optional field possible values: any, question, answer, brand_entities, fan_out_queries default value: any
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
keyword entity in the target array example: {"keyword": "bmw", "search_filter": "include", "search_scope": ["question"], "match_type ": "partial_match"}
target keyword match type defines how the specified keyword is matched optional field possible values: 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"); default value: word_match
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
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
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
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
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
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.
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: 10 default value: 5
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
Response
Successful response
the current version of the API
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
general informational message you can find the full list of general informational messages here
execution time, seconds
total tasks cost, USD
the number of tasks in the tasks array
the number of tasks in the tasks array returned with an error
array of tasks
task identifier unique task identifier in our system in the UUID format
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
informational message of the task you can find the full list of general informational messages here
execution time, seconds
cost of the task, USD
number of elements in the result array
URL path
contains the same parameters that you specified in the POST request
array of results
aggregated mentions metrics summary contains overall aggregated LLM mention metrics across all found domains, grouped by various dimensions
location-based grouping array of objects containing mention metrics segmented by geographical location
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
language-based grouping array of objects containing mention metrics segmented by content language
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
platform-based grouping array of group elements containing mention metrics segmented by AI platform
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
found top source domains relevant to the target array of objects containing data on top domains that are cited as sources in LLM responses
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension in this case the field displays a found domain name
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
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
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension in this case the field displays a found domain name
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
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
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension in this case the field displays a found brand entity title
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
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
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension in this case the field displays a found brand entity category
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
contains relevant mentions data
aggregation key received in a POST array
location-based grouping array of objects containing mention metrics segmented by geographical location
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
language-based grouping array of objects containing mention metrics segmented by content language
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
platform-based grouping array of group elements containing mention metrics segmented by AI platform
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
found top source domains relevant to the target array of objects containing data on top domains that are cited as sources in LLM responses
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension in this case the field displays a found domain name
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
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
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension in this case the field displays a found domain name
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
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
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension in this case the field displays a found brand entity title
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword
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
type of the element = 'group_element'
grouping identifier the specific identifier for the grouping dimension in this case the field displays a found brand entity category
total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain
current AI search volume rate of a keyword learn more about this metric here
current AI impressions rate of a keyword