target | array | 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 parameters examples: 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"]}] Note: requests must include at least one domain_entity or keyword_entity with "search_filter": "include". |
domain_entity | object | domain entity in the target array example:
{"domain": "en.wikipedia.org", "search_filter": "exclude", "search_scope": ["sources"]} |
domain | string | 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. |
search_filter | string | target domain search filter optional field possible values:
include, exclude default value: include |
search_scope | array | target domain search scope optional field possible values:
any, sources, search_results default value: any |
include_subdomains | boolean | 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 | object | keyword entity in the target array example:
{"keyword": "bmw", "search_filter": "include", "search_scope": ["question"], "match_type ": "partial_match"} |
keyword | string | 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_filter | string | target keyword search filter optional field possible values:
include, exclude default value: include |
search_scope | array | target keyword search scope optional field possible values:
any, question, answer, brand_entities, fan_out_queries default value: any |
match_type | string | target keyword match type optional field possible values:
word_match, partial_match
word_match - full-text search for terms that match the specified seed keyword with additional words included before, after, or within the seed key phrase.
partial_match - searches for any occurrence of the keyword or its parts within the content default value: word_match |
location_name | string | 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_code | integer | 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_name | string | 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_code | string | 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 |
platform | string | target platform optional field possible values:
chat_gpt, google default value: google Note: if the platform is not specified, the data is returned for both platforms Note #2:chat_gpt data is available for the United States and English only |
links_scope | string | links source scope optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: sources, search_results default value: sources |
filters | array | array of results filtering parameters optional field 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. |
initial_dataset_filters | array | 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. |
limit | integer | maximum number of results in the items array optional field you can use this parameter to limit the number of data objects you receive in the items array minimum value: 1 maximum value: 1000 default value: 100 |
internal_list_limit | integer | 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, brand_entities_title, brand_entities_category minimum value: 1 maximum value: 10 default value: 5 |
order_by | array | results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types:
asc - results will be sorted in the ascending order
desc - results will be sorted in the descending order you should use a comma to set up a sorting type example:
["ai_search_volume,desc"] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules |
offset | integer | offset in the results array of the returned mentions data optional field default value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects; Note: the maximum value is 1000000 |
include_domains | array | array of domains to include in the response optional field if specified, only the listed domains will be returned in the items array example:
["dataforseo.com","seoinsider.com"] |
exclude_domains | array | array of domains to exclude from the response optional field if specified, the listed domains will be omitted from the items array example:
["google.com","bing.com"] |
tag | string | 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 |