dataforseo-client 2.1.5 → 2.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/dist/cjs/api/AiOptimizationApi.js +54 -54
  2. package/dist/cjs/api/AppDataApi.js +42 -42
  3. package/dist/cjs/api/AppendixApi.js +4 -4
  4. package/dist/cjs/api/BacklinksApi.js +24 -24
  5. package/dist/cjs/api/BusinessDataApi.js +54 -54
  6. package/dist/cjs/api/ContentAnalysisApi.js +11 -11
  7. package/dist/cjs/api/DataforseoLabsApi.js +47 -47
  8. package/dist/cjs/api/DomainAnalyticsApi.js +14 -14
  9. package/dist/cjs/api/KeywordsDataApi.js +70 -70
  10. package/dist/cjs/api/MerchantApi.js +38 -38
  11. package/dist/cjs/api/OnPageApi.js +31 -31
  12. package/dist/cjs/api/SerpApi.js +181 -181
  13. package/dist/cjs/index.d.ts +17 -18
  14. package/dist/cjs/index.js +181 -183
  15. package/dist/cjs/index.js.map +1 -1
  16. package/dist/cjs/models/AiOptimizationChatGptLlmScraperTasksReadyTaskInfo.d.ts +2 -3
  17. package/dist/cjs/models/AiOptimizationChatGptLlmScraperTasksReadyTaskInfo.js +2 -16
  18. package/dist/cjs/models/AiOptimizationChatGptLlmScraperTasksReadyTaskInfo.js.map +1 -1
  19. package/dist/cjs/models/AnalysisContentInfo.d.ts +3 -3
  20. package/dist/cjs/models/AnalysisContentInfo.js +3 -3
  21. package/dist/cjs/models/AnalysisContentInfo.js.map +1 -1
  22. package/dist/cjs/models/BaseDataforseoLabsApiElementItem.d.ts +173 -173
  23. package/dist/cjs/models/BaseDataforseoLabsApiElementItem.js +146 -146
  24. package/dist/cjs/models/BaseDataforseoLabsApiElementItem.js.map +1 -1
  25. package/dist/cjs/models/BaseOnPageResourceItem.d.ts +82 -82
  26. package/dist/cjs/models/BusinessDataIdListResultInfo.d.ts +6 -2
  27. package/dist/cjs/models/CacheControl.d.ts +4 -4
  28. package/dist/cjs/models/ContentAnalysisSearchLiveItem.d.ts +3 -3
  29. package/dist/cjs/models/ContentAnalysisSearchLiveItem.js +2 -2
  30. package/dist/cjs/models/ContentAnalysisSearchLiveItem.js.map +1 -1
  31. package/dist/cjs/models/ContentCommentInfo.d.ts +3 -3
  32. package/dist/cjs/models/ContentCommentInfo.js +3 -3
  33. package/dist/cjs/models/ContentCommentInfo.js.map +1 -1
  34. package/dist/cjs/models/ContententRatingInfo.d.ts +30 -0
  35. package/dist/cjs/models/ContententRatingInfo.js +43 -0
  36. package/dist/cjs/models/ContententRatingInfo.js.map +1 -0
  37. package/dist/cjs/models/FetchTiming.d.ts +6 -6
  38. package/dist/cjs/models/HtmlContentInfo.d.ts +20 -20
  39. package/dist/cjs/models/HunspellInfo.d.ts +4 -4
  40. package/dist/cjs/models/HunspellMisspelledInfo.d.ts +2 -2
  41. package/dist/cjs/models/LastModified.d.ts +6 -6
  42. package/dist/cjs/models/OnPageInstantPagesRequestInfo.d.ts +42 -38
  43. package/dist/cjs/models/OnPageInstantPagesRequestInfo.js +2 -0
  44. package/dist/cjs/models/OnPageInstantPagesRequestInfo.js.map +1 -1
  45. package/dist/cjs/models/OnPageInstantPagesResponseInfo.d.ts +2 -2
  46. package/dist/cjs/models/OnPageInstantPagesResultInfo.d.ts +10 -10
  47. package/dist/cjs/models/OnPageInstantPagesTaskInfo.d.ts +2 -2
  48. package/dist/cjs/models/OnPageLighthouseTaskGetJsonTaskInfo.d.ts +2 -0
  49. package/dist/cjs/models/OnPageLighthouseTaskGetJsonTaskInfo.js.map +1 -1
  50. package/dist/cjs/models/OnPagePagesRequestInfo.d.ts +14 -14
  51. package/dist/cjs/models/OnPagePagesResponseInfo.d.ts +2 -2
  52. package/dist/cjs/models/OnPagePagesResultInfo.d.ts +10 -10
  53. package/dist/cjs/models/OnPagePagesTaskInfo.d.ts +2 -2
  54. package/dist/cjs/models/OnPageResourceIssueInfo.d.ts +4 -4
  55. package/dist/cjs/models/OnPageResourceIssueItemInfo.d.ts +8 -8
  56. package/dist/cjs/models/PageContentInfo.d.ts +3 -3
  57. package/dist/cjs/models/PageContentInfo.js +2 -2
  58. package/dist/cjs/models/PageContentInfo.js.map +1 -1
  59. package/dist/cjs/models/PageMetaInfo.d.ts +58 -58
  60. package/dist/cjs/models/PageTiming.d.ts +24 -24
  61. package/dist/cjs/models/SerpGoogleEventsTaskGetAdvancedResultInfo.d.ts +2 -2
  62. package/dist/cjs/models/index.d.ts +17 -18
  63. package/dist/cjs/models/index.js +179 -181
  64. package/dist/cjs/models/index.js.map +1 -1
  65. package/dist/esm/api/AiOptimizationApi.js +54 -54
  66. package/dist/esm/api/AppDataApi.js +42 -42
  67. package/dist/esm/api/AppendixApi.js +4 -4
  68. package/dist/esm/api/BacklinksApi.js +24 -24
  69. package/dist/esm/api/BusinessDataApi.js +54 -54
  70. package/dist/esm/api/ContentAnalysisApi.js +11 -11
  71. package/dist/esm/api/DataforseoLabsApi.js +47 -47
  72. package/dist/esm/api/DomainAnalyticsApi.js +14 -14
  73. package/dist/esm/api/KeywordsDataApi.js +70 -70
  74. package/dist/esm/api/MerchantApi.js +38 -38
  75. package/dist/esm/api/OnPageApi.js +31 -31
  76. package/dist/esm/api/SerpApi.js +181 -181
  77. package/dist/esm/index.d.ts +17 -18
  78. package/dist/esm/index.js +17 -18
  79. package/dist/esm/index.js.map +1 -1
  80. package/dist/esm/models/AiOptimizationChatGptLlmScraperTasksReadyTaskInfo.d.ts +2 -3
  81. package/dist/esm/models/AiOptimizationChatGptLlmScraperTasksReadyTaskInfo.js +2 -16
  82. package/dist/esm/models/AiOptimizationChatGptLlmScraperTasksReadyTaskInfo.js.map +1 -1
  83. package/dist/esm/models/AnalysisContentInfo.d.ts +3 -3
  84. package/dist/esm/models/AnalysisContentInfo.js +3 -3
  85. package/dist/esm/models/AnalysisContentInfo.js.map +1 -1
  86. package/dist/esm/models/BaseDataforseoLabsApiElementItem.d.ts +173 -173
  87. package/dist/esm/models/BaseDataforseoLabsApiElementItem.js +141 -141
  88. package/dist/esm/models/BaseDataforseoLabsApiElementItem.js.map +1 -1
  89. package/dist/esm/models/BaseOnPageResourceItem.d.ts +82 -82
  90. package/dist/esm/models/BusinessDataIdListResultInfo.d.ts +6 -2
  91. package/dist/esm/models/CacheControl.d.ts +4 -4
  92. package/dist/esm/models/ContentAnalysisSearchLiveItem.d.ts +3 -3
  93. package/dist/esm/models/ContentAnalysisSearchLiveItem.js +2 -2
  94. package/dist/esm/models/ContentAnalysisSearchLiveItem.js.map +1 -1
  95. package/dist/esm/models/ContentCommentInfo.d.ts +3 -3
  96. package/dist/esm/models/ContentCommentInfo.js +3 -3
  97. package/dist/esm/models/ContentCommentInfo.js.map +1 -1
  98. package/dist/esm/models/ContententRatingInfo.d.ts +30 -0
  99. package/dist/esm/models/ContententRatingInfo.js +39 -0
  100. package/dist/esm/models/ContententRatingInfo.js.map +1 -0
  101. package/dist/esm/models/FetchTiming.d.ts +6 -6
  102. package/dist/esm/models/HtmlContentInfo.d.ts +20 -20
  103. package/dist/esm/models/HunspellInfo.d.ts +4 -4
  104. package/dist/esm/models/HunspellMisspelledInfo.d.ts +2 -2
  105. package/dist/esm/models/LastModified.d.ts +6 -6
  106. package/dist/esm/models/OnPageInstantPagesRequestInfo.d.ts +42 -38
  107. package/dist/esm/models/OnPageInstantPagesRequestInfo.js +2 -0
  108. package/dist/esm/models/OnPageInstantPagesRequestInfo.js.map +1 -1
  109. package/dist/esm/models/OnPageInstantPagesResponseInfo.d.ts +2 -2
  110. package/dist/esm/models/OnPageInstantPagesResultInfo.d.ts +10 -10
  111. package/dist/esm/models/OnPageInstantPagesTaskInfo.d.ts +2 -2
  112. package/dist/esm/models/OnPageLighthouseTaskGetJsonTaskInfo.d.ts +2 -0
  113. package/dist/esm/models/OnPageLighthouseTaskGetJsonTaskInfo.js.map +1 -1
  114. package/dist/esm/models/OnPagePagesRequestInfo.d.ts +14 -14
  115. package/dist/esm/models/OnPagePagesResponseInfo.d.ts +2 -2
  116. package/dist/esm/models/OnPagePagesResultInfo.d.ts +10 -10
  117. package/dist/esm/models/OnPagePagesTaskInfo.d.ts +2 -2
  118. package/dist/esm/models/OnPageResourceIssueInfo.d.ts +4 -4
  119. package/dist/esm/models/OnPageResourceIssueItemInfo.d.ts +8 -8
  120. package/dist/esm/models/PageContentInfo.d.ts +3 -3
  121. package/dist/esm/models/PageContentInfo.js +2 -2
  122. package/dist/esm/models/PageContentInfo.js.map +1 -1
  123. package/dist/esm/models/PageMetaInfo.d.ts +58 -58
  124. package/dist/esm/models/PageTiming.d.ts +24 -24
  125. package/dist/esm/models/SerpGoogleEventsTaskGetAdvancedResultInfo.d.ts +2 -2
  126. package/dist/esm/models/index.d.ts +17 -18
  127. package/dist/esm/models/index.js +17 -18
  128. package/dist/esm/models/index.js.map +1 -1
  129. package/package.json +1 -1
@@ -1,50 +1,50 @@
1
1
  export interface IHtmlContentInfo {
2
- /** *total size of the text on the page measured in bytes* */
2
+ /** total size of the text on the page measured in bytes */
3
3
  plain_text_size?: number | undefined;
4
4
  /** plaintext rate value plain_text_size to size ratio */
5
5
  plain_text_rate?: number | undefined;
6
- /** *number of words on the page* */
6
+ /** number of words on the page */
7
7
  plain_text_word_count?: number | undefined;
8
- /** *[Automated Readability Index](https://en.wikipedia.org/wiki/Automated_readability_index)* */
8
+ /** Automated Readability Index */
9
9
  automated_readability_index?: number | undefined;
10
- /** *[Coleman–Liau Index](https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index)* */
10
+ /** Coleman–Liau Index */
11
11
  coleman_liau_readability_index?: number | undefined;
12
- /** *[Dale–Chall Readability Index](https://en.wikipedia.org/wiki/Dale%E2%80%93Chall_readability_formula)* */
12
+ /** Dale–Chall Readability Index */
13
13
  dale_chall_readability_index?: number | undefined;
14
- /** *[Flesch–Kincaid Readability Index](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests)* */
14
+ /** Flesch–Kincaid Readability Index */
15
15
  flesch_kincaid_readability_index?: number | undefined;
16
- /** *[SMOG Readability Index](https://en.wikipedia.org/wiki/SMOG)* */
16
+ /** SMOG Readability Index */
17
17
  smog_readability_index?: number | undefined;
18
- /** *consistency of the meta `description` tag with the page content* measured from 0 to 1 */
18
+ /** consistency of the meta description tag with the page contentmeasured from 0 to 1 */
19
19
  description_to_content_consistency?: number | undefined;
20
- /** *consistency of the meta `title` tag with the page content* measured from 0 to 1 */
20
+ /** consistency of the meta title tag with the page contentmeasured from 0 to 1 */
21
21
  title_to_content_consistency?: number | undefined;
22
- /** *consistency of meta `keywords`tag with the page content* measured from 0 to 1 */
22
+ /** consistency of meta keywordstag with the page contentmeasured from 0 to 1 */
23
23
  meta_keywords_to_content_consistency?: number | undefined;
24
24
  [key: string]: any;
25
25
  }
26
26
  export declare class HtmlContentInfo implements IHtmlContentInfo {
27
- /** *total size of the text on the page measured in bytes* */
27
+ /** total size of the text on the page measured in bytes */
28
28
  plain_text_size?: number | undefined;
29
29
  /** plaintext rate value plain_text_size to size ratio */
30
30
  plain_text_rate?: number | undefined;
31
- /** *number of words on the page* */
31
+ /** number of words on the page */
32
32
  plain_text_word_count?: number | undefined;
33
- /** *[Automated Readability Index](https://en.wikipedia.org/wiki/Automated_readability_index)* */
33
+ /** Automated Readability Index */
34
34
  automated_readability_index?: number | undefined;
35
- /** *[Coleman–Liau Index](https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index)* */
35
+ /** Coleman–Liau Index */
36
36
  coleman_liau_readability_index?: number | undefined;
37
- /** *[Dale–Chall Readability Index](https://en.wikipedia.org/wiki/Dale%E2%80%93Chall_readability_formula)* */
37
+ /** Dale–Chall Readability Index */
38
38
  dale_chall_readability_index?: number | undefined;
39
- /** *[Flesch–Kincaid Readability Index](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests)* */
39
+ /** Flesch–Kincaid Readability Index */
40
40
  flesch_kincaid_readability_index?: number | undefined;
41
- /** *[SMOG Readability Index](https://en.wikipedia.org/wiki/SMOG)* */
41
+ /** SMOG Readability Index */
42
42
  smog_readability_index?: number | undefined;
43
- /** *consistency of the meta `description` tag with the page content* measured from 0 to 1 */
43
+ /** consistency of the meta description tag with the page contentmeasured from 0 to 1 */
44
44
  description_to_content_consistency?: number | undefined;
45
- /** *consistency of the meta `title` tag with the page content* measured from 0 to 1 */
45
+ /** consistency of the meta title tag with the page contentmeasured from 0 to 1 */
46
46
  title_to_content_consistency?: number | undefined;
47
- /** *consistency of meta `keywords`tag with the page content* measured from 0 to 1 */
47
+ /** consistency of meta keywordstag with the page contentmeasured from 0 to 1 */
48
48
  meta_keywords_to_content_consistency?: number | undefined;
49
49
  [key: string]: any;
50
50
  constructor(data?: IHtmlContentInfo);
@@ -1,15 +1,15 @@
1
1
  import { HunspellMisspelledInfo } from "./HunspellMisspelledInfo";
2
2
  export interface IHunspellInfo {
3
- /** *spellcheck language code* */
3
+ /** spellcheck language code */
4
4
  hunspell_language_code?: string | undefined;
5
- /** *array of misspelled words* */
5
+ /** array of misspelled words */
6
6
  misspelled?: HunspellMisspelledInfo[] | undefined;
7
7
  [key: string]: any;
8
8
  }
9
9
  export declare class HunspellInfo implements IHunspellInfo {
10
- /** *spellcheck language code* */
10
+ /** spellcheck language code */
11
11
  hunspell_language_code?: string | undefined;
12
- /** *array of misspelled words* */
12
+ /** array of misspelled words */
13
13
  misspelled?: HunspellMisspelledInfo[] | undefined;
14
14
  [key: string]: any;
15
15
  constructor(data?: IHunspellInfo);
@@ -1,10 +1,10 @@
1
1
  export interface IHunspellMisspelledInfo {
2
- /** *misspelled word* */
2
+ /** misspelled word */
3
3
  word?: string | undefined;
4
4
  [key: string]: any;
5
5
  }
6
6
  export declare class HunspellMisspelledInfo implements IHunspellMisspelledInfo {
7
- /** *misspelled word* */
7
+ /** misspelled word */
8
8
  word?: string | undefined;
9
9
  [key: string]: any;
10
10
  constructor(data?: IHunspellMisspelledInfo);
@@ -1,18 +1,18 @@
1
1
  export interface ILastModified {
2
- /** *date and time when the header was last modified* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` if there is no data, the value will be `null` */
2
+ /** date and time when the header was last modifiedin the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00'example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null */
3
3
  header?: string | undefined;
4
- /** *date and time when the sitemap was last modified* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` if there is no data, the value will be `null` */
4
+ /** date and time when the sitemap was last modifiedin the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00'example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null */
5
5
  sitemap?: string | undefined;
6
- /** *date and time when the meta tag was last modified* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` if there is no data, the value will be `null` */
6
+ /** date and time when the meta tag was last modifiedin the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00'example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null */
7
7
  meta_tag?: string | undefined;
8
8
  [key: string]: any;
9
9
  }
10
10
  export declare class LastModified implements ILastModified {
11
- /** *date and time when the header was last modified* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` if there is no data, the value will be `null` */
11
+ /** date and time when the header was last modifiedin the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00'example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null */
12
12
  header?: string | undefined;
13
- /** *date and time when the sitemap was last modified* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` if there is no data, the value will be `null` */
13
+ /** date and time when the sitemap was last modifiedin the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00'example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null */
14
14
  sitemap?: string | undefined;
15
- /** *date and time when the meta tag was last modified* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` if there is no data, the value will be `null` */
15
+ /** date and time when the meta tag was last modifiedin the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00'example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null */
16
16
  meta_tag?: string | undefined;
17
17
  [key: string]: any;
18
18
  constructor(data?: ILastModified);
@@ -1,86 +1,90 @@
1
1
  export interface IOnPageInstantPagesRequestInfo {
2
- /** *target page url* **required field** absolute URL of the target page; **Note #1:** results will be returned for the specified URL only; **Note #2:** to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error; to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue */
2
+ /** target page urlrequired fieldabsolute URL of the target page;Note #1: results will be returned for the specified URL only;Note #2: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue */
3
3
  url?: string | undefined;
4
- /** *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)` */
4
+ /** custom user agentoptional fieldcustom user agent for crawling a websiteexample: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36default value: Mozilla/5.0 (compatible; RSiteAuditor) */
5
5
  custom_user_agent?: string | undefined;
6
- /** *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` */
6
+ /** preset for browser screen parametersoptional fieldif 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: 1920browser_screen_height: 1080browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390browser_screen_height: 844browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024browser_screen_height: 1366browser_screen_scale_factor: 2Note: to use this parameter, set enable_javascript or enable_browser_rendering to true */
7
7
  browser_preset?: string | undefined;
8
- /** *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` */
8
+ /** browser screen widthoptional fieldyou 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: 240maximum value, in pixels: 9999 */
9
9
  browser_screen_width?: number | undefined;
10
- /** *browser screen height* optional field you can set a custom browser screen height 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` */
10
+ /** browser screen heightoptional fieldyou can set a custom browser screen height 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: 240maximum value, in pixels: 9999 */
11
11
  browser_screen_height?: number | undefined;
12
- /** *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` */
12
+ /** browser screen scale factoroptional fieldyou 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.5maximum value: 3 */
13
13
  browser_screen_scale_factor?: number | undefined;
14
- /** *store HTML of a crawled page* optional field set to `true` if you want get the HTML of the page using the [OnPage Raw HTML endpoint](/v3/on_page/raw_html/) default value: `false` */
14
+ /** store HTML of a crawled pageoptional fieldset to true if you want get the HTML of the page using the OnPage Raw HTML endpointdefault value: false */
15
15
  store_raw_html?: boolean | undefined;
16
- /** *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 */
16
+ /** language header for accessing the websiteoptional fieldall 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 */
17
17
  accept_language?: string | undefined;
18
- /** *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) */
18
+ /** load resourcesoptional fieldset to true if you want to load image, stylesheets, scripts, and broken resourcesdefault value: falseNote: 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 */
19
19
  load_resources?: boolean | undefined;
20
- /** *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, parameters `enable_javascript`, and `load_resources` are enabled automatically;** **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) */
20
+ /** emulate browser rendering to measure Core Web Vitalsoptional fieldby 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: falseset to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;if you use this field, parameters enable_javascript, and load_resources are enabled automatically;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 */
21
21
  enable_browser_rendering?: boolean | undefined;
22
- /** *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` */
22
+ /** disable the cookie popup optional fieldset to true if you want to disable the popup requesting cookie consent from the user;default value:false */
23
23
  disable_cookie_popup?: boolean | undefined;
24
- /** *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` */
24
+ /** return data on pages despite the timeout erroroptional fieldif true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error;default value: false */
25
25
  return_despite_timeout?: boolean | undefined;
26
- /** *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`; */
26
+ /** load javascript on a pageoptional fieldset to true if you want to load the scripts available on a pagedefault value: falseNote: 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 */
27
+ enable_javascript?: boolean | undefined;
28
+ /** enable XMLHttpRequest on a pageoptional fieldset to true if you want our crawler to request data from a web server using the XMLHttpRequest objectdefault value:falseif you use this field, enable_javascript must be set to true; */
27
29
  enable_xhr?: boolean | undefined;
28
- /** *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'}` */
30
+ /** custom javascriptoptional fieldNote 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'} */
29
31
  custom_js?: string | undefined;
30
- /** *enable microdata validation* optional field if set to `true`, you can use the [OnPage API Microdata endpoint](/v3/on_page/microdata/) with the `id` of the task; default value: `false` */
32
+ /** enable microdata validationoptional fieldif set to true, you can use the OnPage API Microdata endpoint with the id of the task;default value: false */
31
33
  validate_micromarkup?: boolean | undefined;
32
- /** *check spelling* optional field set to `true` to check spelling on a website using [Hunspell](http://hunspell.github.io/) library default value: `false` */
34
+ /** check spellingoptional fieldset to true to check spelling on a website using Hunspell librarydefault value: false */
33
35
  check_spell?: boolean | undefined;
34
- /** *custom threshold values for checks* optional field you can specify custom threshold values for the parameters included in the `checks` array of OnPage API responses; **Note:** only integer threshold values can be modified; */
36
+ /** custom threshold values for checksoptional fieldyou can specify custom threshold values for the parameters included in the checks array of OnPage API responses;Note: only integer threshold values can be modified; */
35
37
  checks_threshold?: {
36
38
  [key: string]: number;
37
39
  } | undefined;
38
- /** *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 */
40
+ /** switch proxy pooloptional fieldif 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 */
39
41
  switch_pool?: boolean | undefined;
40
- /** *proxy pool* optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional `site_unreachable` errors possible values: `us`, `de` */
42
+ /** proxy pooloptional fieldyou can choose a location of the proxy pool that will be used to obtain the requested data;the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errorspossible values: us, de */
41
43
  ip_pool_for_scan?: string | undefined;
42
44
  [key: string]: any;
43
45
  }
44
46
  export declare class OnPageInstantPagesRequestInfo implements IOnPageInstantPagesRequestInfo {
45
- /** *target page url* **required field** absolute URL of the target page; **Note #1:** results will be returned for the specified URL only; **Note #2:** to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error; to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue */
47
+ /** target page urlrequired fieldabsolute URL of the target page;Note #1: results will be returned for the specified URL only;Note #2: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue */
46
48
  url?: string | undefined;
47
- /** *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)` */
49
+ /** custom user agentoptional fieldcustom user agent for crawling a websiteexample: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36default value: Mozilla/5.0 (compatible; RSiteAuditor) */
48
50
  custom_user_agent?: string | undefined;
49
- /** *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` */
51
+ /** preset for browser screen parametersoptional fieldif 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: 1920browser_screen_height: 1080browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390browser_screen_height: 844browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024browser_screen_height: 1366browser_screen_scale_factor: 2Note: to use this parameter, set enable_javascript or enable_browser_rendering to true */
50
52
  browser_preset?: string | undefined;
51
- /** *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` */
53
+ /** browser screen widthoptional fieldyou 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: 240maximum value, in pixels: 9999 */
52
54
  browser_screen_width?: number | undefined;
53
- /** *browser screen height* optional field you can set a custom browser screen height 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` */
55
+ /** browser screen heightoptional fieldyou can set a custom browser screen height 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: 240maximum value, in pixels: 9999 */
54
56
  browser_screen_height?: number | undefined;
55
- /** *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` */
57
+ /** browser screen scale factoroptional fieldyou 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.5maximum value: 3 */
56
58
  browser_screen_scale_factor?: number | undefined;
57
- /** *store HTML of a crawled page* optional field set to `true` if you want get the HTML of the page using the [OnPage Raw HTML endpoint](/v3/on_page/raw_html/) default value: `false` */
59
+ /** store HTML of a crawled pageoptional fieldset to true if you want get the HTML of the page using the OnPage Raw HTML endpointdefault value: false */
58
60
  store_raw_html?: boolean | undefined;
59
- /** *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 */
61
+ /** language header for accessing the websiteoptional fieldall 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 */
60
62
  accept_language?: string | undefined;
61
- /** *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) */
63
+ /** load resourcesoptional fieldset to true if you want to load image, stylesheets, scripts, and broken resourcesdefault value: falseNote: 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 */
62
64
  load_resources?: boolean | undefined;
63
- /** *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, parameters `enable_javascript`, and `load_resources` are enabled automatically;** **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) */
65
+ /** emulate browser rendering to measure Core Web Vitalsoptional fieldby 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: falseset to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;if you use this field, parameters enable_javascript, and load_resources are enabled automatically;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 */
64
66
  enable_browser_rendering?: boolean | undefined;
65
- /** *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` */
67
+ /** disable the cookie popup optional fieldset to true if you want to disable the popup requesting cookie consent from the user;default value:false */
66
68
  disable_cookie_popup?: boolean | undefined;
67
- /** *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` */
69
+ /** return data on pages despite the timeout erroroptional fieldif true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error;default value: false */
68
70
  return_despite_timeout?: boolean | undefined;
69
- /** *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`; */
71
+ /** load javascript on a pageoptional fieldset to true if you want to load the scripts available on a pagedefault value: falseNote: 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 */
72
+ enable_javascript?: boolean | undefined;
73
+ /** enable XMLHttpRequest on a pageoptional fieldset to true if you want our crawler to request data from a web server using the XMLHttpRequest objectdefault value:falseif you use this field, enable_javascript must be set to true; */
70
74
  enable_xhr?: boolean | undefined;
71
- /** *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'}` */
75
+ /** custom javascriptoptional fieldNote 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'} */
72
76
  custom_js?: string | undefined;
73
- /** *enable microdata validation* optional field if set to `true`, you can use the [OnPage API Microdata endpoint](/v3/on_page/microdata/) with the `id` of the task; default value: `false` */
77
+ /** enable microdata validationoptional fieldif set to true, you can use the OnPage API Microdata endpoint with the id of the task;default value: false */
74
78
  validate_micromarkup?: boolean | undefined;
75
- /** *check spelling* optional field set to `true` to check spelling on a website using [Hunspell](http://hunspell.github.io/) library default value: `false` */
79
+ /** check spellingoptional fieldset to true to check spelling on a website using Hunspell librarydefault value: false */
76
80
  check_spell?: boolean | undefined;
77
- /** *custom threshold values for checks* optional field you can specify custom threshold values for the parameters included in the `checks` array of OnPage API responses; **Note:** only integer threshold values can be modified; */
81
+ /** custom threshold values for checksoptional fieldyou can specify custom threshold values for the parameters included in the checks array of OnPage API responses;Note: only integer threshold values can be modified; */
78
82
  checks_threshold?: {
79
83
  [key: string]: number;
80
84
  } | undefined;
81
- /** *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 */
85
+ /** switch proxy pooloptional fieldif 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 */
82
86
  switch_pool?: boolean | undefined;
83
- /** *proxy pool* optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional `site_unreachable` errors possible values: `us`, `de` */
87
+ /** proxy pooloptional fieldyou can choose a location of the proxy pool that will be used to obtain the requested data;the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errorspossible values: us, de */
84
88
  ip_pool_for_scan?: string | undefined;
85
89
  [key: string]: any;
86
90
  constructor(data?: IOnPageInstantPagesRequestInfo);
@@ -28,6 +28,7 @@ class OnPageInstantPagesRequestInfo {
28
28
  this.enable_browser_rendering = data["enable_browser_rendering"];
29
29
  this.disable_cookie_popup = data["disable_cookie_popup"];
30
30
  this.return_despite_timeout = data["return_despite_timeout"];
31
+ this.enable_javascript = data["enable_javascript"];
31
32
  this.enable_xhr = data["enable_xhr"];
32
33
  this.custom_js = data["custom_js"];
33
34
  this.validate_micromarkup = data["validate_micromarkup"];
@@ -57,6 +58,7 @@ class OnPageInstantPagesRequestInfo {
57
58
  data["enable_browser_rendering"] = this.enable_browser_rendering;
58
59
  data["disable_cookie_popup"] = this.disable_cookie_popup;
59
60
  data["return_despite_timeout"] = this.return_despite_timeout;
61
+ data["enable_javascript"] = this.enable_javascript;
60
62
  data["enable_xhr"] = this.enable_xhr;
61
63
  data["custom_js"] = this.custom_js;
62
64
  data["validate_micromarkup"] = this.validate_micromarkup;
@@ -1 +1 @@
1
- {"version":3,"file":"OnPageInstantPagesRequestInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageInstantPagesRequestInfo.ts"],"names":[],"mappings":";;;AA+DA,MAAa,6BAA6B;IAoGtC,YAAY,IAAqC;QAEjD,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBACvB,IAAK,CAAC,QAAQ,CAAC,GAAS,IAAK,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;QACL,CAAC;IAED,CAAC;IAED,IAAI,CAAC,IAAU;QACX,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC3D,IAAI,CAAC,2BAA2B,GAAG,IAAI,CAAC,6BAA6B,CAAC,CAAC;YACvE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC/C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,0BAA0B,CAAC,CAAC;YACjE,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,wBAAwB,CAAC,CAAC;YAC7D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;YACrC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;YACnC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACvC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACjD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACvC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACrD,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,6BAA6B,EAAE,CAAC;QACjD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAI5C,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAC3D,IAAI,CAAC,6BAA6B,CAAC,GAAG,IAAI,CAAC,2BAA2B,CAAC;QACvE,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,0BAA0B,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC;QACjE,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,sBAAsB,CAAC;QAC7D,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA9KD,sEA8KC"}
1
+ {"version":3,"file":"OnPageInstantPagesRequestInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageInstantPagesRequestInfo.ts"],"names":[],"mappings":";;;AAkEA,MAAa,6BAA6B;IAyGtC,YAAY,IAAqC;QAEjD,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBACvB,IAAK,CAAC,QAAQ,CAAC,GAAS,IAAK,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;QACL,CAAC;IAED,CAAC;IAED,IAAI,CAAC,IAAU;QACX,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC3D,IAAI,CAAC,2BAA2B,GAAG,IAAI,CAAC,6BAA6B,CAAC,CAAC;YACvE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC/C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,0BAA0B,CAAC,CAAC;YACjE,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,wBAAwB,CAAC,CAAC;YAC7D,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;YACrC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;YACnC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACvC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACjD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACvC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACrD,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,6BAA6B,EAAE,CAAC;QACjD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAI5C,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAC3D,IAAI,CAAC,6BAA6B,CAAC,GAAG,IAAI,CAAC,2BAA2B,CAAC;QACvE,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,0BAA0B,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC;QACjE,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,sBAAsB,CAAC;QAC7D,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AArLD,sEAqLC"}
@@ -1,12 +1,12 @@
1
1
  import { OnPageInstantPagesTaskInfo } from "./OnPageInstantPagesTaskInfo";
2
2
  import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
3
3
  export interface IOnPageInstantPagesResponseInfo extends IBaseResponseInfo {
4
- /** *array of tasks* */
4
+ /** array of tasks */
5
5
  tasks?: OnPageInstantPagesTaskInfo[] | undefined;
6
6
  [key: string]: any;
7
7
  }
8
8
  export declare class OnPageInstantPagesResponseInfo extends BaseResponseInfo implements IOnPageInstantPagesResponseInfo {
9
- /** *array of tasks* */
9
+ /** array of tasks */
10
10
  tasks?: OnPageInstantPagesTaskInfo[] | undefined;
11
11
  [key: string]: any;
12
12
  constructor(data?: IOnPageInstantPagesResponseInfo);
@@ -1,27 +1,27 @@
1
1
  import { BaseOnPageResourceItem } from "./BaseOnPageResourceItem";
2
2
  export interface IOnPageInstantPagesResultInfo {
3
- /** *status of the crawling session* possible values: `in_progress`, `finished` */
3
+ /** status of the crawling sessionpossible values: in_progress, finished */
4
4
  crawl_progress?: string | undefined;
5
- /** *details of the crawling session* in this case the value will be `null` */
5
+ /** details of the crawling sessionin this case the value will be null */
6
6
  crawl_status?: any | undefined;
7
- /** *crawler ip address* displays the IP address used by the crawler to initiate the current crawling session you can find the full list of IPs used by our crawler in the [Overview section](/v3/on_page/overview) */
7
+ /** crawler ip addressdisplays the IP address used by the crawler to initiate the current crawling sessionyou can find the full list of IPs used by our crawler in the Overview section */
8
8
  crawl_gateway_address?: string | undefined;
9
- /** *number of items in the results array* */
9
+ /** number of items in the results array */
10
10
  items_count?: number | undefined;
11
- /** *items array* */
11
+ /** items array */
12
12
  items?: BaseOnPageResourceItem[] | undefined;
13
13
  [key: string]: any;
14
14
  }
15
15
  export declare class OnPageInstantPagesResultInfo implements IOnPageInstantPagesResultInfo {
16
- /** *status of the crawling session* possible values: `in_progress`, `finished` */
16
+ /** status of the crawling sessionpossible values: in_progress, finished */
17
17
  crawl_progress?: string | undefined;
18
- /** *details of the crawling session* in this case the value will be `null` */
18
+ /** details of the crawling sessionin this case the value will be null */
19
19
  crawl_status?: any | undefined;
20
- /** *crawler ip address* displays the IP address used by the crawler to initiate the current crawling session you can find the full list of IPs used by our crawler in the [Overview section](/v3/on_page/overview) */
20
+ /** crawler ip addressdisplays the IP address used by the crawler to initiate the current crawling sessionyou can find the full list of IPs used by our crawler in the Overview section */
21
21
  crawl_gateway_address?: string | undefined;
22
- /** *number of items in the results array* */
22
+ /** number of items in the results array */
23
23
  items_count?: number | undefined;
24
- /** *items array* */
24
+ /** items array */
25
25
  items?: BaseOnPageResourceItem[] | undefined;
26
26
  [key: string]: any;
27
27
  constructor(data?: IOnPageInstantPagesResultInfo);
@@ -1,12 +1,12 @@
1
1
  import { OnPageInstantPagesResultInfo } from "./OnPageInstantPagesResultInfo";
2
2
  import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
3
3
  export interface IOnPageInstantPagesTaskInfo extends IBaseResponseTaskInfo {
4
- /** *array of results* */
4
+ /** array of results */
5
5
  result?: OnPageInstantPagesResultInfo[] | undefined;
6
6
  [key: string]: any;
7
7
  }
8
8
  export declare class OnPageInstantPagesTaskInfo extends BaseResponseTaskInfo implements IOnPageInstantPagesTaskInfo {
9
- /** *array of results* */
9
+ /** array of results */
10
10
  result?: OnPageInstantPagesResultInfo[] | undefined;
11
11
  [key: string]: any;
12
12
  constructor(data?: IOnPageInstantPagesTaskInfo);
@@ -1,11 +1,13 @@
1
1
  import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
2
2
  export interface IOnPageLighthouseTaskGetJsonTaskInfo extends IBaseResponseTaskInfo {
3
+ /** *results of Lighthouse audit* this array will include data according to the parameters specified in the POST request; description of the fields in the `result` array is available in the [official documentation](https://github.com/GoogleChrome/lighthouse/blob/master/readme.md) */
3
4
  result?: {
4
5
  [key: string]: any;
5
6
  }[] | undefined;
6
7
  [key: string]: any;
7
8
  }
8
9
  export declare class OnPageLighthouseTaskGetJsonTaskInfo extends BaseResponseTaskInfo implements IOnPageLighthouseTaskGetJsonTaskInfo {
10
+ /** *results of Lighthouse audit* this array will include data according to the parameters specified in the POST request; description of the fields in the `result` array is available in the [official documentation](https://github.com/GoogleChrome/lighthouse/blob/master/readme.md) */
9
11
  result?: {
10
12
  [key: string]: any;
11
13
  }[] | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"OnPageLighthouseTaskGetJsonTaskInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageLighthouseTaskGetJsonTaskInfo.ts"],"names":[],"mappings":";;;AAAA,iEAAqF;AAWrF,MAAa,mCAAqC,SAAQ,2CAAoB;IAO1E,YAAY,IAA2C;QACvD,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,mCAAmC,EAAE,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA1CD,kFA0CC"}
1
+ {"version":3,"file":"OnPageLighthouseTaskGetJsonTaskInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageLighthouseTaskGetJsonTaskInfo.ts"],"names":[],"mappings":";;;AAAA,iEAAqF;AAYrF,MAAa,mCAAqC,SAAQ,2CAAoB;IAU1E,YAAY,IAA2C;QACvD,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,mCAAmC,EAAE,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA7CD,kFA6CC"}
@@ -1,34 +1,34 @@
1
1
  export interface IOnPagePagesRequestInfo {
2
- /** *ID of the task* **required field** you can get this ID in the response of the [Task POST](https://docs.dataforseo.com/v3/on_page/task_post/) endpoint example: '07131248-1535-0216-1000-17384017ad04' */
2
+ /** ID of the taskrequired fieldyou can get this ID in the response of the Task POST endpointexample:'07131248-1535-0216-1000-17384017ad04' */
3
3
  id?: string | undefined;
4
- /** *the maximum number of returned pages* optional field default value: `100` maximum value: `1000` */
4
+ /** the maximum number of returned pagesoptional fielddefault value: 100maximum value: 1000 */
5
5
  limit?: number | undefined;
6
- /** *offset in the results array of returned pages* optional field default value: `0` maximum value: `2000000` if you specify the `10` value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
6
+ /** offset in the results array of returned pagesoptional fielddefault value: 0maximum value: 2000000if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
7
7
  offset?: number | undefined;
8
- /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `regex`, `not_regex`, ``, `>=`, `=`, `<>`, `in`, `not_in`, `like`, `not_like` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['meta.external_links_count','<=',50]``['url','like','https://dataforseo.com/apis/dataforseo-labs-api']``[['checks.high_waiting_time','=',false],'and',['resource_type','=','html']]``[['page_timing.duration_time','<',100],'and',[['checks.large_page_size','=',false],'or',['checks.high_waiting_time','=',false]]]`The full list of possible filters is available [by this link.](/v3/on_page/filters_and_thresholds/?bash) */
8
+ /** array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:regex, not_regex, , >=, =, <>, in, not_in, like, not_likeyou can use the % operator with like and not_like to match any string of zero or more charactersexample:['meta.external_links_count','<=',50]['url','like','https://dataforseo.com/apis/dataforseo-labs-api'][['checks.high_waiting_time','=',false],'and',['resource_type','=','html']][['page_timing.duration_time','<',100],'and',[['checks.large_page_size','=',false],'or',['checks.high_waiting_time','=',false]]]The full list of possible filters is available by this link. */
9
9
  filters?: any[] | undefined;
10
- /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order you should use a comma to set up a sorting type example: `['meta.external_links_count,desc']` **note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `['page_timing.dom_complete,asc','size,desc']` */
10
+ /** results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending orderyou should use a comma to set up a sorting typeexample:['meta.external_links_count,desc']note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:['page_timing.dom_complete,asc','size,desc'] */
11
11
  order_by?: string[] | undefined;
12
- /** *token for subsequent requests* optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over `20,000` results in a single request; by specifying the unique `search_after_token` value from the response array, you will get the subsequent results of the initial task; `search_after_token` values are unique for each subsequent task ; **Note:** if the `search_after_token` is specified in the request, all other parameters should be identical to the previous request */
12
+ /** token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task ;Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request */
13
13
  search_after_token?: string | undefined;
14
- /** *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 */
14
+ /** user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response */
15
15
  tag?: string | undefined;
16
16
  [key: string]: any;
17
17
  }
18
18
  export declare class OnPagePagesRequestInfo implements IOnPagePagesRequestInfo {
19
- /** *ID of the task* **required field** you can get this ID in the response of the [Task POST](https://docs.dataforseo.com/v3/on_page/task_post/) endpoint example: '07131248-1535-0216-1000-17384017ad04' */
19
+ /** ID of the taskrequired fieldyou can get this ID in the response of the Task POST endpointexample:'07131248-1535-0216-1000-17384017ad04' */
20
20
  id?: string | undefined;
21
- /** *the maximum number of returned pages* optional field default value: `100` maximum value: `1000` */
21
+ /** the maximum number of returned pagesoptional fielddefault value: 100maximum value: 1000 */
22
22
  limit?: number | undefined;
23
- /** *offset in the results array of returned pages* optional field default value: `0` maximum value: `2000000` if you specify the `10` value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
23
+ /** offset in the results array of returned pagesoptional fielddefault value: 0maximum value: 2000000if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
24
24
  offset?: number | undefined;
25
- /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `regex`, `not_regex`, ``, `>=`, `=`, `<>`, `in`, `not_in`, `like`, `not_like` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['meta.external_links_count','<=',50]``['url','like','https://dataforseo.com/apis/dataforseo-labs-api']``[['checks.high_waiting_time','=',false],'and',['resource_type','=','html']]``[['page_timing.duration_time','<',100],'and',[['checks.large_page_size','=',false],'or',['checks.high_waiting_time','=',false]]]`The full list of possible filters is available [by this link.](/v3/on_page/filters_and_thresholds/?bash) */
25
+ /** array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:regex, not_regex, , >=, =, <>, in, not_in, like, not_likeyou can use the % operator with like and not_like to match any string of zero or more charactersexample:['meta.external_links_count','<=',50]['url','like','https://dataforseo.com/apis/dataforseo-labs-api'][['checks.high_waiting_time','=',false],'and',['resource_type','=','html']][['page_timing.duration_time','<',100],'and',[['checks.large_page_size','=',false],'or',['checks.high_waiting_time','=',false]]]The full list of possible filters is available by this link. */
26
26
  filters?: any[] | undefined;
27
- /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order you should use a comma to set up a sorting type example: `['meta.external_links_count,desc']` **note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `['page_timing.dom_complete,asc','size,desc']` */
27
+ /** results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending orderyou should use a comma to set up a sorting typeexample:['meta.external_links_count,desc']note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:['page_timing.dom_complete,asc','size,desc'] */
28
28
  order_by?: string[] | undefined;
29
- /** *token for subsequent requests* optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over `20,000` results in a single request; by specifying the unique `search_after_token` value from the response array, you will get the subsequent results of the initial task; `search_after_token` values are unique for each subsequent task ; **Note:** if the `search_after_token` is specified in the request, all other parameters should be identical to the previous request */
29
+ /** token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task ;Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request */
30
30
  search_after_token?: string | undefined;
31
- /** *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 */
31
+ /** user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response */
32
32
  tag?: string | undefined;
33
33
  [key: string]: any;
34
34
  constructor(data?: IOnPagePagesRequestInfo);
@@ -1,12 +1,12 @@
1
1
  import { OnPagePagesTaskInfo } from "./OnPagePagesTaskInfo";
2
2
  import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
3
3
  export interface IOnPagePagesResponseInfo extends IBaseResponseInfo {
4
- /** *array of tasks* */
4
+ /** array of tasks */
5
5
  tasks?: OnPagePagesTaskInfo[] | undefined;
6
6
  [key: string]: any;
7
7
  }
8
8
  export declare class OnPagePagesResponseInfo extends BaseResponseInfo implements IOnPagePagesResponseInfo {
9
- /** *array of tasks* */
9
+ /** array of tasks */
10
10
  tasks?: OnPagePagesTaskInfo[] | undefined;
11
11
  [key: string]: any;
12
12
  constructor(data?: IOnPagePagesResponseInfo);
@@ -1,32 +1,32 @@
1
1
  import { CrawlStatusInfo } from "./CrawlStatusInfo";
2
2
  import { BaseOnPageResourceItem } from "./BaseOnPageResourceItem";
3
3
  export interface IOnPagePagesResultInfo {
4
- /** *status of the crawling session* possible values: `in_progress`, `finished` */
4
+ /** status of the crawling sessionpossible values: in_progress, finished */
5
5
  crawl_progress?: string | undefined;
6
- /** *details of the crawling session* */
6
+ /** details of the crawling session */
7
7
  crawl_status?: CrawlStatusInfo | undefined;
8
8
  search_after_token?: string | undefined;
9
9
  current_offset?: number | undefined;
10
- /** *total number of relevant items in the database* */
10
+ /** total number of relevant items in the database */
11
11
  total_items_count?: number | undefined;
12
- /** *number of items in the results array* */
12
+ /** number of items in the results array */
13
13
  items_count?: number | undefined;
14
- /** *items array* */
14
+ /** items array */
15
15
  items?: BaseOnPageResourceItem[] | undefined;
16
16
  [key: string]: any;
17
17
  }
18
18
  export declare class OnPagePagesResultInfo implements IOnPagePagesResultInfo {
19
- /** *status of the crawling session* possible values: `in_progress`, `finished` */
19
+ /** status of the crawling sessionpossible values: in_progress, finished */
20
20
  crawl_progress?: string | undefined;
21
- /** *details of the crawling session* */
21
+ /** details of the crawling session */
22
22
  crawl_status?: CrawlStatusInfo | undefined;
23
23
  search_after_token?: string | undefined;
24
24
  current_offset?: number | undefined;
25
- /** *total number of relevant items in the database* */
25
+ /** total number of relevant items in the database */
26
26
  total_items_count?: number | undefined;
27
- /** *number of items in the results array* */
27
+ /** number of items in the results array */
28
28
  items_count?: number | undefined;
29
- /** *items array* */
29
+ /** items array */
30
30
  items?: BaseOnPageResourceItem[] | undefined;
31
31
  [key: string]: any;
32
32
  constructor(data?: IOnPagePagesResultInfo);