v0.2.0-beta

OpenAPI 3.1.0

معیارهای تجمیعی زنده LLM Mentions

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

معیارهای تجمیعی زنده LLM Mentions

اینکه دستیارها چند وقت یک‌بار از هدف شما نام می‌برند، به‌صورت مجموع و نه پاسخ‌های جداگانه: total و items. ⚠️ target یک آرایه از اشیاء است، هر کدام {"domain": "..."} یا {"keyword": "..."}؛ رشته تنها به‌عنوان نوع نادرست رد می‌شود و آرایه رشته‌ها با 'Each target item must be an object' رد می‌شود. فیلدهای فیلتر از get_dataforseo_ai_llm_mentions_available_filters می‌آیند. پاسخ در پاکت DataForSEO قرار می‌گیرد: داده‌ها در tasks[0].result و نتیجه در tasks[0].status_code — درخواست ردشده نیز همچنان HTTP 200 برمی‌گرداند. این عدد اصلی دیده‌شدن است؛ post_dataforseo_ai_llm_mentions_search_live پاسخ‌های پشت آن را نشان می‌دهد و post_dataforseo_ai_llm_mentions_cross_metrics_live چند هدف را هم‌زمان مقایسه می‌کند.

مرجع قیمت‌گذاری

اندازه‌گیری: هزینه گزارش‌شده پاسخ.
برآورد درخواست مرجع: 0.101 دلار آمریکا.
ضریب مشتری مرجع: 1.0. آن را دوباره روی مبلغ تسویه‌شده مشتری اعمال نکنید.

فقط فراداده مرجع است، نه نقل‌قول حساب، نه قیمت تضمین‌شده و نه سقف هزینه. اعتبار منابع، اعتبار Felo نیست. هزینه‌های نهایی تابع سوابق صورت‌حساب Felo است.

بدنه

الزامی

application/json

نوع: array object[]
- target
  نوع: array object[]
  الزامی
  
  آرایه‌ای از اشیاء شامل موجودیت‌های هدف فیلد الزامی می‌توانید حداکثر 10 موجودیت (شیء) در فیلد target تعیین کنید یک موجودیت هدف می‌تواند شامل یک دامنه یا یک کلمه کلیدی و پارامترهای مرتبط باشد.مثال‌ها: آرایه target با موجودیت دامنه [{"domain": "en.wikipedia.org", "search_filter": "exclude"}] آرایه target با موجودیت کلمه کلیدی [{"keyword": "bmw", "search_scope": ["question"], "match_type ": "partial_match"}] آرایه target با چندین موجودیت [{"domain": "en.wikipedia.org", "search_filter": "exclude"}, {"keyword": "bmw", "match_type ": "partial_match", "search_scope": ["answer"]}]
  
  domain
  نوع: string
  الزامی
  
  دامنه هدف فیلد الزامی اگر keyword را تعیین نکنید می‌توانید حداکثر 63 کاراکتر در فیلد domain تعیین کنید; دامنه باید بدون https:// و www. تعیین شود.
  
  include_subdomains
  نوع: boolean
  
  نشان می‌دهد آیا زیردامنه‌های دامنه هدف در جستجو گنجانده می‌شوند فیلد اختیاری اگر روی true تنظیم شود، زیردامنه‌ها در جستجو گنجانده می‌شوند مقدار پیش‌فرض: false
  
  keyword
  نوع: string
  
  کلمه کلیدی هدف فیلد الزامی اگر domain را تعیین نکنید می‌توانید حداکثر 250 کاراکتر در فیلد keyword تعیین کنید همه %## رمزگشایی می‌شوند (همچنین کاراکتر ‘+’ به فاصله رمزگشایی می‌شود) اگر لازم است از کاراکتر “%” در keyword استفاده کنید، آن را به‌صورت “%25” بنویسید; اگر لازم است از کاراکتر “+” در keyword استفاده کنید، آن را به‌صورت “%2B” بنویسید. درباره قواعد و محدودیت‌های فیلدهای keyword و keywords در APIهای DataForSEO در این مقاله مرکز راهنمایی بیشتر بدانید
  
  match_type
  نوع: string
  
  نوع تطبیق کلمه کلیدی هدف فیلد اختیاری word_match - جستجوی تمام‌متن برای اصطلاحاتی که با کلمه کلیدی بذر مشخص‌شده مطابقت دارند و کلمات اضافی پیش، پس یا درون عبارت کلیدی دارند (مثلاً جستجوی “light” نتایجی با “light bulb”، “light switch” برمی‌گرداند); partial_match - جستجوی زیررشته که همه موارد حاوی دنباله کاراکترهای مشخص‌شده را پیدا می‌کند، حتی اگر درون یک کلمه بلندتر ظاهر شود (مثلاً جستجوی “light” نتایجی با “lighting”، “highlight” برمی‌گرداند); مقادیر ممکن: word_match، partial_match مقدار پیش‌فرض: word_match
  
  search_filter
  نوع: string
  
  فیلتر جستجوی موجودیت: include یا exclude؛ پیش‌فرض include است.
  
  search_scope
  نوع: array string[]
  
  دامنه جستجو. موجودیت‌های دامنه: any، sources، search_results. موجودیت‌های کلمه کلیدی: any، question، answer، brand_entities، fan_out_queries. پیش‌فرض: any.
- initial_dataset_filters
  نوع: array
  
  آرایه‌ای از عبارات فیلتر که پیش از تجمیع اعمال می‌شوند فیلد اختیاری می‌توانید از این آرایه برای فیلتر کردن عبارات اعمال‌شده بر پایگاه داده اشاره‌های خام پیش از تجمیع استفاده کنید تا سطرهایی که در نتیجه سهیم‌اند محدود شوند;می‌توانید چند فیلتر را هم‌زمان اضافه کنید (حداکثر 8 فیلتر) و باید بین شرایط یک عملگر منطقی and یا or تنظیم کنید. عملگرهای پشتیبانی‌شده: =, , in, not_in, like, not_like, ilike, not_ilike, match, not_match می‌توانید از عملگر % همراه با like و not_like برای تطبیق هر رشته‌ای با صفر یا بیشتر کاراکتر استفاده کنید. مثال: ["ai_search_volume",">","1000"]. فهرست کامل فیلترهای ممکن اینجا در دسترس است. درباره فیلترهای مجموعه داده اولیه در این مقاله مرکز راهنمایی بیشتر بدانید.
- internal_list_limit
  نوع: integer
  
  حداکثر تعداد عناصر در آرایه‌های داخلی فیلد اختیاری می‌توانید از این فیلد برای محدود کردن تعداد عناصر در آرایه‌های زیر استفاده کنید: sources_domain search_results_domain حداقل مقدار: 1 حداکثر مقدار: 20 مقدار پیش‌فرض: 10
- language_code
  نوع: string
  
  کد زبان جستجو فیلد اختیاری اگر از این فیلد استفاده کنید، نیازی به تعیین language_name نیست; می‌توانید فهرست زبان‌های موجود موتور جستجو را همراه با language_code آن‌ها با ارسال یک درخواست جداگانه به https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages دریافت کنید مقدار پیش‌فرض: en توجه: داده‌های chat_gpt فقط برای en در دسترس است
- language_name
  نوع: string
  
  نام کامل زبان جستجو فیلد اختیاری اگر از این فیلد استفاده کنید، نیازی به تعیین language_code نیست; اگر این فیلد را تعیین نکنید، language_code با مقدار en به‌صورت پیش‌فرض استفاده می‌شود; می‌توانید فهرست زبان‌های موجود موتور جستجو را همراه با language_name آن‌ها با ارسال یک درخواست جداگانه به https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages دریافت کنید توجه: داده‌های chat_gpt فقط به انگلیسی در دسترس است
- location_code
  نوع: integer
  
  کد موقعیت جستجو فیلد اختیاری اگر از این فیلد استفاده کنید، نیازی به تعیین location_name نیست می‌توانید فهرست موقعیت‌های موجود موتور جستجو را همراه با location_code آن‌ها با ارسال یک درخواست جداگانه به https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages دریافت کنید مقدار پیش‌فرض: 2840 توجه: داده‌های chat_gpt فقط برای 2840 در دسترس است
- location_name
  نوع: string
  
  نام کامل موقعیت جستجو فیلد اختیاری اگر از این فیلد استفاده کنید، نیازی به تعیین location_code نیست اگر این فیلد را تعیین نکنید، location_code با مقدار 2840 به‌صورت پیش‌فرض استفاده می‌شود; می‌توانید فهرست موقعیت‌های موجود موتور جستجو را همراه با location_name آن‌ها با ارسال یک درخواست جداگانه به https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages دریافت کنید توجه: داده‌های chat_gpt فقط برای ایالات متحده در دسترس است
- platform
  نوع: string
  
  پلتفرم هدف فیلد اختیاری مقادیر ممکن: chat_gpt، google مقدار پیش‌فرض: google توجه: داده‌های بازگردانده‌شده به پلتفرم انتخاب‌شده بستگی دارد توجه 2:داده‌های chat_gpt فقط برای ایالات متحده و زبان انگلیسی در دسترس است
- tag
  نوع: string
  
  شناسه وظیفه تعریف‌شده توسط کاربر فیلد اختیاری محدودیت کاراکتر 255 است می‌توانید از این پارامتر برای شناسایی وظیفه و تطبیق آن با نتیجه استفاده کنید مقدار tag مشخص‌شده را در شیء data پاسخ پیدا می‌کنید

پاسخ‌ها

200
نوع: object

پاسخ موفق
cost
نوع: number

هزینه کل وظایف، دلار آمریکا

status_code
نوع: integer

کد وضعیت عمومی فهرست کامل کدهای پاسخ را اینجا پیدا می‌کنید توجه: اکیداً توصیه می‌کنیم سیستمی لازم برای مدیریت شرایط استثنایی یا خطاهای مرتبط طراحی کنید

status_message
نوع: string

پیام اطلاعاتی عمومی فهرست کامل پیام‌های اطلاعاتی عمومی را اینجا پیدا می‌کنید

tasks
نوع: array string[]

آرایه وظایف

tasks_count
نوع: integer

تعداد وظایف در آرایه tasks

tasks_error
نوع: integer

تعداد وظایف در آرایه tasks که با خطا برگردانده شده‌اند

tasks.cost
نوع: number

هزینه وظیفه، دلار آمریکا

tasks.data
نوع: object

همان پارامترهایی را دارد که در درخواست POST تعیین کرده‌اید

tasks.id
نوع: string

شناسه وظیفه شناسه وظیفه یکتا در سیستم ما با قالب UUID

tasks.path
نوع: array string[]

مسیر URL

tasks.result
نوع: array string[]

آرایه نتایج

tasks.result_count
نوع: integer

تعداد عناصر در آرایه result

tasks.result.items
نوع: array string[]

آرایه نتایج صفحات جداگانه که معیارهای تفصیلی اشاره را برای هر یک از صفحات برتری که پیدا شده‌اند دارد در این حالت، برابر null است

tasks.result.total
نوع: object

خلاصه معیارهای اشاره‌های تجمیع‌شده شامل معیارهای اشاره LLM تجمیع‌شده کلی در همه دامنه‌های پیداشده است که بر اساس ابعاد مختلف گروه‌بندی شده‌اند

tasks.result.total.brand_entities_category
نوع: array string[]

داده‌های موجودیت‌های برند مرتبط با هدف آرایه‌ای از اشیاء شامل داده‌های دسته‌های موجودیت برند که در نتایج جستجوی مرتبط با پرس‌وجوهای LLM ظاهر می‌شوند

tasks.result.total.brand_entities_category.ai_search_volume
نوع: integer

نرخ فعلی حجم جستجوی AI یک کلمه کلیدی درباره این معیار اینجا بیشتر بدانید

tasks.result.total.brand_entities_category.impressions
نوع: integer

نرخ فعلی نمایش‌های AI یک کلمه کلیدی

tasks.result.total.brand_entities_category.key
نوع: string

شناسه گروه‌بندی شناسه مشخص بعد گروه‌بندی در این حالت، فیلد دسته موجودیت برندی را که پیدا شده نمایش می‌دهد

tasks.result.total.brand_entities_category.mentions
نوع: integer

تعداد کل اشاره‌های LLM تعداد دفعاتی که کلمه کلیدی یا دامنه هدف در ارتباط با دامنه مشخص اشاره شده‌اند

tasks.result.total.brand_entities_category.type
نوع: string

نوع عنصر = 'group_element'

tasks.result.total.brand_entities_title
نوع: array string[]

داده‌های موجودیت‌های برند مرتبط با هدف آرایه‌ای از اشیاء شامل داده‌های عنوان‌های موجودیت برند که در نتایج جستجوی مرتبط با پرس‌وجوهای LLM ظاهر می‌شوند

tasks.result.total.brand_entities_title.ai_search_volume
نوع: integer

نرخ فعلی حجم جستجوی AI یک کلمه کلیدی درباره این معیار اینجا بیشتر بدانید

tasks.result.total.brand_entities_title.impressions
نوع: integer

نرخ فعلی نمایش‌های AI یک کلمه کلیدی

tasks.result.total.brand_entities_title.key
نوع: string

شناسه گروه‌بندی شناسه مشخص بعد گروه‌بندی در این حالت، فیلد عنوان موجودیت برندی را که پیدا شده نمایش می‌دهد

tasks.result.total.brand_entities_title.mentions
نوع: integer

تعداد کل اشاره‌های LLM تعداد دفعاتی که کلمه کلیدی یا دامنه هدف در ارتباط با دامنه مشخص اشاره شده‌اند

tasks.result.total.brand_entities_title.type
نوع: string

نوع عنصر = 'group_element'

tasks.result.total.language
نوع: array string[]

گروه‌بندی بر اساس زبان آرایه‌ای از اشیاء شامل معیارهای اشاره تفکیک‌شده بر اساس زبان محتوا

tasks.result.total.language.ai_search_volume
نوع: integer

نرخ فعلی حجم جستجوی AI یک کلمه کلیدی درباره این معیار اینجا بیشتر بدانید

tasks.result.total.language.impressions
نوع: integer

نرخ فعلی نمایش‌های AI یک کلمه کلیدی

tasks.result.total.language.key
نوع: string

شناسه گروه‌بندی شناسه مشخص بعد گروه‌بندی

tasks.result.total.language.mentions
نوع: integer

تعداد کل اشاره‌های LLM تعداد دفعاتی که کلمه کلیدی یا دامنه هدف در ارتباط با این کلید گروه‌بندی مشخص اشاره شده‌اند

tasks.result.total.language.type
نوع: string

نوع عنصر = 'group_element'

tasks.result.total.location
نوع: array string[]

گروه‌بندی بر اساس موقعیت آرایه‌ای از اشیاء شامل معیارهای اشاره تفکیک‌شده بر اساس موقعیت جغرافیایی

tasks.result.total.location.ai_search_volume
نوع: integer

نرخ فعلی حجم جستجوی AI یک کلمه کلیدی درباره این معیار اینجا بیشتر بدانید

tasks.result.total.location.impressions
نوع: integer

نرخ فعلی نمایش‌های AI یک کلمه کلیدی

tasks.result.total.location.key
نوع: string

شناسه گروه‌بندی شناسه مشخص بعد گروه‌بندی

tasks.result.total.location.mentions
نوع: integer

تعداد کل اشاره‌های LLM تعداد دفعاتی که کلمه کلیدی یا دامنه هدف در ارتباط با این کلید گروه‌بندی مشخص اشاره شده‌اند

tasks.result.total.location.type
نوع: string

نوع عنصر = 'group_element'

tasks.result.total.platform
نوع: array string[]

گروه‌بندی بر اساس پلتفرم آرایه‌ای از عناصر گروه شامل معیارهای اشاره تفکیک‌شده بر اساس پلتفرم هوش مصنوعی

tasks.result.total.platform.ai_search_volume
نوع: integer

نرخ فعلی حجم جستجوی AI یک کلمه کلیدی درباره این معیار اینجا بیشتر بدانید

tasks.result.total.platform.impressions
نوع: integer

نرخ فعلی نمایش‌های AI یک کلمه کلیدی

tasks.result.total.platform.key
نوع: string

شناسه گروه‌بندی شناسه مشخص بعد گروه‌بندی

tasks.result.total.platform.mentions
نوع: integer

تعداد کل اشاره‌های LLM تعداد دفعاتی که کلمه کلیدی یا دامنه هدف در ارتباط با این کلید گروه‌بندی مشخص اشاره شده‌اند

tasks.result.total.platform.type
نوع: string

نوع عنصر = 'group_element'

tasks.result.total.search_results_domain
نوع: array string[]

دامنه‌های برتر نتایج جستجوی پیداشده مرتبط با هدف آرایه‌ای از اشیاء شامل داده‌های دامنه‌های برتری که در نتایج جستجوی مرتبط با پرس‌وجوهای LLM ظاهر می‌شوند

tasks.result.total.search_results_domain.ai_search_volume
نوع: integer

نرخ فعلی حجم جستجوی AI یک کلمه کلیدی درباره این معیار اینجا بیشتر بدانید

tasks.result.total.search_results_domain.impressions
نوع: integer

نرخ فعلی نمایش‌های AI یک کلمه کلیدی

tasks.result.total.search_results_domain.key
نوع: string

شناسه گروه‌بندی شناسه مشخص بعد گروه‌بندی در این حالت، فیلد نام دامنه‌ای را که پیدا شده نمایش می‌دهد

tasks.result.total.search_results_domain.mentions
نوع: integer

تعداد کل اشاره‌های LLM تعداد دفعاتی که کلمه کلیدی یا دامنه هدف در ارتباط با دامنه مشخص اشاره شده‌اند

tasks.result.total.search_results_domain.type
نوع: string

نوع عنصر = 'group_element'

tasks.result.total.sources_domain
نوع: array string[]

دامنه‌های برتر منبع پیداشده مرتبط با هدف آرایه‌ای از اشیاء شامل داده‌های دامنه‌های برتری که به‌عنوان منبع در پاسخ‌های LLM به آن‌ها استناد می‌شود

tasks.result.total.sources_domain.ai_search_volume
نوع: integer

نرخ فعلی حجم جستجوی AI یک کلمه کلیدی درباره این معیار اینجا بیشتر بدانید

tasks.result.total.sources_domain.impressions
نوع: integer

نرخ فعلی نمایش‌های AI یک کلمه کلیدی

tasks.result.total.sources_domain.key
نوع: string

شناسه گروه‌بندی شناسه مشخص بعد گروه‌بندی در این حالت، فیلد نام دامنه‌ای را که پیدا شده نمایش می‌دهد

tasks.result.total.sources_domain.mentions
نوع: integer

تعداد کل اشاره‌های LLM تعداد دفعاتی که کلمه کلیدی یا دامنه هدف در ارتباط با دامنه مشخص اشاره شده‌اند

tasks.result.total.sources_domain.type
نوع: string

نوع عنصر = 'group_element'

tasks.status_code
نوع: integer

کد وضعیت وظیفه‌ای که DataForSEO ایجاد کرده است; می‌تواند در محدوده زیر باشد: 10000-60000 فهرست کامل کدهای پاسخ را اینجا پیدا می‌کنید

tasks.status_message
نوع: string

پیام اطلاعاتی وظیفه فهرست کامل پیام‌های اطلاعاتی عمومی را اینجا پیدا می‌کنید

tasks.time
نوع: string

زمان اجرا، ثانیه

time
نوع: string

زمان اجرا، ثانیه

version
نوع: string

نسخه فعلی API
application/json
400

درخواست پردازش نشد. پارامترهای درخواست را بررسی کنید.
401

یک کلید API معتبر Felo لازم است.
402

درخواست ادامه نمی‌یابد چون یک الزام صورت‌حساب برآورده نشده است.
403

حساب مجاز به انجام این عملیات نیست.
429

به سقف درخواست یا هزینه رسیده‌اید.
502

سرویس نتوانست درخواست را کامل کند.
503

سرویس API یا صورت‌حساب موقتاً در دسترس نیست.
504

سرویس هنگام پردازش درخواست به پایان مهلت رسید.
default

پاسخ خطا؛ پاسخ‌های عبوری بالادست ممکن است از قالب‌های ارائه‌دهنده استفاده کنند

application/json

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

curl https://openapi.felo.ai/v1/beta/dataforseo/ai_optimization/llm_mentions/aggregated_metrics/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": [
      {
        "domain": "en.wikipedia.org"
      }
    ]
  }
]'

نمایش اسکیما

{
  "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"
  ]
}

پاسخ موفق

معیارهای تجمیعی زنده LLM Mentions

احراز هویتRequired

DataForSEO

معیارهای تجمیعی زنده LLM Mentions

مرجع قیمت‌گذاری