dataforseo-client 2.1.2 → 2.1.5

package/dist/esm/models/OnPageTaskPostRequestInfo.d.ts

@@ -1,182 +1,182 @@
 export interface IOnPageTaskPostRequestInfo {
-    /** target domain required field domain name should be specified without https:// and www. if you specify the page URL, the results will be returned for the domain included in the URL */
+    /** *target domain* **required field** domain name should be specified without `https://` and `www.` if you specify the page URL, the results will be returned for the domain included in the URL */
     target?: string | undefined;
-    /** crawled pages limit required field the number of pages to crawl on the specified domain Note: if you set max_crawl_pages to 1 and do not specify start_url or set a homepage in it, the following sitewide checks will be disabled: test_canonicalization, enable_www_redirect_check, test_hidden_server_signature, test_page_not_found, test_directory_browsing, test_https_redirect to enable them anyway, set force_sitewide_checks to trueif you set max_crawl_pages to 1 and specify start_url other than a homepage, all sitewide checks will be disabled; to enable them anyway, set force_sitewide_checks to true */
+    /** *crawled pages limit* **required field** the number of pages to crawl on the specified domain **Note:** if you set `max_crawl_pages` to 1 and do not specify `start_url` or set a homepage in it, the following sitewide checks will be disabled: `test_canonicalization`, `enable_www_redirect_check`, `test_hidden_server_signature`, `test_page_not_found`, `test_directory_browsing`, `test_https_redirect` to enable them anyway, set `force_sitewide_checks` to `true`if you set `max_crawl_pages` to 1 and specify `start_url` other than a homepage, all sitewide checks will be disabled; to enable them anyway, set `force_sitewide_checks` to `true` */
     max_crawl_pages?: number | undefined;
-    /** the first url to crawl  optional field Note: you should specify an absolute URL if you want to crawl a single page, specify its URL in this field and additionally set the max_crawl_pages parameter to 1 you can also use the live Instant Pages endpoint to get page-specific data */
+    /** *the first url to crawl* optional field **Note:** you should specify an absolute URL if you want to crawl a single page, specify its URL in this field and additionally set the `max_crawl_pages` parameter to `1` you can also use the [live Instant Pages endpoint](/v3/on_page/instant_pages/?bash) to get page-specific data */
     start_url?: string | undefined;
-    /** enable sitewide checks when crawling a single page optional field set to true to get data on sitewide checks when crawling a single page; default value: false */
+    /** *enable sitewide checks when crawling a single page* optional field set to `true` to get data on sitewide checks when crawling a single page; default value: `false` */
     force_sitewide_checks?: boolean | undefined;
-    /** urls to be crawled bypassing the queue optional field URLs specified in this array will be crawled in the first instance, bypassing the crawling queue; Note: you should specify the absolute URL; you can specify up to 20 URLs; all URLs in the array must belong to the target domain; subdomains will be ignored unless the allow_subdomains parameter is set to trueexample: 'priority_urls': [ 'https://dataforseo.com/apis/serp-api', 'https://dataforseo.com/contact' ] */
+    /** *urls to be crawled bypassing the queue* optional field URLs specified in this array will be crawled in the first instance, bypassing the crawling queue; **Note:** you should specify the absolute URL; you can specify up to **20 URLs**; all URLs in the array must belong to the `target` domain; subdomains will be ignored unless the `allow_subdomains` parameter is set to `true`example: `'priority_urls': [ 'https://dataforseo.com/apis/serp-api', 'https://dataforseo.com/contact' ]` */
     priority_urls?: string[] | undefined;
-    /** crawl depth optional field the linking depth of the pages to crawl; for example, starting page of the crawl is level 0, pages that have links from that page are level 1, etc. */
+    /** *crawl depth* optional field the linking depth of the pages to crawl; for example, starting page of the crawl is level 0, pages that have links from that page are level 1, etc. */
     max_crawl_depth?: number | undefined;
-    /** delay between hits, ms optional field the custom delay between crawler hits to the server default value: 2000 */
+    /** *delay between hits, ms* optional field the custom delay between crawler hits to the server default value: `2000` */
     crawl_delay?: number | undefined;
-    /** store HTML of crawled pages optional field set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint default value: false */
+    /** *store HTML of crawled pages* optional field set to `true` if you want to get the HTML of the page using the [OnPage Raw HTML endpoint](/v3/on_page/raw_html/) default value: `false` */
     store_raw_html?: boolean | undefined;
-    /** parse content on crawled pages optional field set to true to use the OnPage Content Parsing endpoint default value: false */
+    /** *parse content on crawled pages* optional field set to `true` to use the [OnPage Content Parsing endpoint](/v3/on_page/content_parsing/live/) default value: `false` */
     enable_content_parsing?: boolean | undefined;
-    /** support cookies on crawled pages optional field set to true to support cookies when crawling the pages default value: false */
+    /** *support cookies on crawled pages* optional field set to `true` to support cookies when crawling the pages default value: `false` */
     support_cookies?: boolean | undefined;
-    /** language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the 'type':'broken in the response array */
+    /** *language header for accessing the website* optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) **Note:** if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the `'type':'broken` in the response array */
     accept_language?: string | undefined;
-    /** custom robots.txt settings optional field example: Disallow: /directory1/ */
+    /** *custom robots.txt settings* optional field example: `Disallow: /directory1/` */
     custom_robots_txt?: string | undefined;
-    /** merge with or override robots.txt settings optional field possible values: merge, override; set to override if you want to ignore website crawling restrictions and other robots.txt settings default value: merge; Note: if set to override, specify the custom_robots_txt parameter */
+    /** *merge with or override robots.txt settings* optional field possible values: `merge`, `override`; set to `override` if you want to ignore website crawling restrictions and other robots.txt settings default value: `merge`; **Note:** if set to `override`, specify the `custom_robots_txt` parameter */
     robots_txt_merge_mode?: string | undefined;
-    /** custom user agent optional field custom user agent for crawling a website example: 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 default value: Mozilla/5.0 (compatible; RSiteAuditor) */
+    /** *custom user agent* optional field custom user agent for crawling a website example: `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` default value: `Mozilla/5.0 (compatible; RSiteAuditor)` */
     custom_user_agent?: string | undefined;
-    /** preset for browser screen parameters optional field if you use this field, you don’t need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values: desktop, mobile, tabletdesktop preset will apply the following values:browser_screen_width: 1920 browser_screen_height: 1080 browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390 browser_screen_height: 844 browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024 browser_screen_height: 1366 browser_screen_scale_factor: 2 Note: to use this parameter, set enable_javascript or enable_browser_rendering to true */
+    /** *preset for browser screen parameters* optional field if you use this field, you don't need to indicate `browser_screen_width`, `browser_screen_height`, `browser_screen_scale_factor`possible values: `desktop`, `mobile`, `tablet``desktop` preset will apply the following values:`browser_screen_width: 1920` `browser_screen_height: 1080` `browser_screen_scale_factor: 1``mobile` preset will apply the following values:`browser_screen_width: 390` `browser_screen_height: 844` `browser_screen_scale_factor: 3``tablet` preset will apply the following values:`browser_screen_width: 1024` `browser_screen_height: 1366` `browser_screen_scale_factor: 2` **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true` */
     browser_preset?: string | undefined;
-    /** browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240 maximum value, in pixels: 9999 */
+    /** *browser screen width* optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored; **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`minimum value, in pixels: `240` maximum value, in pixels: `9999` */
     browser_screen_width?: number | undefined;
-    /** browser screen height optional field you can set a custom browser screen height to perform an audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240 maximum value, in pixels: 9999 */
+    /** *browser screen height* optional field you can set a custom browser screen height to perform an audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored; **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`minimum value, in pixels: `240` maximum value, in pixels: `9999` */
     browser_screen_height?: number | undefined;
-    /** browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value: 0.5 maximum value: 3 */
+    /** *browser screen scale factor* optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored; **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`minimum value: `0.5` maximum value: `3` */
     browser_screen_scale_factor?: number | undefined;
-    /** respect sitemap when crawling optional field set to true if you want to follow the order of pages indicated in the primary sitemap when crawling; default value: false Note: if set to true, the click_depth value in the API response will equal 0; the max_crawl_depth field of the request will be ignored, you can specify the number of pages to crawl using the max_crawl_pages parameter */
+    /** *respect sitemap when crawling* optional field set to `true` if you want to follow the order of pages indicated in the primary sitemap when crawling; default value: `false` **Note:** if set to `true`, the `click_depth` value in the API response will equal `0`; the `max_crawl_depth` field of the request will be ignored, you can specify the number of pages to crawl using the `max_crawl_pages` parameter */
     respect_sitemap?: boolean | undefined;
-    /** custom sitemap url optional field the URL of the page where the alternative sitemap is located Note: if you want to use this parameter, respect_sitemap should be true */
+    /** *custom sitemap url* optional field the URL of the page where the alternative sitemap is located **Note:** if you want to use this parameter, `respect_sitemap` should be `true` */
     custom_sitemap?: string | undefined;
-    /** crawl only pages indicated in the sitemap optional field set to true if you want to crawl only the pages indicated in the sitemap if you set this parameter to true and do not specify custom_sitemap, we will crawl the default sitemap default value: false Note: if you want to use this parameter, respect_sitemap should be true */
+    /** *crawl only pages indicated in the sitemap* optional field set to `true` if you want to crawl only the pages indicated in the sitemap if you set this parameter to `true` and do not specify `custom_sitemap`, we will crawl the default sitemap default value: `false` **Note:** if you want to use this parameter, `respect_sitemap` should be `true` */
     crawl_sitemap_only?: boolean | undefined;
-    /** load resources optional field set to true if you want to load image, stylesheets, scripts, and broken resources default value: false Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *load resources* optional field set to `true` if you want to load image, stylesheets, scripts, and broken resources default value: `false` **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     load_resources?: boolean | undefined;
-    /** check if the domain implemented the www redirection optional field set to true if you want to check if the requested domain implemented the www to non-www or non-www to www redirect; default value: false */
+    /** *check if the domain implemented the www redirection* optional field set to `true` if you want to check if the requested domain implemented the www to non-www or non-www to www redirect; default value: `false` */
     enable_www_redirect_check?: boolean | undefined;
-    /** load javascript on a page optional field set to true if you want to load the scripts available on a page default value: false Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *load javascript on a page* optional field set to `true` if you want to load the scripts available on a page default value: `false` **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     enable_javascript?: boolean | undefined;
-    /** enable XMLHttpRequest on a page optional field set to true if you want our crawler to request data from a web server using the XMLHttpRequest object default value: false;if you use this field, enable_javascript must be set to true; */
+    /** *enable XMLHttpRequest on a page* optional field set to `true` if you want our crawler to request data from a web server using the XMLHttpRequest object default value: `false`;if you use this field, `enable_javascript` must be set to `true`; */
     enable_xhr?: boolean | undefined;
-    /** emulate browser rendering to measure Core Web Vitals optional field by using this parameter you will be able to emulate a browser when loading a web page; enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page; default value: false set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; if you use this field, enable_javascript, and load_resources parameters must be set to true Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *emulate browser rendering to measure Core Web Vitals* optional field by using this parameter you will be able to emulate a browser when loading a web page; `enable_browser_rendering` loads styles, images, fonts, animations, videos, and other resources on a page; default value: `false` set to `true` to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; **if you use this field, `enable_javascript`, and `load_resources` parameters must be set to `true`** **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     enable_browser_rendering?: boolean | undefined;
-    /** disable the cookie popup optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false */
+    /** *disable the cookie popup* optional field set to `true` if you want to disable the popup requesting cookie consent from the user; default value: `false` */
     disable_cookie_popup?: boolean | undefined;
-    /** custom javascript optional field Note that the execution time for the script you enter here should be 700 ms maximum, for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a scr attribute: let meta = { haveGoogleAnalytics: false, haveTagManager: false };\r\nfor (var i = 0; i = 0)\r\n      meta.haveGoogleAnalytics = true;\r\n\tif (src.indexOf(\'gtm.js\') >= 0)\r\n      meta.haveTagManager = true;\r\n  }\r\n}\r\nmeta;the returned value depends on what you specified in this field. For instance, if you specify the following script: meta = {}; meta.url = document.URL; meta.test = 'test'; meta; as a response you will receive the following data: 'custom_js_response': { 'url': 'https://dataforseo.com/', 'test': 'test' } Note: the length of the script you enter must be no more than 2000 characters */
+    /** *custom javascript* optional field **Note** that the execution time for the script you enter here should be 700 ms maximum, for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a `scr` attribute: `let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i = 0)rn      meta.haveGoogleAnalytics = true;rntif (src.indexOf('gtm.js') >= 0)rn      meta.haveTagManager = true;rn  }rn}rnmeta;`the returned value depends on what you specified in this field. For instance, if you specify the following script: `meta = {}; meta.url = document.URL; meta.test = 'test'; meta;` as a response you will receive the following data: `'custom_js_response': { 'url': 'https://dataforseo.com/', 'test': 'test' }` **Note:** the length of the script you enter must be no more than 2000 characters */
     custom_js?: string | undefined;
-    /** enable microdata validation optional field set to true if you want to use the OnPage API Microdata endpoint default value: false */
+    /** *enable microdata validation* optional field set to `true` if you want to use the [OnPage API Microdata endpoint](/v3/on_page/microdata/) default value: `false` */
     validate_micromarkup?: boolean | undefined;
-    /** include pages on subdomains optional field set to true if you want to crawl all subdomains of a target website default value: false */
+    /** *include pages on subdomains* optional field set to `true` if you want to crawl all subdomains of a target website default value: `false` */
     allow_subdomains?: boolean | undefined;
-    /** subdomains to crawl optional field specify subdomains that you want to crawl example: ['blog.site.com', 'my.site.com', 'shop.site.com'] Note: to use this parameter, the allow_subdomains parameter should be set to false; otherwise, the content of allowed_subdomains field will be ignored and the results will be returned for all subdomains */
+    /** *subdomains to crawl* optional field specify subdomains that you want to crawl example: `['blog.site.com', 'my.site.com', 'shop.site.com']` **Note:** to use this parameter, the `allow_subdomains` parameter should be set to `false`; otherwise, the content of `allowed_subdomains` field will be ignored and the results will be returned for all subdomains */
     allowed_subdomains?: string[] | undefined;
-    /** subdomains not to crawl optional field specify subdomains that you don’t want to crawl example: ['status.site.com', 'docs.site.com'] Note: to use this parameter, the allow_subdomains parameter should be set to true */
+    /** *subdomains not to crawl* optional field specify subdomains that you don't want to crawl example: `['status.site.com', 'docs.site.com']` **Note:** to use this parameter, the `allow_subdomains` parameter should be set to `true` */
     disallowed_subdomains?: string[] | undefined;
-    /** check spelling optional field set to true to check spelling on a website using Hunspell library default value: false */
+    /** *check spelling* optional field set to `true` to check spelling on a website using [Hunspell](http://hunspell.github.io/) library default value: `false` */
     check_spell?: boolean | undefined;
-    /** language of the spell check optional field supported languages: ‘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’ Note: if no language is specified, it will be set automatically based on page content */
+    /** *language of the spell check* optional field supported languages: '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' **Note:** if no language is specified, it will be set automatically based on page content */
     check_spell_language?: string | undefined;
-    /** words excluded from spell check optional field specify the words that you want to exclude from spell check maximum word length: 100 characters maximum amount of words: 1000 example: 'SERP', 'minifiers', 'JavaScript' */
+    /** *words excluded from spell check* optional field specify the words that you want to exclude from spell check maximum word length: 100 characters maximum amount of words: 1000 example: `'SERP', 'minifiers', 'JavaScript'` */
     check_spell_exceptions?: string[] | undefined;
-    /** calculate keyword density for the target domain optional field set to true if you want to calculate keyword density for website pages default value: false Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article once the crawl is completed, you can obtain keyword density values with the Keyword Density endpoint */
+    /** *calculate keyword density for the target domain* optional field set to `true` if you want to calculate keyword density for website pages default value: `false` **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters) once the crawl is completed, you can obtain keyword density values with [the Keyword Density endpoint](/v3/on_page/keyword_density?bash) */
     calculate_keyword_density?: boolean | undefined;
-    /** custom threshold values for checks optional field you can specify custom threshold values for the parameters included in the checks object of OnPage API responses; Note: only integer threshold values can be modified; for example, the high_loading_time and large_page_size parameters are set to 3 seconds and 1 megabyte respectively by default; if you want to change these thresholds to 1 second and 1000 kbytes, use the following snippet: 'checks_threshold': { 'high_loading_time': 1, 'large_page_size': 1000 }available customizable parameters with default values: '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' */
+    /** *custom threshold values for checks* optional field you can specify custom threshold values for the parameters included in the `checks` object of OnPage API responses; **Note:** only integer threshold values can be modified; for example, the `high_loading_time` and `large_page_size` parameters are set to 3 seconds and 1 megabyte respectively by default; if you want to change these thresholds to 1 second and 1000 kbytes, use the following snippet: `'checks_threshold': { 'high_loading_time': 1, 'large_page_size': 1000 }` available customizable parameters with default values: `'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'` */
     checks_threshold?: {
         [key: string]: number;
     } | undefined;
-    /** prevent certain sitewide checks from running optional field specify the following checks to prevent them from running on the target website: 'test_page_not_found' 'test_canonicalization' 'test_https_redirect' 'test_directory_browsing'example: 'disable_sitewide_checks': ['test_directory_browsing', 'test_page_not_found']learn more on our help center */
+    /** *prevent certain sitewide checks from running* optional field specify the following `checks` to prevent them from running on the `target` website: `'test_page_not_found'` `'test_canonicalization'` `'test_https_redirect'` `'test_directory_browsing'`example: `'disable_sitewide_checks': ['test_directory_browsing', 'test_page_not_found']`learn more on [our help center](https://dataforseo.com/help-center/how-to-disable-sitewide-checks-in-onpage-api) */
     disable_sitewide_checks?: string[] | undefined;
-    /** prevent certain page checks from running optional field specify certain checks to prevent them from running and impacting the onpage_scoreexample: 'disable_page_checks': ['is_5xx_code', 'is_4xx_code'] */
+    /** *prevent certain page checks from running* optional field specify certain `checks` to prevent them from running and impacting the `onpage_score`example: `'disable_page_checks': ['is_5xx_code', 'is_4xx_code']` */
     disable_page_checks?: string[] | undefined;
-    /** switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors */
+    /** *switch proxy pool* optional field if `true`, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional `rate-limit` and/or `site_unreachable` errors */
     switch_pool?: boolean | undefined;
-    /** return data on pages despite the timeout error optional field if true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error; default value: false */
+    /** *return data on pages despite the timeout error* optional field if `true`, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error; default value: `false` */
     return_despite_timeout?: boolean | undefined;
-    /** 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 */
+    /** *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 */
     tag?: string | undefined;
-    /** notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
+    /** *notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
     pingback_url?: string | undefined;
     [key: string]: any;
 }
 export declare class OnPageTaskPostRequestInfo implements IOnPageTaskPostRequestInfo {
-    /** target domain required field domain name should be specified without https:// and www. if you specify the page URL, the results will be returned for the domain included in the URL */
+    /** *target domain* **required field** domain name should be specified without `https://` and `www.` if you specify the page URL, the results will be returned for the domain included in the URL */
     target?: string | undefined;
-    /** crawled pages limit required field the number of pages to crawl on the specified domain Note: if you set max_crawl_pages to 1 and do not specify start_url or set a homepage in it, the following sitewide checks will be disabled: test_canonicalization, enable_www_redirect_check, test_hidden_server_signature, test_page_not_found, test_directory_browsing, test_https_redirect to enable them anyway, set force_sitewide_checks to trueif you set max_crawl_pages to 1 and specify start_url other than a homepage, all sitewide checks will be disabled; to enable them anyway, set force_sitewide_checks to true */
+    /** *crawled pages limit* **required field** the number of pages to crawl on the specified domain **Note:** if you set `max_crawl_pages` to 1 and do not specify `start_url` or set a homepage in it, the following sitewide checks will be disabled: `test_canonicalization`, `enable_www_redirect_check`, `test_hidden_server_signature`, `test_page_not_found`, `test_directory_browsing`, `test_https_redirect` to enable them anyway, set `force_sitewide_checks` to `true`if you set `max_crawl_pages` to 1 and specify `start_url` other than a homepage, all sitewide checks will be disabled; to enable them anyway, set `force_sitewide_checks` to `true` */
     max_crawl_pages?: number | undefined;
-    /** the first url to crawl  optional field Note: you should specify an absolute URL if you want to crawl a single page, specify its URL in this field and additionally set the max_crawl_pages parameter to 1 you can also use the live Instant Pages endpoint to get page-specific data */
+    /** *the first url to crawl* optional field **Note:** you should specify an absolute URL if you want to crawl a single page, specify its URL in this field and additionally set the `max_crawl_pages` parameter to `1` you can also use the [live Instant Pages endpoint](/v3/on_page/instant_pages/?bash) to get page-specific data */
     start_url?: string | undefined;
-    /** enable sitewide checks when crawling a single page optional field set to true to get data on sitewide checks when crawling a single page; default value: false */
+    /** *enable sitewide checks when crawling a single page* optional field set to `true` to get data on sitewide checks when crawling a single page; default value: `false` */
     force_sitewide_checks?: boolean | undefined;
-    /** urls to be crawled bypassing the queue optional field URLs specified in this array will be crawled in the first instance, bypassing the crawling queue; Note: you should specify the absolute URL; you can specify up to 20 URLs; all URLs in the array must belong to the target domain; subdomains will be ignored unless the allow_subdomains parameter is set to trueexample: 'priority_urls': [ 'https://dataforseo.com/apis/serp-api', 'https://dataforseo.com/contact' ] */
+    /** *urls to be crawled bypassing the queue* optional field URLs specified in this array will be crawled in the first instance, bypassing the crawling queue; **Note:** you should specify the absolute URL; you can specify up to **20 URLs**; all URLs in the array must belong to the `target` domain; subdomains will be ignored unless the `allow_subdomains` parameter is set to `true`example: `'priority_urls': [ 'https://dataforseo.com/apis/serp-api', 'https://dataforseo.com/contact' ]` */
     priority_urls?: string[] | undefined;
-    /** crawl depth optional field the linking depth of the pages to crawl; for example, starting page of the crawl is level 0, pages that have links from that page are level 1, etc. */
+    /** *crawl depth* optional field the linking depth of the pages to crawl; for example, starting page of the crawl is level 0, pages that have links from that page are level 1, etc. */
     max_crawl_depth?: number | undefined;
-    /** delay between hits, ms optional field the custom delay between crawler hits to the server default value: 2000 */
+    /** *delay between hits, ms* optional field the custom delay between crawler hits to the server default value: `2000` */
     crawl_delay?: number | undefined;
-    /** store HTML of crawled pages optional field set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint default value: false */
+    /** *store HTML of crawled pages* optional field set to `true` if you want to get the HTML of the page using the [OnPage Raw HTML endpoint](/v3/on_page/raw_html/) default value: `false` */
     store_raw_html?: boolean | undefined;
-    /** parse content on crawled pages optional field set to true to use the OnPage Content Parsing endpoint default value: false */
+    /** *parse content on crawled pages* optional field set to `true` to use the [OnPage Content Parsing endpoint](/v3/on_page/content_parsing/live/) default value: `false` */
     enable_content_parsing?: boolean | undefined;
-    /** support cookies on crawled pages optional field set to true to support cookies when crawling the pages default value: false */
+    /** *support cookies on crawled pages* optional field set to `true` to support cookies when crawling the pages default value: `false` */
     support_cookies?: boolean | undefined;
-    /** language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the 'type':'broken in the response array */
+    /** *language header for accessing the website* optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) **Note:** if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the `'type':'broken` in the response array */
     accept_language?: string | undefined;
-    /** custom robots.txt settings optional field example: Disallow: /directory1/ */
+    /** *custom robots.txt settings* optional field example: `Disallow: /directory1/` */
     custom_robots_txt?: string | undefined;
-    /** merge with or override robots.txt settings optional field possible values: merge, override; set to override if you want to ignore website crawling restrictions and other robots.txt settings default value: merge; Note: if set to override, specify the custom_robots_txt parameter */
+    /** *merge with or override robots.txt settings* optional field possible values: `merge`, `override`; set to `override` if you want to ignore website crawling restrictions and other robots.txt settings default value: `merge`; **Note:** if set to `override`, specify the `custom_robots_txt` parameter */
     robots_txt_merge_mode?: string | undefined;
-    /** custom user agent optional field custom user agent for crawling a website example: 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 default value: Mozilla/5.0 (compatible; RSiteAuditor) */
+    /** *custom user agent* optional field custom user agent for crawling a website example: `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` default value: `Mozilla/5.0 (compatible; RSiteAuditor)` */
     custom_user_agent?: string | undefined;
-    /** preset for browser screen parameters optional field if you use this field, you don’t need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values: desktop, mobile, tabletdesktop preset will apply the following values:browser_screen_width: 1920 browser_screen_height: 1080 browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390 browser_screen_height: 844 browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024 browser_screen_height: 1366 browser_screen_scale_factor: 2 Note: to use this parameter, set enable_javascript or enable_browser_rendering to true */
+    /** *preset for browser screen parameters* optional field if you use this field, you don't need to indicate `browser_screen_width`, `browser_screen_height`, `browser_screen_scale_factor`possible values: `desktop`, `mobile`, `tablet``desktop` preset will apply the following values:`browser_screen_width: 1920` `browser_screen_height: 1080` `browser_screen_scale_factor: 1``mobile` preset will apply the following values:`browser_screen_width: 390` `browser_screen_height: 844` `browser_screen_scale_factor: 3``tablet` preset will apply the following values:`browser_screen_width: 1024` `browser_screen_height: 1366` `browser_screen_scale_factor: 2` **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true` */
     browser_preset?: string | undefined;
-    /** browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240 maximum value, in pixels: 9999 */
+    /** *browser screen width* optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored; **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`minimum value, in pixels: `240` maximum value, in pixels: `9999` */
     browser_screen_width?: number | undefined;
-    /** browser screen height optional field you can set a custom browser screen height to perform an audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240 maximum value, in pixels: 9999 */
+    /** *browser screen height* optional field you can set a custom browser screen height to perform an audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored; **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`minimum value, in pixels: `240` maximum value, in pixels: `9999` */
     browser_screen_height?: number | undefined;
-    /** browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value: 0.5 maximum value: 3 */
+    /** *browser screen scale factor* optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored; **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`minimum value: `0.5` maximum value: `3` */
     browser_screen_scale_factor?: number | undefined;
-    /** respect sitemap when crawling optional field set to true if you want to follow the order of pages indicated in the primary sitemap when crawling; default value: false Note: if set to true, the click_depth value in the API response will equal 0; the max_crawl_depth field of the request will be ignored, you can specify the number of pages to crawl using the max_crawl_pages parameter */
+    /** *respect sitemap when crawling* optional field set to `true` if you want to follow the order of pages indicated in the primary sitemap when crawling; default value: `false` **Note:** if set to `true`, the `click_depth` value in the API response will equal `0`; the `max_crawl_depth` field of the request will be ignored, you can specify the number of pages to crawl using the `max_crawl_pages` parameter */
     respect_sitemap?: boolean | undefined;
-    /** custom sitemap url optional field the URL of the page where the alternative sitemap is located Note: if you want to use this parameter, respect_sitemap should be true */
+    /** *custom sitemap url* optional field the URL of the page where the alternative sitemap is located **Note:** if you want to use this parameter, `respect_sitemap` should be `true` */
     custom_sitemap?: string | undefined;
-    /** crawl only pages indicated in the sitemap optional field set to true if you want to crawl only the pages indicated in the sitemap if you set this parameter to true and do not specify custom_sitemap, we will crawl the default sitemap default value: false Note: if you want to use this parameter, respect_sitemap should be true */
+    /** *crawl only pages indicated in the sitemap* optional field set to `true` if you want to crawl only the pages indicated in the sitemap if you set this parameter to `true` and do not specify `custom_sitemap`, we will crawl the default sitemap default value: `false` **Note:** if you want to use this parameter, `respect_sitemap` should be `true` */
     crawl_sitemap_only?: boolean | undefined;
-    /** load resources optional field set to true if you want to load image, stylesheets, scripts, and broken resources default value: false Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *load resources* optional field set to `true` if you want to load image, stylesheets, scripts, and broken resources default value: `false` **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     load_resources?: boolean | undefined;
-    /** check if the domain implemented the www redirection optional field set to true if you want to check if the requested domain implemented the www to non-www or non-www to www redirect; default value: false */
+    /** *check if the domain implemented the www redirection* optional field set to `true` if you want to check if the requested domain implemented the www to non-www or non-www to www redirect; default value: `false` */
     enable_www_redirect_check?: boolean | undefined;
-    /** load javascript on a page optional field set to true if you want to load the scripts available on a page default value: false Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *load javascript on a page* optional field set to `true` if you want to load the scripts available on a page default value: `false` **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     enable_javascript?: boolean | undefined;
-    /** enable XMLHttpRequest on a page optional field set to true if you want our crawler to request data from a web server using the XMLHttpRequest object default value: false;if you use this field, enable_javascript must be set to true; */
+    /** *enable XMLHttpRequest on a page* optional field set to `true` if you want our crawler to request data from a web server using the XMLHttpRequest object default value: `false`;if you use this field, `enable_javascript` must be set to `true`; */
     enable_xhr?: boolean | undefined;
-    /** emulate browser rendering to measure Core Web Vitals optional field by using this parameter you will be able to emulate a browser when loading a web page; enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page; default value: false set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; if you use this field, enable_javascript, and load_resources parameters must be set to true Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *emulate browser rendering to measure Core Web Vitals* optional field by using this parameter you will be able to emulate a browser when loading a web page; `enable_browser_rendering` loads styles, images, fonts, animations, videos, and other resources on a page; default value: `false` set to `true` to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; **if you use this field, `enable_javascript`, and `load_resources` parameters must be set to `true`** **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     enable_browser_rendering?: boolean | undefined;
-    /** disable the cookie popup optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false */
+    /** *disable the cookie popup* optional field set to `true` if you want to disable the popup requesting cookie consent from the user; default value: `false` */
     disable_cookie_popup?: boolean | undefined;
-    /** custom javascript optional field Note that the execution time for the script you enter here should be 700 ms maximum, for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a scr attribute: let meta = { haveGoogleAnalytics: false, haveTagManager: false };\r\nfor (var i = 0; i = 0)\r\n      meta.haveGoogleAnalytics = true;\r\n\tif (src.indexOf(\'gtm.js\') >= 0)\r\n      meta.haveTagManager = true;\r\n  }\r\n}\r\nmeta;the returned value depends on what you specified in this field. For instance, if you specify the following script: meta = {}; meta.url = document.URL; meta.test = 'test'; meta; as a response you will receive the following data: 'custom_js_response': { 'url': 'https://dataforseo.com/', 'test': 'test' } Note: the length of the script you enter must be no more than 2000 characters */
+    /** *custom javascript* optional field **Note** that the execution time for the script you enter here should be 700 ms maximum, for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a `scr` attribute: `let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i = 0)rn      meta.haveGoogleAnalytics = true;rntif (src.indexOf('gtm.js') >= 0)rn      meta.haveTagManager = true;rn  }rn}rnmeta;`the returned value depends on what you specified in this field. For instance, if you specify the following script: `meta = {}; meta.url = document.URL; meta.test = 'test'; meta;` as a response you will receive the following data: `'custom_js_response': { 'url': 'https://dataforseo.com/', 'test': 'test' }` **Note:** the length of the script you enter must be no more than 2000 characters */
     custom_js?: string | undefined;
-    /** enable microdata validation optional field set to true if you want to use the OnPage API Microdata endpoint default value: false */
+    /** *enable microdata validation* optional field set to `true` if you want to use the [OnPage API Microdata endpoint](/v3/on_page/microdata/) default value: `false` */
     validate_micromarkup?: boolean | undefined;
-    /** include pages on subdomains optional field set to true if you want to crawl all subdomains of a target website default value: false */
+    /** *include pages on subdomains* optional field set to `true` if you want to crawl all subdomains of a target website default value: `false` */
     allow_subdomains?: boolean | undefined;
-    /** subdomains to crawl optional field specify subdomains that you want to crawl example: ['blog.site.com', 'my.site.com', 'shop.site.com'] Note: to use this parameter, the allow_subdomains parameter should be set to false; otherwise, the content of allowed_subdomains field will be ignored and the results will be returned for all subdomains */
+    /** *subdomains to crawl* optional field specify subdomains that you want to crawl example: `['blog.site.com', 'my.site.com', 'shop.site.com']` **Note:** to use this parameter, the `allow_subdomains` parameter should be set to `false`; otherwise, the content of `allowed_subdomains` field will be ignored and the results will be returned for all subdomains */
     allowed_subdomains?: string[] | undefined;
-    /** subdomains not to crawl optional field specify subdomains that you don’t want to crawl example: ['status.site.com', 'docs.site.com'] Note: to use this parameter, the allow_subdomains parameter should be set to true */
+    /** *subdomains not to crawl* optional field specify subdomains that you don't want to crawl example: `['status.site.com', 'docs.site.com']` **Note:** to use this parameter, the `allow_subdomains` parameter should be set to `true` */
     disallowed_subdomains?: string[] | undefined;
-    /** check spelling optional field set to true to check spelling on a website using Hunspell library default value: false */
+    /** *check spelling* optional field set to `true` to check spelling on a website using [Hunspell](http://hunspell.github.io/) library default value: `false` */
     check_spell?: boolean | undefined;
-    /** language of the spell check optional field supported languages: ‘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’ Note: if no language is specified, it will be set automatically based on page content */
+    /** *language of the spell check* optional field supported languages: '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' **Note:** if no language is specified, it will be set automatically based on page content */
     check_spell_language?: string | undefined;
-    /** words excluded from spell check optional field specify the words that you want to exclude from spell check maximum word length: 100 characters maximum amount of words: 1000 example: 'SERP', 'minifiers', 'JavaScript' */
+    /** *words excluded from spell check* optional field specify the words that you want to exclude from spell check maximum word length: 100 characters maximum amount of words: 1000 example: `'SERP', 'minifiers', 'JavaScript'` */
     check_spell_exceptions?: string[] | undefined;
-    /** calculate keyword density for the target domain optional field set to true if you want to calculate keyword density for website pages default value: false Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article once the crawl is completed, you can obtain keyword density values with the Keyword Density endpoint */
+    /** *calculate keyword density for the target domain* optional field set to `true` if you want to calculate keyword density for website pages default value: `false` **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters) once the crawl is completed, you can obtain keyword density values with [the Keyword Density endpoint](/v3/on_page/keyword_density?bash) */
     calculate_keyword_density?: boolean | undefined;
-    /** custom threshold values for checks optional field you can specify custom threshold values for the parameters included in the checks object of OnPage API responses; Note: only integer threshold values can be modified; for example, the high_loading_time and large_page_size parameters are set to 3 seconds and 1 megabyte respectively by default; if you want to change these thresholds to 1 second and 1000 kbytes, use the following snippet: 'checks_threshold': { 'high_loading_time': 1, 'large_page_size': 1000 }available customizable parameters with default values: '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' */
+    /** *custom threshold values for checks* optional field you can specify custom threshold values for the parameters included in the `checks` object of OnPage API responses; **Note:** only integer threshold values can be modified; for example, the `high_loading_time` and `large_page_size` parameters are set to 3 seconds and 1 megabyte respectively by default; if you want to change these thresholds to 1 second and 1000 kbytes, use the following snippet: `'checks_threshold': { 'high_loading_time': 1, 'large_page_size': 1000 }` available customizable parameters with default values: `'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'` */
     checks_threshold?: {
         [key: string]: number;
     } | undefined;
-    /** prevent certain sitewide checks from running optional field specify the following checks to prevent them from running on the target website: 'test_page_not_found' 'test_canonicalization' 'test_https_redirect' 'test_directory_browsing'example: 'disable_sitewide_checks': ['test_directory_browsing', 'test_page_not_found']learn more on our help center */
+    /** *prevent certain sitewide checks from running* optional field specify the following `checks` to prevent them from running on the `target` website: `'test_page_not_found'` `'test_canonicalization'` `'test_https_redirect'` `'test_directory_browsing'`example: `'disable_sitewide_checks': ['test_directory_browsing', 'test_page_not_found']`learn more on [our help center](https://dataforseo.com/help-center/how-to-disable-sitewide-checks-in-onpage-api) */
     disable_sitewide_checks?: string[] | undefined;
-    /** prevent certain page checks from running optional field specify certain checks to prevent them from running and impacting the onpage_scoreexample: 'disable_page_checks': ['is_5xx_code', 'is_4xx_code'] */
+    /** *prevent certain page checks from running* optional field specify certain `checks` to prevent them from running and impacting the `onpage_score`example: `'disable_page_checks': ['is_5xx_code', 'is_4xx_code']` */
     disable_page_checks?: string[] | undefined;
-    /** switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors */
+    /** *switch proxy pool* optional field if `true`, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional `rate-limit` and/or `site_unreachable` errors */
     switch_pool?: boolean | undefined;
-    /** return data on pages despite the timeout error optional field if true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error; default value: false */
+    /** *return data on pages despite the timeout error* optional field if `true`, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error; default value: `false` */
     return_despite_timeout?: boolean | undefined;
-    /** 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 */
+    /** *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 */
     tag?: string | undefined;
-    /** notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
+    /** *notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
     pingback_url?: string | undefined;
     [key: string]: any;
     constructor(data?: IOnPageTaskPostRequestInfo);

package/dist/esm/models/OnPageTaskPostResponseInfo.d.ts

@@ -1,12 +1,12 @@
 import { OnPageTaskPostTaskInfo } from "./OnPageTaskPostTaskInfo";
 import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
 export interface IOnPageTaskPostResponseInfo extends IBaseResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: OnPageTaskPostTaskInfo[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageTaskPostResponseInfo extends BaseResponseInfo implements IOnPageTaskPostResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: OnPageTaskPostTaskInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageTaskPostResponseInfo);

package/dist/esm/models/OnPageTaskPostTaskInfo.d.ts

@@ -1,11 +1,11 @@
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface IOnPageTaskPostTaskInfo extends IBaseResponseTaskInfo {
-    /** array of results in this case, the value will be null */
+    /** *array of results* in this case, the value will be `null` */
     result?: any | undefined;
     [key: string]: any;
 }
 export declare class OnPageTaskPostTaskInfo extends BaseResponseTaskInfo implements IOnPageTaskPostTaskInfo {
-    /** array of results in this case, the value will be null */
+    /** *array of results* in this case, the value will be `null` */
     result?: any | undefined;
     [key: string]: any;
     constructor(data?: IOnPageTaskPostTaskInfo);

package/dist/esm/models/OnPageWaterfallItem.d.ts

@@ -1,55 +1,55 @@
 import { WaterfallResourceInfo } from "./WaterfallResourceInfo";
 export interface IOnPageWaterfallItem {
-    /** URL of the page */
+    /** *URL of the page* */
     page_url?: string | undefined;
-    /** Time To Interactive (TTI) metric the time it takes until the user can interact with a page (in milliseconds) */
+    /** *[Time To Interactive (TTI)](https://web.dev/interactive/) metric* the time it takes until the user can interact with a page (in milliseconds) */
     time_to_interactive?: number | undefined;
-    /** time to load resources the time it takes until the page and all of its subresources are downloaded (in milliseconds) */
+    /** *time to load resources* the time it takes until the page and all of its subresources are downloaded (in milliseconds) */
     dom_complete?: number | undefined;
-    /** time to connect to a server the time it takes until the connection with a server is established (in milliseconds) */
+    /** *time to connect to a server* the time it takes until the connection with a server is established (in milliseconds) */
     connection_time?: number | undefined;
-    /** time to establish a secure connection the time it takes until the secure connection with a server is established (in milliseconds) */
+    /** *time to establish a secure connection* the time it takes until the secure connection with a server is established (in milliseconds) */
     time_to_secure_connection?: number | undefined;
-    /** time to send a request to a server the time it takes until the request to a server is sent (in milliseconds) */
+    /** *time to send a request to a server* the time it takes until the request to a server is sent (in milliseconds) */
     request_sent_time?: number | undefined;
-    /** time to first byte (TTFB) in milliseconds */
+    /** *time to first byte [(TTFB)](https://en.wikipedia.org/wiki/Time_to_first_byte) in milliseconds* */
     waiting_time?: number | undefined;
-    /** time it takes for a browser to receive a response (in milliseconds) */
+    /** *time it takes for a browser to receive a response (in milliseconds)* */
     download_time?: number | undefined;
-    /** total time it takes until a browser receives a complete response from a server (in milliseconds) */
+    /** *total time it takes until a browser receives a complete response from a server (in milliseconds)* */
     duration_time?: number | undefined;
-    /** time to start downloading the HTML resource the amount of time the browser needs to start downloading a page */
+    /** *time to start downloading the HTML resource* the amount of time the browser needs to start downloading a page */
     fetch_start?: number | undefined;
-    /** time to complete downloading the HTML resource the amount of time the browser needs to complete downloading a page */
+    /** *time to complete downloading the HTML resource* the amount of time the browser needs to complete downloading a page */
     fetch_end?: number | undefined;
-    /** resource-specific timing contains separate arrays with timing for each resource found on the page */
+    /** *resource-specific timing* contains separate arrays with timing for each resource found on the page */
     resources?: WaterfallResourceInfo[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageWaterfallItem implements IOnPageWaterfallItem {
-    /** URL of the page */
+    /** *URL of the page* */
     page_url?: string | undefined;
-    /** Time To Interactive (TTI) metric the time it takes until the user can interact with a page (in milliseconds) */
+    /** *[Time To Interactive (TTI)](https://web.dev/interactive/) metric* the time it takes until the user can interact with a page (in milliseconds) */
     time_to_interactive?: number | undefined;
-    /** time to load resources the time it takes until the page and all of its subresources are downloaded (in milliseconds) */
+    /** *time to load resources* the time it takes until the page and all of its subresources are downloaded (in milliseconds) */
     dom_complete?: number | undefined;
-    /** time to connect to a server the time it takes until the connection with a server is established (in milliseconds) */
+    /** *time to connect to a server* the time it takes until the connection with a server is established (in milliseconds) */
     connection_time?: number | undefined;
-    /** time to establish a secure connection the time it takes until the secure connection with a server is established (in milliseconds) */
+    /** *time to establish a secure connection* the time it takes until the secure connection with a server is established (in milliseconds) */
     time_to_secure_connection?: number | undefined;
-    /** time to send a request to a server the time it takes until the request to a server is sent (in milliseconds) */
+    /** *time to send a request to a server* the time it takes until the request to a server is sent (in milliseconds) */
     request_sent_time?: number | undefined;
-    /** time to first byte (TTFB) in milliseconds */
+    /** *time to first byte [(TTFB)](https://en.wikipedia.org/wiki/Time_to_first_byte) in milliseconds* */
     waiting_time?: number | undefined;
-    /** time it takes for a browser to receive a response (in milliseconds) */
+    /** *time it takes for a browser to receive a response (in milliseconds)* */
     download_time?: number | undefined;
-    /** total time it takes until a browser receives a complete response from a server (in milliseconds) */
+    /** *total time it takes until a browser receives a complete response from a server (in milliseconds)* */
     duration_time?: number | undefined;
-    /** time to start downloading the HTML resource the amount of time the browser needs to start downloading a page */
+    /** *time to start downloading the HTML resource* the amount of time the browser needs to start downloading a page */
     fetch_start?: number | undefined;
-    /** time to complete downloading the HTML resource the amount of time the browser needs to complete downloading a page */
+    /** *time to complete downloading the HTML resource* the amount of time the browser needs to complete downloading a page */
     fetch_end?: number | undefined;
-    /** resource-specific timing contains separate arrays with timing for each resource found on the page */
+    /** *resource-specific timing* contains separate arrays with timing for each resource found on the page */
     resources?: WaterfallResourceInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageWaterfallItem);

package/dist/esm/models/OnPageWaterfallRequestInfo.d.ts

@@ -1,18 +1,18 @@
 export interface IOnPageWaterfallRequestInfo {
-    /** ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” */
+    /** *ID of the task* **required field** you can get this ID in the response of the [Task POST](/v3/on_page/task_post/) endpoint example: '07131248-1535-0216-1000-17384017ad04' */
     id?: string | undefined;
-    /** page URL required field specify the pages you want to receive timing for */
+    /** *page URL* **required field** specify the pages you want to receive timing for */
     url?: string | undefined;
-    /** 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 */
+    /** *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 */
     tag?: string | undefined;
     [key: string]: any;
 }
 export declare class OnPageWaterfallRequestInfo implements IOnPageWaterfallRequestInfo {
-    /** ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” */
+    /** *ID of the task* **required field** you can get this ID in the response of the [Task POST](/v3/on_page/task_post/) endpoint example: '07131248-1535-0216-1000-17384017ad04' */
     id?: string | undefined;
-    /** page URL required field specify the pages you want to receive timing for */
+    /** *page URL* **required field** specify the pages you want to receive timing for */
     url?: string | undefined;
-    /** 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 */
+    /** *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 */
     tag?: string | undefined;
     [key: string]: any;
     constructor(data?: IOnPageWaterfallRequestInfo);

package/dist/esm/models/OnPageWaterfallResponseInfo.d.ts

@@ -1,12 +1,12 @@
 import { OnPageWaterfallTaskInfo } from "./OnPageWaterfallTaskInfo";
 import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
 export interface IOnPageWaterfallResponseInfo extends IBaseResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: OnPageWaterfallTaskInfo[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageWaterfallResponseInfo extends BaseResponseInfo implements IOnPageWaterfallResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: OnPageWaterfallTaskInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageWaterfallResponseInfo);