v0.1.0-beta

OpenAPI 3.1.0

Live LLM Mentions Cross Aggregated Metrics

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/cross_aggregated_metrics/live

Live LLM Mentions Cross Aggregated Metrics

Compares mention metrics across several targets in one call, grouped by aggregation_key. Takes targets as a list of target arrays rather than the single target its siblings take - the shapes differ, and mixing them up is rejected as an unknown field. ⚠️ 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. Running post_dataforseo_ai_llm_mentions_aggregated_metrics_live once per target costs the same per call, so use this when the comparison itself is the point.

リクエストボディ

必須

application/json

型: array object[]
- targets
  型: array object[]
  必須
  
  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"}]}]
  
  aggregation_key
  型: string
  必須
  
  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
  
  target
  型: array object[]
  必須
  
  array of objects containing target entities required field a single target can contain up to 10 domain and/or keyword entities
  
  domain
  型: string
  必須
  
  target domain required field if you don't specify a keyword you can specify up to 63 characters in the domain field; a domain should be specified without https:// and www.
  
  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
  型: string
  
  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
  
  match_type
  型: string
  
  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
  
  search_filter
  型: string
  
  Entity search filter: include or exclude; defaults to include.
  
  search_scope
  型: array string[]
  
  Search scope. Domain entities: any, sources, search_results. Keyword entities: any, question, answer, brand_entities, fan_out_queries. Default: any.
- 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.
- 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 minimum value: 1 maximum value: 10 default value: 5
- 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
- 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
- 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
- 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
- platform
  型: string
  
  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
- 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

レスポンス

200
型: object

Successful response
cost
型: number

total tasks cost, USD

status_code
型: integer

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_message
型: string

general informational message you can find the full list of general informational messages here

tasks
型: array string[]

array of tasks

tasks_count
型: integer

the number of tasks in the tasks array

tasks_error
型: integer

the number of tasks in the tasks array returned with an error

tasks.cost
型: number

cost of the task, USD

tasks.data
型: object

contains the same parameters that you specified in the POST request

tasks.id
型: string

task identifier unique task identifier in our system in the UUID format

tasks.path
型: array string[]

URL path

tasks.result
型: array string[]

array of results

tasks.result_count
型: integer

number of elements in the result array

tasks.result.items
型: array string[]

contains relevant mentions data

tasks.result.items.brand_entities_category
型: array string[]

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

tasks.result.items.brand_entities_category.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.items.brand_entities_category.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.items.brand_entities_category.key
型: string

grouping identifier the specific identifier for the grouping dimension in this case the field displays a found brand entity category

tasks.result.items.brand_entities_category.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain

tasks.result.items.brand_entities_category.type
型: string

type of the element = 'group_element'

tasks.result.items.brand_entities_title
型: array string[]

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

tasks.result.items.brand_entities_title.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.items.brand_entities_title.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.items.brand_entities_title.key
型: string

grouping identifier the specific identifier for the grouping dimension in this case the field displays a found brand entity title

tasks.result.items.brand_entities_title.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain

tasks.result.items.brand_entities_title.type
型: string

type of the element = 'group_element'

tasks.result.items.key
型: string

aggregation key received in a POST array

tasks.result.items.language
型: array string[]

language-based grouping array of objects containing mention metrics segmented by content language

tasks.result.items.language.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.items.language.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.items.language.key
型: string

grouping identifier the specific identifier for the grouping dimension

tasks.result.items.language.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key

tasks.result.items.language.type
型: string

type of the element = 'group_element'

tasks.result.items.location
型: array string[]

location-based grouping array of objects containing mention metrics segmented by geographical location

tasks.result.items.location.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.items.location.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.items.location.key
型: string

grouping identifier the specific identifier for the grouping dimension

tasks.result.items.location.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key

tasks.result.items.location.type
型: string

type of the element = 'group_element'

tasks.result.items.platform
型: array string[]

platform-based grouping array of group elements containing mention metrics segmented by AI platform

tasks.result.items.platform.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.items.platform.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.items.platform.key
型: string

grouping identifier the specific identifier for the grouping dimension

tasks.result.items.platform.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key

tasks.result.items.platform.type
型: string

type of the element = 'group_element'

tasks.result.items.search_results_domain
型: array string[]

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

tasks.result.items.search_results_domain.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.items.search_results_domain.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.items.search_results_domain.key
型: string

grouping identifier the specific identifier for the grouping dimension in this case the field displays a found domain name

tasks.result.items.search_results_domain.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain

tasks.result.items.search_results_domain.type
型: string

type of the element = 'group_element'

tasks.result.items.sources_domain
型: array string[]

found top source domains relevant to the target array of objects containing data on top domains that are cited as sources in LLM responses

tasks.result.items.sources_domain.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.items.sources_domain.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.items.sources_domain.key
型: string

grouping identifier the specific identifier for the grouping dimension in this case the field displays a found domain name

tasks.result.items.sources_domain.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain

tasks.result.items.sources_domain.type
型: string

type of the element = 'group_element'

tasks.result.total
型: object

aggregated mentions metrics summary contains overall aggregated LLM mention metrics across all found domains, grouped by various dimensions

tasks.result.total.brand_entities_category
型: array string[]

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

tasks.result.total.brand_entities_category.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.total.brand_entities_category.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.total.brand_entities_category.key
型: string

grouping identifier the specific identifier for the grouping dimension in this case the field displays a found brand entity category

tasks.result.total.brand_entities_category.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain

tasks.result.total.brand_entities_category.type
型: string

type of the element = 'group_element'

tasks.result.total.brand_entities_title
型: array string[]

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

tasks.result.total.brand_entities_title.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.total.brand_entities_title.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.total.brand_entities_title.key
型: string

grouping identifier the specific identifier for the grouping dimension in this case the field displays a found brand entity title

tasks.result.total.brand_entities_title.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain

tasks.result.total.brand_entities_title.type
型: string

type of the element = 'group_element'

tasks.result.total.language
型: array string[]

language-based grouping array of objects containing mention metrics segmented by content language

tasks.result.total.language.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.total.language.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.total.language.key
型: string

grouping identifier the specific identifier for the grouping dimension

tasks.result.total.language.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key

tasks.result.total.language.type
型: string

type of the element = 'group_element'

tasks.result.total.location
型: array string[]

location-based grouping array of objects containing mention metrics segmented by geographical location

tasks.result.total.location.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.total.location.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.total.location.key
型: string

grouping identifier the specific identifier for the grouping dimension

tasks.result.total.location.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key

tasks.result.total.location.type
型: string

type of the element = 'group_element'

tasks.result.total.platform
型: array string[]

platform-based grouping array of group elements containing mention metrics segmented by AI platform

tasks.result.total.platform.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.total.platform.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.total.platform.key
型: string

grouping identifier the specific identifier for the grouping dimension

tasks.result.total.platform.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to this specific grouping key

tasks.result.total.platform.type
型: string

type of the element = 'group_element'

tasks.result.total.search_results_domain
型: array string[]

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

tasks.result.total.search_results_domain.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.total.search_results_domain.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.total.search_results_domain.key
型: string

grouping identifier the specific identifier for the grouping dimension in this case the field displays a found domain name

tasks.result.total.search_results_domain.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain

tasks.result.total.search_results_domain.type
型: string

type of the element = 'group_element'

tasks.result.total.sources_domain
型: array string[]

found top source domains relevant to the target array of objects containing data on top domains that are cited as sources in LLM responses

tasks.result.total.sources_domain.ai_search_volume
型: integer

current AI search volume rate of a keyword learn more about this metric here

tasks.result.total.sources_domain.impressions
型: integer

current AI impressions rate of a keyword

tasks.result.total.sources_domain.key
型: string

grouping identifier the specific identifier for the grouping dimension in this case the field displays a found domain name

tasks.result.total.sources_domain.mentions
型: integer

total LLM mentions count the number of times the target keyword or domain were mentioned in relation to the specific domain

tasks.result.total.sources_domain.type
型: string

type of the element = 'group_element'

tasks.status_code
型: integer

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

tasks.status_message
型: string

informational message of the task you can find the full list of general informational messages here

tasks.time
型: string

execution time, seconds

time
型: string

execution time, seconds

version
型: string

the current version of the API
application/json
400

Bad request
401

Unauthorized
402

The request cannot proceed because a billing requirement is not met.
403

The account is not permitted to perform this operation.
429

Rate limit exceeded
500

Internal server error
502

The service could not complete the request.
503

The API or billing service is temporarily unavailable.
504

The service timed out while processing the request.
default

The operation failed. Keep the response request ID when contacting Felo support.

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

curl https://openapi.felo.ai/v1/beta/dataforseo/ai_optimization/llm_mentions/cross_aggregated_metrics/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "targets": [
      {
        "aggregation_key": "",
        "target": [
          {}
        ]
      }
    ],
    "location_name": "",
    "location_code": 1,
    "language_name": "",
    "language_code": "",
    "platform": "",
    "initial_dataset_filters": [],
    "internal_list_limit": 1,
    "tag": ""
  }
]'

スキーマを表示

{
  "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"
  ],
  "tasks.result.items.key": "string",
  "tasks.result.items.location": [
    "string"
  ],
  "tasks.result.items.location.type": "string",
  "tasks.result.items.location.key": "string",
  "tasks.result.items.location.mentions": 1,
  "tasks.result.items.location.ai_search_volume": 1,
  "tasks.result.items.location.impressions": 1,
  "tasks.result.items.language": [
    "string"
  ],
  "tasks.result.items.language.type": "string",
  "tasks.result.items.language.key": "string",
  "tasks.result.items.language.mentions": 1,
  "tasks.result.items.language.ai_search_volume": 1,
  "tasks.result.items.language.impressions": 1,
  "tasks.result.items.platform": [
    "string"
  ],
  "tasks.result.items.platform.type": "string",
  "tasks.result.items.platform.key": "string",
  "tasks.result.items.platform.mentions": 1,
  "tasks.result.items.platform.ai_search_volume": 1,
  "tasks.result.items.platform.impressions": 1,
  "tasks.result.items.sources_domain": [
    "string"
  ],
  "tasks.result.items.sources_domain.type": "string",
  "tasks.result.items.sources_domain.key": "string",
  "tasks.result.items.sources_domain.mentions": 1,
  "tasks.result.items.sources_domain.ai_search_volume": 1,
  "tasks.result.items.sources_domain.impressions": 1,
  "tasks.result.items.search_results_domain": [
    "string"
  ],
  "tasks.result.items.search_results_domain.type": "string",
  "tasks.result.items.search_results_domain.key": "string",
  "tasks.result.items.search_results_domain.mentions": 1,
  "tasks.result.items.search_results_domain.ai_search_volume": 1,
  "tasks.result.items.search_results_domain.impressions": 1,
  "tasks.result.items.brand_entities_title": [
    "string"
  ],
  "tasks.result.items.brand_entities_title.type": "string",
  "tasks.result.items.brand_entities_title.key": "string",
  "tasks.result.items.brand_entities_title.mentions": 1,
  "tasks.result.items.brand_entities_title.ai_search_volume": 1,
  "tasks.result.items.brand_entities_title.impressions": 1,
  "tasks.result.items.brand_entities_category": [
    "string"
  ],
  "tasks.result.items.brand_entities_category.type": "string",
  "tasks.result.items.brand_entities_category.key": "string",
  "tasks.result.items.brand_entities_category.mentions": 1,
  "tasks.result.items.brand_entities_category.ai_search_volume": 1,
  "tasks.result.items.brand_entities_category.impressions": 1
}

Successful response

Live LLM Mentions Cross Aggregated Metrics

認証Required

DataForSEO

Live LLM Mentions Cross Aggregated Metrics