v0.2.0-beta

OpenAPI 3.1.0

تنظیم وظایف OnPage

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/on_page/task_post

تنظیم وظایف OnPage

خزشی از target را آغاز می‌کند و id وظیفه را در tasks[0].id برمی‌گرداند — همین id دستگیره‌ای است که هر ابزار دیگر این خانواده لازم دارد، پس آن را نگه دارید. max_crawl_pages خزش را سقف می‌زند، start_url، max_crawl_depth، priority_urls و crawl_delay آن را شکل می‌دهند، و store_raw_html تعیین می‌کند که آیا post_dataforseo_on_page_raw_html بعداً چیزی برای ارائه خواهد داشت. پاسخ در پاکت DataForSEO قرار می‌گیرد: داده‌ها در tasks[0].result و نتیجه در tasks[0].status_code — درخواست ردشده نیز همچنان HTTP 200 برمی‌گرداند. ⚠️ این جفت ارسال/واکشی معمول نیست: خزش نشستی است که ده‌ها ابزار دیگر بعداً با id از آن می‌پرسند. get_dataforseo_on_page_summary را مکرراً بررسی کنید تا crawl_progress مقدار finished را بخواند؛ خزش یک‌صفحه‌ای example.com خیلی کمتر از یک دقیقه طول کشید.

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

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

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

بدنه

application/json

نوع: array (object | null)[]
- accept_language
 نوع: string | null
 
 هدر زبان برای دسترسی به وب‌سایت
 فیلد اختیاری
 همه قالب‌های زبان پشتیبانی می‌شوند (xx، xx-XX، xxx-XX و غیره)
 توجه: اگر این پارامتر را مشخص نکنید، ممکن است برخی وب‌سایت‌ها دسترسی را مسدود کنند؛ در این صورت، صفحه‌ها با "type":"broken در آرایه پاسخ بازگردانده می‌شوند
- allow_subdomains
 نوع: boolean | null
 
 شامل صفحه‌های زیردامنه‌ها
 فیلد اختیاری
 اگر می‌خواهید همه زیردامنه‌های یک وب‌سایت هدف را خزش کنید، آن را روی true تنظیم کنید
 مقدار پیش‌فرض: false
- allowed_subdomains
 نوع: array string[] | null
 
 زیردامنه‌های مورد خزش
 فیلد اختیاری
 زیردامنه‌هایی را که می‌خواهید خزش کنید مشخص کنید
 مثال: ["blog.site.com", "my.site.com", "shop.site.com"]
 توجه: برای استفاده از این پارامتر، پارامتر allow_subdomains باید روی false تنظیم شود؛
 در غیر این صورت، محتوای فیلد allowed_subdomains نادیده گرفته می‌شود و نتایج برای همه زیردامنه‌ها بازگردانده می‌شود
- browser_preset
 نوع: string | null
 
 پیش‌تنظیم پارامترهای صفحه نمایش مرورگر
 فیلد اختیاری
 اگر از این فیلد استفاده کنید، نیازی به تعیین browser_screen_width، browser_screen_height، browser_screen_scale_factor نیست مقادیر ممکن:
 desktop، mobile، tablet پیش‌تنظیم desktop مقادیر زیر را اعمال می‌کند:browser_screen_width: 1920
 browser_screen_height: 1080
 browser_screen_scale_factor: 1 پیش‌تنظیم mobile مقادیر زیر را اعمال می‌کند:browser_screen_width: 390
 browser_screen_height: 844
 browser_screen_scale_factor: 3 پیش‌تنظیم tablet مقادیر زیر را اعمال می‌کند:browser_screen_width: 1024
 browser_screen_height: 1366
 browser_screen_scale_factor: 2
 توجه: برای استفاده از این پارامتر، enable_javascript یا enable_browser_rendering را روی true تنظیم کنید
- browser_screen_height
 نوع: integer | null
 
 ارتفاع صفحه نمایش مرورگر
 فیلد اختیاری
 می‌توانید ارتفاع صفحه نمایش مرورگر را برای ممیزی یک دستگاه خاص سفارشی کنید؛
 اگر از این فیلد استفاده کنید، نیازی به تعیین browser_preset نیست زیرا نادیده گرفته می‌شود؛
 توجه: برای استفاده از این پارامتر، enable_javascript یا enable_browser_rendering را روی true تنظیم کنید حداقل مقدار، بر حسب پیکسل: 240
 حداکثر مقدار، بر حسب پیکسل: 9999
- browser_screen_scale_factor
 نوع: number | null
 
 ضریب مقیاس صفحه نمایش مرورگر
 فیلد اختیاری
 می‌توانید نسبت وضوح صفحه نمایش مرورگر را برای ممیزی یک دستگاه خاص سفارشی کنید؛
 اگر از این فیلد استفاده کنید، نیازی به تعیین browser_preset نیست زیرا نادیده گرفته می‌شود؛
 توجه: برای استفاده از این پارامتر، enable_javascript یا enable_browser_rendering را روی true تنظیم کنید حداقل مقدار: 0.5
 حداکثر مقدار: 3
- browser_screen_width
 نوع: integer | null قالب: int64
 
 عرض صفحه نمایش مرورگر
 فیلد اختیاری
 می‌توانید عرض صفحه نمایش مرورگر را برای ممیزی یک دستگاه خاص سفارشی کنید؛
 اگر از این فیلد استفاده کنید، نیازی به تعیین browser_preset نیست زیرا نادیده گرفته می‌شود؛
 توجه: برای استفاده از این پارامتر، enable_javascript یا enable_browser_rendering را روی true تنظیم کنید حداقل مقدار، بر حسب پیکسل: 240
 حداکثر مقدار، بر حسب پیکسل: 9999
- calculate_keyword_density
 نوع: boolean | null
 
 محاسبه چگالی کلمات کلیدی برای دامنه هدف
 فیلد اختیاری
 اگر می‌خواهید چگالی کلمات کلیدی را برای صفحه‌های وب‌سایت محاسبه کنید، آن را روی true تنظیم کنید
 مقدار پیش‌فرض: false
 توجه: اگر از این پارامتر استفاده کنید، هزینه اضافی اعمال می‌شود؛ درباره هزینه وظایف با این پارامتر در مقاله راهنمای ما بیشتر بدانید
 پس از تکمیل خزش، می‌توانید مقادیر چگالی کلمات کلیدی را با نقطه پایانی Keyword Density دریافت کنید
- check_spell
 نوع: boolean | null
 
 بررسی املا
 فیلد اختیاری
 برای بررسی املا در یک وب‌سایت با استفاده از کتابخانه Hunspell، آن را روی true تنظیم کنید
 مقدار پیش‌فرض: false
- check_spell_exceptions
 نوع: array string[] | null
 
 کلمات مستثنی‌شده از بررسی املا
 فیلد اختیاری
 کلماتی را که می‌خواهید از بررسی املا مستثنی کنید مشخص کنید
 حداکثر طول کلمه: 100 کاراکتر
 حداکثر تعداد کلمات: 1000
 مثال: "SERP", "minifiers", "JavaScript"
- check_spell_language
 نوع: string | null
 
 زبان بررسی املا
 فیلد اختیاری
 زبان‌های پشتیبانی‌شده: 'hy', 'eu', 'bg', 'ca', 'hr', 'cs', 'da', 'nl', 'en', 'eo', 'et', 'fo', 'fa', 'fr', 'fy', 'gl', 'ka', 'de', 'el', 'he', 'hu', 'is', 'ia', 'ga', 'it', 'rw', 'la', 'lv', 'lt', 'mk', 'mn', 'ne', 'nb', 'nn', 'pl', 'pt', 'ro', 'gd', 'sr', 'sk', 'sl', 'es', 'sv', 'tr', 'tk', 'uk', 'vi'
 توجه: اگر زبانی مشخص نشود، بر اساس محتوای صفحه به‌طور خودکار تنظیم می‌شود
- checks_threshold
 نوع: object | null
 
 مقادیر آستانه سفارشی برای بررسی‌ها
 فیلد اختیاری
 می‌توانید مقادیر آستانه سفارشی برای پارامترهای موجود در شیء checks در پاسخ‌های OnPage API مشخص کنید؛
 توجه: فقط مقادیر آستانه صحیح (integer) قابل تغییر هستند؛
 برای مثال، پارامترهای high_loading_time و large_page_size به‌طور پیش‌فرض به ترتیب روی 3 ثانیه و 1 مگابایت تنظیم شده‌اند؛
 اگر می‌خواهید این آستانه‌ها را به 1 ثانیه و 1000 کیلوبایت تغییر دهید، از قطعه زیر استفاده کنید:
 "checks_threshold": { "high_loading_time": 1, "large_page_size": 1000 }
 پارامترهای قابل‌تخصیص موجود همراه با مقادیر پیش‌فرض:
 "title_too_short", default value: 30, type: "int" "title_too_long", default value: 65, type: "int" "small_page_size", default value: 1024, type: "int" "large_page_size", default value: 1048576 (1024 * 1024), type: "int" "low_character_count", default value: 1024, type: "int" "high_character_count", default value: 256000 (250 * 1024), type: "int" "low_content_rate", default value: 0.1, type: "float" "high_content_rate", default value: 0.9, type: "float" "high_loading_time", default value: 3000, type: "int" "high_waiting_time", default value: 1500, type: "int" "low_readability_rate", default value: 15.0, type: "float" "irrelevant_description", default value: 0.2, type: "float" "irrelevant_title", default value: 0.3, type: "float" "irrelevant_meta_keywords", default value: 0.6, type: "float"
 
 propertyName
 نوع: integer | null قالب: int64
 
 Signed 64-bit integers (long type).
- crawl_delay
 نوع: integer | null
 
 تأخیر بین بازدیدها، به میلی‌ثانیه
 فیلد اختیاری
 تأخیر سفارشی بین بازدیدهای خزنده از سرور
 مقدار پیش‌فرض: 2000
- crawl_sitemap_only
 نوع: boolean | null
 
 خزش فقط صفحه‌های مشخص‌شده در نقشه سایت
 فیلد اختیاری
 اگر می‌خواهید فقط صفحه‌های مشخص‌شده در نقشه سایت را خزش کنید، آن را روی true تنظیم کنید
 اگر این پارامتر را روی true تنظیم کنید و custom_sitemap را مشخص نکنید، نقشه سایت پیش‌فرض را خزش می‌کنیم
 مقدار پیش‌فرض: false
 نکته: برای استفاده از این پارامتر، باید respect_sitemap روی true باشد
- custom_js
 نوع: string | null
 
 جاوااسکریپت سفارشی
 فیلد اختیاری
 توجه داشته باشید که زمان اجرای اسکریپتی که اینجا وارد می‌کنید باید حداکثر 700 میلی‌ثانیه باشد؛ برای مثال می‌توانید از قطعه JS زیر برای بررسی وجود Google Tag Manager در وب‌سایت به‌عنوان ویژگی scr استفاده کنید:
 let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i < document.scripts.length; i++) {rn let src = document.scripts[i].getAttribute("src");rn if (src != undefined) {rn if (src.indexOf("analytics.js") >= 0)rn meta.haveGoogleAnalytics = true;rntif (src.indexOf("gtm.js") >= 0)rn meta.haveTagManager = true;rn }rn}rnmeta;مقدار برگشتی به آنچه در این فیلد مشخص کرده‌اید بستگی دارد. برای مثال، اگر اسکریپت زیر را مشخص کنید:
 meta = {}; meta.url = document.URL; meta.test = 'test'; meta;
 در پاسخ داده‌های زیر را دریافت خواهید کرد:
 "custom_js_response": { "url": "https://dataforseo.com/", "test": "test" }
 نکته: طول اسکریپتی که وارد می‌کنید نباید بیش از 2000 کاراکتر باشد
- custom_robots_txt
 نوع: string | null
 
 تنظیمات سفارشی robots.txt
 فیلد اختیاری
 مثال: Disallow: /directory1/
- custom_sitemap
 نوع: string | null
 
 نشانی سفارشی نقشه سایت
 فیلد اختیاری
 نشانی URL صفحه‌ای که نقشه سایت جایگزین در آن قرار دارد
 نکته: برای استفاده از این پارامتر، باید respect_sitemap روی true باشد
- custom_user_agent
 نوع: string | null
 
 user agent سفارشی
 فیلد اختیاری
 user agent سفارشی برای خزش وب‌سایت
 مثال: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36
 مقدار پیش‌فرض: Mozilla/5.0 (compatible; RSiteAuditor)
- disable_cookie_popup
 نوع: boolean | null
 
 غیرفعال کردن پنجره بازشوی کوکی
 فیلد اختیاری
 اگر می‌خواهید پنجره بازشویی را که از کاربر رضایت کوکی می‌خواهد غیرفعال کنید، آن را روی true تنظیم کنید؛
 مقدار پیش‌فرض:
 false
- disable_page_checks
 نوع: array string[] | null
 
 جلوگیری از اجرای برخی بررسی‌های صفحه
 فیلد اختیاری
 برخی checks را مشخص کنید تا از اجرای آن‌ها و تأثیرشان بر onpage_score جلوگیری شودمثال:
 "disable_page_checks": ["is_5xx_code", "is_4xx_code"]
- disable_sitewide_checks
 نوع: array string[] | null
 
 جلوگیری از اجرای برخی بررسی‌های سراسری سایت
 فیلد اختیاری
 checks زیر را مشخص کنید تا از اجرای آن‌ها در وب‌سایت target جلوگیری شود:
 "test_page_not_found"
 "test_canonicalization"
 "test_https_redirect"
 "test_directory_browsing"مثال:
 "disable_sitewide_checks": ["test_directory_browsing", "test_page_not_found"]بیشتر بدانید در مرکز راهنمایی
- disallowed_subdomains
 نوع: array string[] | null
 
 زیردامنه‌هایی که نباید خزش شوند
 فیلد اختیاری
 زیردامنه‌هایی را مشخص کنید که نمی‌خواهید خزش شوند
 مثال: ["status.site.com", "docs.site.com"]
 نکته: برای استفاده از این پارامتر، پارامتر allow_subdomains باید روی true تنظیم شود
- enable_browser_rendering
 نوع: boolean | null
 
 شبیه‌سازی رندر مرورگر برای اندازه‌گیری Core Web Vitals
 فیلد اختیاری
 با استفاده از این پارامتر می‌توانید هنگام بارگذاری صفحه وب، مرورگر را شبیه‌سازی کنید؛
 enable_browser_rendering استایل‌ها، تصاویر، فونت‌ها، انیمیشن‌ها، ویدیوها و سایر منابع صفحه را بارگذاری می‌کند؛
 مقدار پیش‌فرض: false
 برای دریافت سنجه‌های Core Web Vitals (FID, CLS, LCP) در پاسخ، آن را روی true تنظیم کنید؛
 اگر از این فیلد استفاده می‌کنید، پارامترهای enable_javascript و load_resources باید روی true تنظیم شوند
 نکته: در صورت استفاده از این پارامتر، هزینه اضافی اعمال می‌شود؛ درباره هزینه وظایف دارای این پارامتر در مقاله راهنمای ما بیشتر بدانید؛ هزینه را می‌توان در صفحه قیمت‌گذاری محاسبه کرد
- enable_content_parsing
 نوع: boolean | null
 
 تجزیه محتوا در صفحه‌های خزش‌شده
 فیلد اختیاری
 برای استفاده از نقطه پایانی OnPage Content Parsing آن را روی true تنظیم کنید
 مقدار پیش‌فرض: false
- enable_javascript
 نوع: boolean | null
 
 بارگذاری جاوااسکریپت در صفحه
 فیلد اختیاری
 اگر می‌خواهید اسکریپت‌های موجود در صفحه را بارگذاری کنید، آن را روی true تنظیم کنید
 مقدار پیش‌فرض: false
 نکته: در صورت استفاده از این پارامتر، هزینه اضافی اعمال می‌شود؛ درباره هزینه وظایف دارای این پارامتر در مقاله راهنمای ما بیشتر بدانید؛ هزینه را می‌توان در صفحه قیمت‌گذاری محاسبه کرد
- enable_www_redirect_check
 نوع: boolean | null
 
 بررسی پیاده‌سازی تغییرمسیر www توسط دامنه
 فیلد اختیاری
 اگر می‌خواهید بررسی کنید که دامنه درخواستی تغییرمسیر www به non-www یا non-www به www را پیاده‌سازی کرده است، آن را روی true تنظیم کنید؛
 مقدار پیش‌فرض: false
- enable_xhr
 نوع: boolean | null
 
 فعال‌سازی XMLHttpRequest در صفحه
 فیلد اختیاری
 اگر می‌خواهید خزنده ما با استفاده از شیء XMLHttpRequest داده‌هایی را از یک وب‌سرور درخواست کند، آن را روی true تنظیم کنید
 مقدار پیش‌فرض: false؛اگر از این فیلد استفاده می‌کنید، enable_javascript باید روی true تنظیم شود؛
- force_sitewide_checks
 نوع: boolean | null
 
 فعال‌سازی بررسی‌های سراسری سایت هنگام خزش یک صفحه
 فیلد اختیاری
 برای دریافت داده‌های مربوط به بررسی‌های سراسری سایت هنگام خزش یک صفحه، آن را روی true تنظیم کنید؛
 مقدار پیش‌فرض: false
- load_resources
 نوع: boolean | null
 
 بارگذاری منابع
 فیلد اختیاری
 اگر می‌خواهید تصاویر، شیت‌های استایل، اسکریپت‌ها و منابع شکسته را بارگذاری کنید، آن را روی true تنظیم کنید
 مقدار پیش‌فرض: false
 نکته: در صورت استفاده از این پارامتر، هزینه اضافی اعمال می‌شود؛ درباره هزینه وظایف دارای این پارامتر در مقاله راهنمای ما بیشتر بدانید؛ هزینه را می‌توان در صفحه قیمت‌گذاری محاسبه کرد
- max_crawl_depth
 نوع: integer | null
 
 عمق خزش
 فیلد اختیاری
 عمق پیوند صفحه‌های مورد خزش؛
 برای مثال، صفحه شروع خزش سطح 0 است، صفحه‌هایی که از آن صفحه پیوند دارند سطح 1 هستند و غیره.
- max_crawl_pages
 نوع: integer
 
 محدودیت صفحه‌های خزش‌شده
 فیلد الزامی
 تعداد صفحه‌های مورد خزش در دامنه مشخص‌شده
 نکته:
 اگر max_crawl_pages را روی 1 تنظیم کنید و start_url را مشخص نکنید یا در آن صفحه اصلی قرار دهید، بررسی‌های سراسری سایت زیر غیرفعال می‌شوند:
 test_canonicalization، enable_www_redirect_check، test_hidden_server_signature، test_page_not_found، test_directory_browsing، test_https_redirect
 برای فعال‌سازی آن‌ها به‌هرحال، force_sitewide_checks را روی true تنظیم کنیداگر max_crawl_pages را روی 1 تنظیم کنید و start_url غیر از صفحه اصلی مشخص کنید، همه بررسی‌های سراسری سایت غیرفعال می‌شوند؛
 برای فعال‌سازی آن‌ها به‌هرحال، force_sitewide_checks را روی true تنظیم کنید
- pingback_url
 نوع: string | null
 
 نشانی URL اطلاع‌رسانی تکمیل وظیفه
 فیلد اختیاری
 وقتی وظیفه تکمیل شد، با ارسال درخواست GET به نشانی URL که تعیین کرده‌اید به شما اطلاع می‌دهیم
 می‌توانید رشته ‘$id’ را به‌عنوان متغیر $id و ‘$tag’ را به‌عنوان متغیر $tag کدگذاری‌شده با urlencoded استفاده کنید. مقادیر لازم را پیش از ارسال درخواست تنظیم می‌کنیم.
 مثال:
 http://your-server.com/pingscript?id=$id
 http://your-server.com/pingscript?id=$id&tag=$tag
 توجه: کاراکترهای خاص در pingback_url با urlencoded کدگذاری می‌شوند;
 از جمله کاراکتر # به %23 کدگذاری می‌شود
 
 در مرکز راهنمایی ما بیشتر بدانید
- priority_urls
 نوع: array string[] | null
 
 نشانی‌های URL مورد خزش با دور زدن صف
 فیلد اختیاری
 نشانی‌های URL مشخص‌شده در این آرایه ابتدا و با دور زدن صف خزش، خزش می‌شوند؛
 نکته: باید نشانی URL مطلق را مشخص کنید؛
 می‌توانید حداکثر 20 نشانی URL مشخص کنید؛
 همه نشانی‌های URL در آرایه باید متعلق به دامنه target باشند؛
 زیردامنه‌ها نادیده گرفته می‌شوند مگر اینکه پارامتر allow_subdomains روی true تنظیم شده باشدمثال:
 "priority_urls": [ "https://dataforseo.com/apis/serp-api", "https://dataforseo.com/contact" ]
- respect_sitemap
 نوع: boolean | null
 
 رعایت نقشه سایت هنگام خزش
 فیلد اختیاری
 اگر می‌خواهید هنگام خزش، ترتیب صفحه‌های مشخص‌شده در نقشه سایت اصلی را دنبال کنید، آن را روی true تنظیم کنید؛
 مقدار پیش‌فرض: false
 نکته: اگر روی true تنظیم شود، مقدار click_depth در پاسخ API برابر 0 خواهد بود؛
 فیلد max_crawl_depth درخواست نادیده گرفته می‌شود؛ می‌توانید تعداد صفحه‌های مورد خزش را با پارامتر max_crawl_pages مشخص کنید
- return_despite_timeout
 نوع: boolean | null
 
 بازگرداندن داده‌های صفحه‌ها با وجود خطای timeout
 فیلد اختیاری
 اگر true باشد، داده‌های صفحه‌هایی ارائه می‌شود که در 120 ثانیه بارگذاری نشده‌اند و با خطای timeout پاسخ داده‌اند؛
 مقدار پیش‌فرض: false
- robots_txt_merge_mode
 نوع: string | null
 
 ادغام یا نادیده گرفتن تنظیمات robots.txt
 فیلد اختیاری
 مقادیر ممکن: merge، override؛
 اگر می‌خواهید محدودیت‌های خزش وب‌سایت و سایر تنظیمات robots.txt را نادیده بگیرید، آن را روی override تنظیم کنید
 مقدار پیش‌فرض: merge؛
 نکته: اگر روی override تنظیم کردید، پارامتر custom_robots_txt را مشخص کنید
- start_url
 نوع: string | null
 
 نخستین نشانی URL برای خزش
 فیلد اختیاری
 نکته: باید یک نشانی URL مطلق مشخص کنید
 اگر می‌خواهید یک صفحه را خزش کنید، نشانی URL آن را در این فیلد مشخص کنید و علاوه بر آن پارامتر max_crawl_pages را روی 1 تنظیم کنید
 همچنین می‌توانید از نقطه پایانی زنده Instant Pages برای دریافت داده‌های مخصوص صفحه استفاده کنید
- store_raw_html
 نوع: boolean | null
 
 ذخیره HTML صفحه‌های خزش‌شده
 فیلد اختیاری
 اگر می‌خواهید HTML صفحه را با استفاده از نقطه پایانی OnPage Raw HTML دریافت کنید، آن را روی true تنظیم کنید
 مقدار پیش‌فرض: false
- support_cookies
 نوع: boolean | null
 
 پشتیبانی از کوکی‌ها در صفحه‌های خزش‌شده
 فیلد اختیاری
 برای پشتیبانی از کوکی‌ها هنگام خزش صفحه‌ها، آن را روی true تنظیم کنید
 مقدار پیش‌فرض: false
- switch_pool
 نوع: boolean | null
 
 تغییر استخر پروکسی
 فیلد اختیاری
 اگر مقدار true باشد، از استخرهای پروکسی اضافی برای دریافت داده‌های درخواستی استفاده می‌شود؛
 اگر تعداد زیادی وظیفه هم‌زمان تنظیم شود و خطاهای پراکنده rate-limit و/یا site_unreachable رخ دهد، می‌توان از این پارامتر استفاده کرد
- tag
 نوع: string | null
 
 شناسه وظیفه تعریف‌شده توسط کاربر
 فیلد اختیاری
 محدودیت کاراکتر 255 است
 می‌توانید از این پارامتر برای شناسایی وظیفه و تطبیق آن با نتیجه استفاده کنید
 مقدار tag مشخص‌شده را در شیء data پاسخ پیدا می‌کنید
- target
 نوع: string
 
 دامنه هدف
 فیلد الزامی
 نام دامنه باید بدون https:// و www. مشخص شود
 اگر نشانی URL صفحه را مشخص کنید، نتایج برای دامنه موجود در URL برگردانده می‌شود
- validate_micromarkup
 نوع: boolean | null
 
 فعال‌سازی اعتبارسنجی microdata
 فیلد اختیاری
 اگر می‌خواهید از نقطه پایانی Microdata در OnPage API استفاده کنید، آن را روی true تنظیم کنید
 مقدار پیش‌فرض: false

پاسخ‌ها

200
نوع: object | null · Response36Afe1097B20_OnPageTaskPostResponseInfo
cost
نوع: number | null قالب: double

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

status_code
نوع: integer | null

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

status_message
نوع: string | null

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

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

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

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

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

data
نوع: object | null

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

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

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

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

مسیر URL

result
نوع: object | null

آرایه‌ای از نتایج
در این حالت، مقدار 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

post/v1/beta/dataforseo/on_page/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "dataforseo.com",
    "max_crawl_pages": 10,
    "load_resources": true,
    "enable_javascript": true,
    "custom_js": "meta = {}; meta.url = document.URL; meta;",
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  }
]'

نمایش اسکیما

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

عملیات موفق

تنظیم وظایف OnPage

احراز هویتRequired

DataForSEO

تنظیم وظایف OnPage

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