Live LLM Mentions Top Mentioned Brands endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned brands for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
POST
The cost of the task can be calculated on the Pricing page.
All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute, each Live LLM Mentions API call can contain only one task.
Execution time for tasks set with the Live LLM Mentions endpoint is currently up to 120 seconds.
Below you will find a detailed description of the fields you can use for setting a task.
Description of the fields for setting a task:
| Field name | Type | Description |
|---|---|---|
target | array | array of objects containing target entities examples: target array with a domain entity |
domain_entity | object | domain entity in the target array |
domain | string | target domain |
search_filter | string | target domain search filter |
search_scope | array | target domain search scope |
include_subdomains | boolean | indicates if the subdomains of the target |
keyword_entity | object | keyword entity in the target array |
keyword | string | target keyword learn more about rules and limitations of |
search_filter | string | target keyword search filter |
search_scope | array | target keyword search scope |
match_type | string | target keyword match type |
location_name | string | full name of search location |
location_code | integer | search location code |
language_name | string | full name of search language |
language_code | string | search language code |
platform | string | target platform |
filters | array | array of results filtering parameters The full list of possible filters is available here. |
initial_dataset_filters | array | array of filter expressions applied before aggregation you can add several filters at once (8 filters maximum) the full list of possible filters is available here. |
limit | integer | maximum number of results in the items array |
internal_list_limit | integer | maximum number of elements within internal arrays |
order_by | array | results sorting rules |
offset | integer | offset in the results array of the returned mentions data default value: |
include_brands | array | array of brands to include in the response |
exclude_brands | array | array of brands to exclude from the response |
tag | string | user-defined task identifier |
tasks array with the information specific to the set tasks.| Field name | Type | Description |
|---|---|---|
version | string | the current version of the API |
status_code | integer | general status code |
status_message | string | general informational message |
time | string | execution time, seconds |
cost | float | total tasks cost, USD |
tasks_count | integer | the number of tasks in the |
tasks_error | integer | the number of tasks in the |
tasks | array | array of tasks |
id | string | task identifier |
status_code | integer | status code of the task |
status_message | string | informational message of the task |
time | string | execution time, seconds |
cost | float | cost of the task, USD |
result_count | integer | number of elements in the |
path | array | URL path |
data | object | contains the same parameters that you specified in the POST request |
result | array | array of results |
total_count | integer | total amount of results relevant the request |
offset | integer | the number of mentions objects that are omitted in the |
items_count | integer | the number of results returned in the |
aggregated_metrics | object | aggregated mentions metrics |
location | array | location-based grouping |
key | integer | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
language | array | language-based grouping |
key | string | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
platform | array | platform-based grouping |
key | string | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
sources_domain | array | found top source domains relevant to the target |
key | string | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
search_results_domain | array | found top search results domains relevant to the target |
key | string | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
brand_entities_title | array | data on brand entities relevant to the target |
key | string | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
brand_entities_category | array | data on brand entities relevant to the target |
key | string | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
total | object | aggregated mentions metrics summary |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | total AI search volume rate |
items | array | individual domain results |
brand | string | brand name |
location | array | location-based grouping |
key | integer | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
language | array | language-based grouping |
key | string | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
platform | array | platform-based grouping |
key | string | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
sources_domain | array | source domains relevant to the specific top mentioned brand |
key | string | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
search_results_domain | array | search results domains relevant to the specific top domain |
key | string | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
brand_entities_title | array | data on brand entities relevant to the target |
key | string | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
brand_entities_category | array | data on brand entities relevant to the target |
key | string | grouping identifier |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | aggregated AI search volume for mentions within this grouping |
total | object | brand mentions metrics summary |
mentions | integer | total LLM mentions count |
ai_search_volume | integer | total AI search volume rate |
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
login="login"
password="password"
cred="$(printf ${login}:${password} | base64)"
curl --location --request POST "https://api.dataforseo.com/v3/ai_optimization/llm_mentions/top_mentioned_brands/live"
--header "Authorization: Basic ${cred}"
--header "Content-Type: application/json"
--data-raw '[
{
"language_code": "en",
"location_code": 2840,
"platform": "chat_gpt",
"target": [
{
"keyword": "bmw",
"search_scope": [
"answer"
]
},
{
"keyword": "auto",
"search_scope": [
"question"
],
"match_type": "partial_match"
}
],
"initial_dataset_filters": [
[
"ai_search_volume",
">",
10
]
],
"limit": 3,
"internal_list_limit": 2
}
]'<?php
/**
* Method: POST
* Endpoint: https://api.dataforseo.com/v3/ai_optimization/llm_mentions/top_mentioned_brands/live
* @see https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/top_mentioned_brands/live
*/
require_once __DIR__ . '/../../../../../lib/RestClient.php';
$config = require __DIR__ . '/../../../../../lib/config.php';
$client = new RestClient($config['base_url'], null, $config['login'], $config['password']);
$data = [
[
'language_code' => 'en',
'location_code' => 2840,
'platform' => 'chat_gpt',
'target' => [
[
'keyword' => 'bmw',
'search_scope' => [
'answer',
],
],
[
'keyword' => 'auto',
'search_scope' => [
'question',
],
'match_type' => 'partial_match',
],
],
'initial_dataset_filters' => [
[
'ai_search_volume',
'>',
10,
],
],
'limit' => 5,
'internal_list_limit' => 2,
],
];
try {
$result = $client->post('/v3/ai_optimization/llm_mentions/top_mentioned_brands/live', $data);
print_r($result);
// do something with post result
} catch (RestClientException $e) {
printf(
"HTTP code: %dnError code: %dnMessage: %snTrace: %sn",
$e->getHttpCode(),
$e->getCode(),
$e->getMessage(),
$e->getTraceAsString()
);
}
?>const axios = require('axios');
axios({
method: 'post',
url: 'https://api.dataforseo.com/v3/ai_optimization/llm_mentions/top_mentioned_brands/live',
auth: {
username: 'login',
password: 'password'
},
data: [
{
"language_code": "en",
"location_code": 2840,
"platform": "chat_gpt",
"target": [
{
"keyword": "bmw",
"search_scope": [
"answer"
]
},
{
"keyword": "auto",
"search_scope": [
"question"
],
"match_type": "partial_match"
}
],
"initial_dataset_filters": [
[
"ai_search_volume",
">",
10
]
],
"limit": 3,
"internal_list_limit": 2
}
],
headers: {
'content-type': 'application/json'
}
}).then(function (response) {
var result = response['data']['tasks'];
// Result data
console.log(result);
}).catch(function (error) {
console.log(error);
});"""
Method: POST
Endpoint: https://api.dataforseo.com/v3/ai_optimization/llm_mentions/top_mentioned_brands/live
@see https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/top_mentioned_brands/live
"""
import sys
import os
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '../../../../../')))
from lib.client import RestClient
from lib.config import username, password
client = RestClient(username, password)
post_data = []
post_data.append({
'language_code': 'en',
'location_code': 2840,
'platform': 'chat_gpt',
'target': [
{
'keyword': 'bmw',
'search_scope': [
'answer'
]
},
{
'keyword': 'auto',
'search_scope': [
'question'
],
'match_type': 'partial_match'
}
],
'initial_dataset_filters': [
[
'ai_search_volume',
'>',
10
]
],
'limit': 5,
'internal_list_limit': 2
})
try:
response = client.post('/v3/ai_optimization/llm_mentions/top_mentioned_brands/live', post_data)
print(response)
# do something with post result
except Exception as e:
print(f'An error occurred: {e}')using System;
using System.Linq;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Collections.Generic;
using System.Threading.Tasks;
using Newtonsoft.Json;
namespace DataForSeoSdk;
public class AiOptimization
{
private static readonly HttpClient _httpClient;
static AiOptimization()
{
_httpClient = new HttpClient
{
BaseAddress = new Uri("https://api.dataforseo.com/")
};
_httpClient.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Basic", ApiConfig.Base64Auth);
}
/// <summary>
/// Method: POST
/// Endpoint: https://api.dataforseo.com/v3/ai_optimization/llm_mentions/top_mentioned_brands/live
/// </summary>
/// <see href="https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/top_mentioned_brands/live"/>
public static async Task LlmMentionsTopDomainsLive()
{
var postData = new List<object>();
// a simple way to set a task, the full list of possible parameters is available in documentation
postData.Add(new
{
language_code = "en",
location_code = 2840,
platform = "chat_gpt",
target = new object[]
{
new
{
keyword = "bmw",
search_scope = new object[]
{
"answer"
}
},
new
{
keyword = "auto",
search_scope = new object[]
{
"question"
},
match_type = "partial_match"
}
},
initial_dataset_filters = new object[]
{
new object[]
{
"ai_search_volume",
">",
10
}
},
limit = 5,
internal_list_limit = 2
});
var content = new StringContent(JsonConvert.SerializeObject(postData), Encoding.UTF8, "application/json");
using var response = await _httpClient.PostAsync("/v3/ai_optimization/llm_mentions/top_mentioned_brands/live", content);
var result = JsonConvert.DeserializeObject<dynamic>(await response.Content.ReadAsStringAsync());
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (result.status_code == 20000)
{
// do something with result
Console.WriteLine(result);
}
else
Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
}The above command returns JSON structured like this:
{
"version": "0.1.20251208",
"status_code": 20000,
"status_message": "Ok.",
"time": "1.9150 sec.",
"cost": 0.101,
"tasks_count": 1,
"tasks_error": 0,
"tasks": [
{
"id": "12121250-1535-0637-0000-d0556baae1e5",
"status_code": 20000,
"status_message": "Ok.",
"time": "1.8471 sec.",
"cost": 0.101,
"result_count": 1,
"path": [
"v3",
"ai_optimization",
"llm_mentions",
"top_mentioned_brands",
"live"
],
"data": {
"api": "ai_optimization",
"function": "top_mentioned_brands",
"language_code": "en",
"location_code": 2840,
"platform": "chat_gpt",
"target": [
{
"keyword": "bmw",
"search_scope": [
"any"
]
},
{
"keyword": "auto",
"search_scope": [
"any"
],
"match_type": "partial_match"
}
],
"initial_dataset_filters": [
[
"ai_search_volume",
">",
10
]
],
"limit": 5,
"internal_list_limit": 2
},
"result": [
{
"total_count": 5,
"offset": 0,
"items_count": 5,
"aggregated_metrics": {
"location": [
{
"key": "2840",
"mentions": 2115,
"ai_search_volume": 95412
}
],
"language": [
{
"key": "en",
"mentions": 2115,
"ai_search_volume": 95412
}
],
"platform": [
{
"key": "chat_gpt",
"mentions": 2115,
"ai_search_volume": 95412
}
],
"sources_domain": [
{
"key": "www.reddit.com",
"mentions": 542,
"ai_search_volume": 20395
},
{
"key": "en.wikipedia.org",
"mentions": 304,
"ai_search_volume": 10579
}
],
"search_results_domain": [
{
"key": "www.bmwblog.com",
"mentions": 261,
"ai_search_volume": 11268
},
{
"key": "www.edmunds.com",
"mentions": 264,
"ai_search_volume": 14945
}
],
"brand_entities_title": [
{
"key": "BMW",
"mentions": 237,
"ai_search_volume": 13445
},
{
"key": "Mercedes-Benz",
"mentions": 46,
"ai_search_volume": 1671
}
],
"brand_entities_category": [
{
"key": "car",
"mentions": 920,
"ai_search_volume": 43543
},
{
"key": "brand",
"mentions": 631,
"ai_search_volume": 32053
}
],
"total": {
"mentions": 9999,
"ai_search_volume": 99999
}
},
"items": [
{
"brand": "BMW",
"location": [
{
"key": "2840",
"mentions": 542,
"ai_search_volume": 20395
}
],
"language": [
{
"key": "en",
"mentions": 542,
"ai_search_volume": 20395
}
],
"platform": [
{
"key": "chat_gpt",
"mentions": 542,
"ai_search_volume": 20395
}
],
"sources_domain": [
{
"key": "www.reddit.com",
"mentions": 542,
"ai_search_volume": 20395
},
{
"key": "www.kbb.com",
"mentions": 65,
"ai_search_volume": 2435
}
],
"search_results_domain": [
{
"key": "www.edmunds.com",
"mentions": 79,
"ai_search_volume": 3231
},
{
"key": "www.kbb.com",
"mentions": 60,
"ai_search_volume": 2436
}
],
"brand_entities_title": [
{
"key": "BMW",
"mentions": 17,
"ai_search_volume": 439
},
{
"key": "Mercedes-Benz",
"mentions": 7,
"ai_search_volume": 149
}
],
"brand_entities_category": [
{
"key": "car",
"mentions": 192,
"ai_search_volume": 7958
},
{
"key": "brand",
"mentions": 136,
"ai_search_volume": 5534
}
],
"total": {
"mentions": 600,
"ai_search_volume": 6000
}
},
{
"brand": "Hyundai",
"location": [
{
"key": "2840",
"mentions": 307,
"ai_search_volume": 10801
}
],
"language": [
{
"key": "en",
"mentions": 307,
"ai_search_volume": 10801
}
],
"platform": [
{
"key": "chat_gpt",
"mentions": 307,
"ai_search_volume": 10801
}
],
"sources_domain": [
{
"key": "en.wikipedia.org",
"mentions": 307,
"ai_search_volume": 10801
},
{
"key": "www.reddit.com",
"mentions": 37,
"ai_search_volume": 1405
}
],
"search_results_domain": [
{
"key": "www.bmwblog.com",
"mentions": 43,
"ai_search_volume": 1678
},
{
"key": "www.motortrend.com",
"mentions": 28,
"ai_search_volume": 957
}
],
"brand_entities_title": [
{
"key": "BMW",
"mentions": 48,
"ai_search_volume": 1766
},
{
"key": "Mercedes-Benz",
"mentions": 18,
"ai_search_volume": 845
}
],
"brand_entities_category": [
{
"key": "brand",
"mentions": 126,
"ai_search_volume": 4600
},
{
"key": "car",
"mentions": 128,
"ai_search_volume": 4689
}
],
"total": {
"mentions": 600,
"ai_search_volume": 6000
}
},
{
"brand": "Toyota",
"location": [
{
"key": "2840",
"mentions": 181,
"ai_search_volume": 9753
}
],
"language": [
{
"key": "en",
"mentions": 181,
"ai_search_volume": 9753
}
],
"platform": [
{
"key": "chat_gpt",
"mentions": 181,
"ai_search_volume": 9753
}
],
"sources_domain": [
{
"key": "www.bmwblog.com",
"mentions": 181,
"ai_search_volume": 9753
},
{
"key": "www.press.bmwgroup.com",
"mentions": 38,
"ai_search_volume": 1176
}
],
"search_results_domain": [
{
"key": "www.bmwblog.com",
"mentions": 105,
"ai_search_volume": 5037
},
{
"key": "www.press.bmwgroup.com",
"mentions": 25,
"ai_search_volume": 1199
}
],
"brand_entities_title": [
{
"key": "BMW",
"mentions": 26,
"ai_search_volume": 839
},
{
"key": "BMW 3 Series",
"mentions": 5,
"ai_search_volume": 959
}
],
"brand_entities_category": [
{
"key": "car",
"mentions": 99,
"ai_search_volume": 7343
},
{
"key": "brand",
"mentions": 59,
"ai_search_volume": 1727
}
],
"total": {
"mentions": 600,
"ai_search_volume": 6000
}
},
{
"brand": "tesla",
"location": [
{
"key": "2840",
"mentions": 213,
"ai_search_volume": 8816
}
],
"language": [
{
"key": "en",
"mentions": 213,
"ai_search_volume": 8816
}
],
"platform": [
{
"key": "chat_gpt",
"mentions": 213,
"ai_search_volume": 8816
}
],
"sources_domain": [
{
"key": "www.kbb.com",
"mentions": 213,
"ai_search_volume": 8816
},
{
"key": "www.reddit.com",
"mentions": 69,
"ai_search_volume": 2647
}
],
"search_results_domain": [
{
"key": "www.kbb.com",
"mentions": 110,
"ai_search_volume": 4392
},
{
"key": "www.edmunds.com",
"mentions": 84,
"ai_search_volume": 3795
}
],
"brand_entities_title": [
{
"key": "BMW",
"mentions": 13,
"ai_search_volume": 420
},
{
"key": "BMW X5",
"mentions": 7,
"ai_search_volume": 211
}
],
"brand_entities_category": [
{
"key": "car",
"mentions": 109,
"ai_search_volume": 5070
},
{
"key": "organization",
"mentions": 44,
"ai_search_volume": 2254
}
],
"total": {
"mentions": 600,
"ai_search_volume": 6000
}
},
{
"brand": "Mercedes-Benz",
"location": [
{
"key": "2840",
"mentions": 157,
"ai_search_volume": 6012
}
],
"language": [
{
"key": "en",
"mentions": 157,
"ai_search_volume": 6012
}
],
"platform": [
{
"key": "chat_gpt",
"mentions": 157,
"ai_search_volume": 6012
}
],
"sources_domain": [
{
"key": "bimmerboom.com",
"mentions": 157,
"ai_search_volume": 6012
},
{
"key": "www.reddit.com",
"mentions": 44,
"ai_search_volume": 1393
}
],
"search_results_domain": [
{
"key": "bimmerboom.com",
"mentions": 95,
"ai_search_volume": 3023
},
{
"key": "www.edmunds.com",
"mentions": 29,
"ai_search_volume": 693
}
],
"brand_entities_title": [
{
"key": "BMW",
"mentions": 7,
"ai_search_volume": 1088
},
{
"key": "RepairPal",
"mentions": 3,
"ai_search_volume": 109
}
],
"brand_entities_category": [
{
"key": "car",
"mentions": 83,
"ai_search_volume": 2704
},
{
"key": "brand",
"mentions": 20,
"ai_search_volume": 1385
}
],
"total": {
"mentions": 600,
"ai_search_volume": 6000
}
}
]
}
]
}
]
}