Felo API PlatformFelo API Platform
همه endpointهای DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

OnPage Lighthouse JSON زنده

سرور:https://openapi.felo.ai
کتابخانه‌های کلاینت

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

OnPage Lighthouse JSON زنده

​

ممیزی Google Lighthouse را روی یک url اجرا می‌کند و گزارش کامل را برمی‌گرداند: lighthouseVersion، requestedUrl، finalUrl، fetchTime، gatherMode، runWarnings و هر ممیزی و امتیاز دسته. for_mobile دستگاه شبیه‌سازی‌شده را عوض می‌کند و categories و audits اجرا را محدود می‌کنند. categories یا audits را بفرستید تا کوچک شود، و وقتی پرسش صرفاً این است که چرا صفحه کند است post_dataforseo_on_page_waterfall را ترجیح دهید. پاسخ در پاکت DataForSEO قرار می‌گیرد: داده‌ها در tasks[0].result و نتیجه در tasks[0].status_code — درخواست ردشده نیز همچنان HTTP 200 برمی‌گرداند.

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

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

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

بدنه
application/json
  • نوع: array (object | null)[]
    • audits
      نوع: array string[] | null

      ممیزی‌های Lighthouse
      فیلد اختیاری
      ممیزی‌ها آزمون‌های جداگانه‌ای هستند که Lighthouse برای هر ویژگی/بهینه‌سازی/معیار خاص اجرا می‌کند تا امتیاز عددی تولید کند (تعریف رسمی را ببینید)؛

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

      توجه: برخی ممیزی‌ها به دسته خاصی تعلق ندارند و سنجه‌های مستقل کیفیت صفحه هستند؛

      به‌طور کلی، چند حالت استفاده وجود دارد:

      1. اگر categories را نادیده بگیرید، می‌توانید از این فیلد برای دریافت داده‌های فقط ممیزی‌های مشخص‌شده استفاده کنید
      برای مثال، اگر "categories" را نادیده بگیرید و "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"] را مشخص کنید، فقط داده‌های این ممیزی‌ها را دریافت می‌کنید

      2. اگر دسته‌ای را مشخص کنید، می‌توانید از این فیلد برای دریافت ممیزی‌هایی که به دسته (یا دسته‌های) مشخص‌شده شما تعلق ندارند استفاده کنید
      برای مثال، اگر "categories": ["seo"] و "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"] را مشخص کنید، فقط این ممیزی‌ها را زیر "performance" و همه ممیزی‌ها را زیر "seo" دریافت می‌کنید

      می‌توانید فهرست کامل ممیزی‌های ممکن را اینجا دریافت کنید

    • browser_cpu_throttling_multiplier
      نوع: number | null

      ضریب محدودسازی CPU مرورگر
      الزامی اگر browser_network_throttling_method روی devtools تنظیم شده باشد؛
      ضریب محدودسازی CPU را برای شبیه‌سازی شرایط عملکرد دستگاه در طول ممیزی Lighthouse تنظیم کنید؛
      می‌توان آن را در بازه زیر مشخص کرد: 1–4؛
      توجه: این پارامتر فقط زمانی اعمال می‌شود که browser_network_throttling_method روی devtools تنظیم شده باشد؛

    • browser_network_throttling
      نوع: string | null

      محدودسازی شبکه مرورگر
      الزامی اگر browser_network_throttling_method روی devtools تنظیم شده باشد؛
      پروفایل محدودسازی شبکه را برای شبیه‌سازی شرایط سرعت اتصال در طول ممیزی Lighthouse تنظیم کنید؛
      مقادیر ممکن: no_throttling، fast_4g، slow_4g، regular_3g، pc؛
      توجه: این پارامتر فقط زمانی اعمال می‌شود که browser_network_throttling_method روی devtools تنظیم شده باشد؛

    • browser_network_throttling_method
      نوع: string | null

      روش محدودسازی شبکه مرورگر
      فیلد اختیاری
      روشی را تعیین می‌کند که برای اعمال محدودسازی در طول ممیزی Lighthouse استفاده می‌شود؛
      مقادیر ممکن:
      simulate - معیارهای عملکرد تخمینی را بدون اعمال محدودسازی صریح محاسبه می‌کند؛
      devtools - تنظیمات محدودسازی مشخص‌شده در browser_network_throttling و browser_cpu_throttling_multiplier را اعمال می‌کند؛
      provided - از شرایط شبکه محیط خزش استفاده می‌کند؛

    • browser_screen_height
      نوع: integer | null

      ارتفاع صفحه نمایش مرورگر
      فیلد اختیاری
      ارتفاع صفحه نمایش مرورگر مورد استفاده در ممیزی Lighthouse را برای شبیه‌سازی یک دستگاه خاص تنظیم کنید؛
      می‌توان آن را در بازه زیر مشخص کرد: 240–9999؛

    • browser_screen_scale_factor
      نوع: number | null

      ضریب مقیاس صفحه نمایش مرورگر
      فیلد اختیاری
      نسبت پیکسل دستگاه مرورگر مورد استفاده در ممیزی Lighthouse را تنظیم کنید؛
      می‌توان آن را در بازه زیر مشخص کرد: 0.5–3؛

    • browser_screen_width
      نوع: integer | null قالب: int64

      عرض صفحه نمایش مرورگر
      فیلد اختیاری
      عرض صفحه نمایش مرورگر مورد استفاده در ممیزی Lighthouse را برای شبیه‌سازی یک دستگاه خاص تنظیم کنید؛
      می‌توان آن را در بازه زیر مشخص کرد: 240–9999؛

    • categories
      نوع: array string[] | null

      دسته‌های ممیزی Lighthouse
      فیلد اختیاری
      هر دسته مجموعه‌ای از ممیزی‌ها و گروه‌های ممیزی است که وزن‌دهی و امتیازدهی را روی بخش اعمال می‌کند (تعریف رسمی را ببینید)

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

      مقادیر ممکن:
      seo، performance، best_practices، accessibility

    • custom_user_agent
      نوع: string | null

      user agent سفارشی
      فیلد اختیاری
      user agent سفارشی مورد استفاده مرورگر هنگام اجرای ممیزی Lighthouse را مشخص کنید؛
      می‌توان تا 254 کاراکتر مشخص کرد؛

    • for_mobile
      نوع: boolean | null

      اعمال شبیه‌سازی موبایل
      فیلد اختیاری
      اگر روی true تنظیم شود، Lighthouse از شبیه‌سازی دستگاه و صفحه نمایش موبایل برای آزمون صفحه در محیط موبایل استفاده می‌کند
      اگر روی false تنظیم شود، نتایج برای دسکتاپ ارائه می‌شود
      مقدار پیش‌فرض: false

    • language_code
      نوع: string | null

      کد زبان Lighthouse
      فیلد اختیاری
      می‌توانید فهرست زبان‌های موجود موتور جستجو را همراه با language_code آن‌ها با ارسال درخواست جداگانه به https://api.dataforseo.com/v3/on_page/lighthouse/languages دریافت کنید
      مقدار پیش‌فرض:
      en

    • language_name
      نوع: string | null

      نام زبان Lighthouse
      فیلد اختیاری
      می‌توانید فهرست زبان‌های موجود موتور جستجو را همراه با language_name آن‌ها با ارسال درخواست جداگانه به https://api.dataforseo.com/v3/on_page/lighthouse/languages دریافت کنید
      مقدار پیش‌فرض:
      English

    • tag
      نوع: string | null

      شناسه وظیفه تعریف‌شده توسط کاربر
      فیلد اختیاری
      محدودیت کاراکتر 255 است
      می‌توانید از این پارامتر برای شناسایی وظیفه و تطبیق آن با نتیجه استفاده کنید
      مقدار tag مشخص‌شده را در شیء data پاسخ پیدا می‌کنید

    • url
      نوع: string

      نشانی URL هدف
      فیلد الزامی
      صفحه هدف باید با نشانی URL مطلق آن (شامل http:// یا https://) مشخص شود
      مثال:
      https://dataforseo.com/

    • version
      نوع: string | null

      نسخه Lighthouse
      فیلد اختیاری
      می‌توانید با مشخص کردن شماره نسخه، نتایج مخصوص یک نسخه مشخص Lighthouse را دریافت کنید
      فهرست نسخه‌های موجود از طریق نقطه پایانی Lighthouse Versions در دسترس است

پاسخ‌ها
  • 200
    نوع: object | null · Response36Afe1097B20_OnPageLighthouseLiveJsonResponseInfo
    • cost
      نوع: number | null قالب: double

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

    • status_code
      نوع: integer | null

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

    • status_message
      نوع: string | null

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

    • tasks
      نوع: array (object | null)[] | null

      آرایه‌ای از وظایف

      • نوع: object | null · Response36Afe1097B20_OnPageLighthouseLiveJsonTaskInfo
        • cost
          نوع: number | null قالب: double

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

        • data
          نوع: object | null

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

          • propertyName
            نوع: object | null
        • id
          نوع: string | null

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

        • path
          نوع: array (string | null)[] | null

          مسیر URL

        • result
          نوع: array (object | null)[] | null

          نتایج ممیزی Lighthouse
          این آرایه داده‌ها را مطابق پارامترهایی در بر می‌گیرد که هنگام تنظیم وظیفه مشخص کرده‌اید؛

          همه فیلدها و توضیحات آن‌ها در مستندات رسمی از این پیوند در دسترس است.

          • propertyName
            نوع: object | null
        • result_count
          نوع: integer | null قالب: int64

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

        • status_code
          نوع: integer | null

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

        • status_message
          نوع: string | null

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

        • time
          نوع: string | null

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

    • tasks_count
      نوع: integer | null قالب: int64

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

    • tasks_error
      نوع: integer | null قالب: int64

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

    • time
      نوع: string | null

      زمان کل اجرا، بر حسب ثانیه

    • version
      نوع: string | null

      نسخه فعلی API

    application/json
  • 400

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

  • 401

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

  • 402

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

  • 403

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

  • 429

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

  • 502

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

  • 503

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

  • 504

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

  • default

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

    application/json
Request Example for post/v1/beta/dataforseo/on_page/lighthouse/live/json
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/lighthouse/live/json \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "url": "https://dataforseo.com",
    "for_mobile": true,
    "tag": "some_string_123"
  }
]'
{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        null
      ]
    }
  ]
}
Live OnPage Lighthouse JSON