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

خلاصه در OnPage API

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

DataForSEO

​

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

خلاصه در OnPage API

​

وضعیت و سنجه‌های اصلی یک خزش، بر اساس id. crawl_progress، crawl_status، crawl_gateway_address، crawl_stop_reason، domain_info و page_metrics را برمی‌گرداند. پاسخ در پاکت DataForSEO قرار می‌گیرد: داده‌ها در tasks[0].result و نتیجه در tasks[0].status_code — درخواست ردشده نیز همچنان HTTP 200 برمی‌گرداند. این همچنین راه فهمیدن پایان خزش است — پیش از خواندن هر نقطه پایانی دیگر اینجا آن را مکرراً بررسی کنید تا crawl_progress برابر finished شود، وگرنه نتایج جزئی می‌خوانید که واقعی به نظر می‌رسند. 💰 رایگان از سمت بالادست: پرس‌وجو درباره خزش تکمیل‌شده هزینه‌ای ندارد، فقط خود خزش.

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

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

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

پارامترهای مسیر
  • id
    نوع: string
    الزامی

    شناسه وظیفه
    فیلد الزامی
    می‌توانید این شناسه را در پاسخ نقطه پایانی Task POST دریافت کنید
    مثال:
    “07131248-1535-0216-1000-17384017ad04”

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

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

    • status_code
      نوع: integer | null

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

    • status_message
      نوع: string | null

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

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

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

      • نوع: object | null · Response36Afe1097B20_OnPageSummaryTaskInfo
        • 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

          آرایه‌ای از نتایج

          • crawl_gateway_address
            نوع: string | null

            نشانی IP خزنده
            نشانی IP مورد استفاده خزنده برای آغاز نشست خزش جاری را نشان می‌دهد
            فهرست کامل IPهای مورد استفاده خزنده ما را می‌توانید در بخش مرور کلی بیابید

          • crawl_progress
            نوع: string | null

            وضعیت نشست خزش
            مقادیر ممکن: in_progress، finished

          • crawl_status
            نوع: object | null · Response36Afe1097B20_CrawlStatusInfo

            جزئیات نشست خزش

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

              حداکثر تعداد صفحه‌های قابل خزش محدوده max_crawl_pages را نشان می‌دهد که هنگام تنظیم وظیفه تعیین کرده‌اید

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

              تعداد صفحه‌های خزش‌شده

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

              تعداد صفحه‌هایی که در حال حاضر در صف خزش قرار دارند

          • crawl_stop_reason
            نوع: string | null

            دلیل توقف خزش
            اطلاعات مربوط به دلیل توقف فرایند خزش؛
            مقادیر ممکن:
            limit_exceeded - از سقف تعیین‌شده در max_crawl_pages فراتر رفته است؛
            empty_queue - همه URLهای صف خزش شده‌اند؛
            force_stopped - فرایند خزش با تابع On Page API Force Stop متوقف شده است؛
            unexpected_exception - هنگام خزش target خطای داخلی رخ داده است، برای اطلاعات بیشتر با پشتیبانی تماس بگیرید

          • domain_info
            نوع: object | null · Response36Afe1097B20_DomainInfo

            اطلاعات در سطح دامنه
            اطلاعات درون‌صفحه‌ای درباره دامنه هدف و فرایند خزش

            • canonicalization_status_code
              نوع: integer | null

              کد وضعیت برگردانده‌شده توسط صفحه کانونیکال‌شده
              بررسی رفتار سرور هنگام تلاش خزنده ما برای دسترسی به وب‌سایت از طریق IP
              در بیشتر موارد توصیه می‌شود صفحه‌های کانونیکال‌شده کد وضعیت 301 یا 302 برگردانند

            • checks
              نوع: object | null

              بررسی‌های وب‌سایت
              سایر بررسی‌های درون‌صفحه‌ای مرتبط با وب‌سایت

              • propertyName
                نوع: boolean | null
            • cms
              نوع: string | null

              سیستم مدیریت محتوا
              سیستم مدیریت محتوای شناسایی‌شده در وب‌سایت
              محتوای تگ متای generator
              داده‌ها از نخستین صفحه تصادفی که کد پاسخ 200 برمی‌گرداند گرفته می‌شوند
              اگر خزنده ما نتواند سیستم مدیریت محتوا را شناسایی کند، مقدار null خواهد بود

            • crawl_end
              نوع: string | null

              زمان پایان خزش
              تاریخ و زمانی که خزش تکمیل شد
              در قالب UTC: “yyyy-mm-dd hh-mm-ss +00:00”
              مثال:
              2019-11-15 12:57:46 +00:00
              توجه: فقط جنبه اطلاع‌رسانی دارد اگر "crawl_progress" برابر "finished" باشد
              اگر "crawl_progress" برابر in_progress باشد، مقدار null خواهد بود

            • crawl_start
              نوع: string | null

              زمان شروع خزش
              تاریخ و زمانی که وب‌سایت برای خزش ارسال شد
              در قالب UTC: “yyyy-mm-dd hh-mm-ss +00:00”
              مثال:
              2019-11-15 12:57:46 +00:00

            • directory_browsing_status_code
              نوع: integer | null

              کد وضعیت برگردانده‌شده توسط دایرکتوری
              کد وضعیتی که صفحه دایرکتوری در وب‌سایت هدف برمی‌گرداند
              در بیشتر موارد توصیه می‌شود دایرکتوری‌ها کد وضعیت 403 یا 401 برگردانند

            • extended_crawl_status
              نوع: string | null

              وضعیت و خطاهای خزش
              دلیل خزش‌نشدن یک وب‌سایت را نشان می‌دهد
              می‌تواند مقادیر زیر را داشته باشد:
              no_errors - هیچ خطای خزشی شناسایی نشد
              site_unreachable - خزنده ما نتوانست به وب‌سایت برسد و در نتیجه نتوانست کد وضعیت را دریافت کند
              invalid_page_status_code - کد وضعیت نخستین صفحه خزش‌شده >= 400
              forbidden_meta_tag - نخستین صفحه خزش‌شده شامل تگ <meta robots="noindex"> است
              forbidden_robots - robots.txt خزش صفحه را ممنوع می‌کند
              forbidden_http_header - سرآیند HTTP صفحه شامل "X-Robots-Tag: noindex" است
              too_many_redirects - نخستین صفحه خزش‌شده بیش از 10 تغییر مسیر دارد
              unknown - دلیل نامشخص است

            • ip
              نوع: string | null

              نشانی IP دامنه

            • main_domain
              نوع: string | null

              نام دامنه ریشه

            • name
              نوع: string | null

              نام دامنه

            • page_not_found_status_code
              نوع: integer | null

              کد وضعیت برگردانده‌شده توسط صفحه غیرموجود
              در بیشتر موارد توصیه می‌شود سرور کد پاسخ 404 برگرداند

            • server
              نوع: string | null

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

            • ssl_info
              نوع: object | null · Response36Afe1097B20_SslInfo

              اطلاعات گواهی SSL
              اطلاعاتی درباره پروتکل Secure Sockets Layer شناسایی‌شده در وب‌سایت

              • certificate_expiration_date
                نوع: string | null

                تاریخ انقضای گواهی SSL
                تاریخ و زمانی که گواهی SSL منقضی می‌شود
                در قالب UTC: “yyyy-mm-dd hh-mm-ss +00:00”
                مثال:
                2019-11-15 12:57:46 +00:00

              • certificate_hash
                نوع: string | null

                هش گواهی SSL
                نسخه تابع هش گواهی SSL

              • certificate_issuer
                نوع: string | null

                مرجع گواهی SSL
                نهادی که گواهی SSL شناسایی‌شده را صادر کرده است

              • certificate_subject
                نوع: string | null

                موضوع گواهی SSL
                نهاد مرتبط با کلید عمومی

              • certificate_version
                نوع: integer | null

                نسخه گواهی SSL
                نسخه X.509 استفاده‌شده توسط گواهی SSL را نشان می‌دهد

              • valid_certificate
                نوع: boolean | null

                اعتبار گواهی SSL
                نشان می‌دهد آیا گواهی SSL شناسایی‌شده در وب‌سایت منقضی، معلق، باطل یا نامعتبر نیست

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

              کل صفحه‌های خزش‌شده
              تعداد کل صفحه‌های خزش‌شده

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

              کل منابع غیرقابل خزش
              تعداد کل منابعی که نمی‌توانستند خزش شوند
              یک منبع زمانی غیرقابل خزش در نظر گرفته می‌شود که نوع محتوای واقعی آن با نوع محتوای مورد انتظار خزنده مطابقت نداشته باشد

            • www_redirect_status_code
              نوع: integer | null

              کد وضعیت تغییر مسیر
              کد وضعیت تغییر مسیر از www به non-www
              در بیشتر موارد توصیه می‌شود تغییر مسیر کد وضعیت 301 برگرداند

          • page_metrics
            نوع: object | null · Response36Afe1097B20_PageMetrics

            اطلاعات ویژه صفحه
            اطلاعات معیارها درباره صفحه‌های وب‌سایت هدف

            • broken_links
              نوع: integer | null

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

            • broken_resources
              نوع: integer | null

              تعداد منابع شکسته
              تعداد تصاویر و دیگر منابع دارای پیوندهای شکسته

            • checks
              نوع: object | null

              بررسی‌های درون‌صفحه‌ای ویژه صفحه

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

                Signed 64-bit integers (long type).

            • duplicate_content
              نوع: integer | null

              تعداد صفحه‌های دارای محتوای تکراری

            • duplicate_description
              نوع: integer | null

              تعداد صفحه‌های دارای توضیحات تکراری

            • duplicate_title
              نوع: integer | null

              تعداد صفحه‌های دارای عنوان‌های تکراری

            • links_external
              نوع: integer | null

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

            • links_internal
              نوع: integer | null

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

            • links_relation_conflict
              نوع: integer | null

              تعداد پیوندهای موجود در وب‌سایت هدف که ممکن است تعارض داشته باشند
              برای مثال، اگر "links_relation_conflict": 2 باشد، وب‌سایت هدف با حداقل یک پیوند داخلی دارای ویژگی rel="nofollow" و حداقل یک پیوند dofollow به همان منبع اشاره می‌کند

            • non_indexable
              نوع: integer | null

              تعداد صفحه‌های فهرست‌نشدنی
              تعداد صفحه‌هایی که با robots.txt، هدرهای HTTP یا تنظیمات تگ‌های meta از فهرست‌شدن توسط Google و دیگر موتورهای جست‌وجو مسدود شده‌اند؛
              می‌توانید فهرستی از URLهای فهرست‌نشدنی را با این نقطه پایانی دریافت کنید

            • onpage_score
              نوع: number | null

              میزان بهینه‌سازی وب‌سایت را در مقیاس 100 امتیازی نشان می‌دهد
              این فیلد نشان می‌دهد وب‌سایت با در نظر گرفتن مشکلات بحرانی و هشدارهای شناسایی‌شده درون صفحه چقدر بهینه است؛
              100 بالاترین امتیاز ممکن است و یعنی وب‌سایت هیچ مشکل بحرانی یا هشدار مهم درون‌صفحه‌ای ندارد؛
              توجه که این مقدار به تعداد صفحه‌های خزش‌شده بستگی دارد؛
              درباره نحوه محاسبه این معیار در این مقاله مرکز راهنمایی بیشتر بدانید

            • redirect_loop
              نوع: integer | null

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

        • 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 get/v1/beta/dataforseo/on_page/summary/{id}
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/summary/00000000-0000-0000-0000-000000000000 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "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": [
        {
          "crawl_progress": null,
          "crawl_status": {
            "max_crawl_pages": null,
            "pages_in_queue": null,
            "pages_crawled": null
          },
          "crawl_gateway_address": null,
          "crawl_stop_reason": null,
          "domain_info": {
            "name": null,
            "cms": null,
            "ip": null,
            "server": null,
            "crawl_start": null,
            "crawl_end": null,
            "extended_crawl_status": null,
            "ssl_info": "[Max Depth Exceeded]",
            "checks": null,
            "total_pages": null,
            "total_uncrawlable_resources": null,
            "page_not_found_status_code": null,
            "canonicalization_status_code": null,
            "directory_browsing_status_code": null,
            "www_redirect_status_code": null,
            "main_domain": null
          },
          "page_metrics": {
            "links_external": null,
            "links_internal": null,
            "duplicate_title": null,
            "duplicate_description": null,
            "duplicate_content": null,
            "broken_links": null,
            "broken_resources": null,
            "links_relation_conflict": null,
            "redirect_loop": null,
            "onpage_score": null,
            "non_indexable": null,
            "checks": null
          }
        }
      ]
    }
  ]
}
OnPage API Summary