dataforseo-client 2.1.2 → 2.1.3

package/dist/cjs/models/DataforseoLabsGooglePageIntersectionLiveRequestInfo.d.ts

@@ -1,78 +1,78 @@
 export interface IDataforseoLabsGooglePageIntersectionLiveRequestInfo {
-    /** target URLs of pages required field you can set up to 20 pages in this object the pages should be specified with absolute URLs (including http:// or https://) example: 'pages': { '1':'https://www.apple.com/mac/*', '2':'https://dataforseo.com/*', '3':'https://support.microsoft.com/' }if you specify a single page here, we will return results only for this page; you can also use a wildcard (‘*’) character to specify the search pattern example: 'example.com' search for the exact URL 'example.com/eng/*' search for the example.com page and all its related URLs which start with ‘/eng/’, such as “example.com/eng/index.html” and “example.com/eng/help/”, etc. note: a wilcard should be placed after the slash (‘/’) character in the end of the URL, it is not possible to place it after the domain in the following way: https://dataforseo.com* use https://dataforseo.com/* instead Note: this endpoint will not provide results if the number of intersecting keywords exceeds 10 million */
+    /** *target URLs of pages* **required field** you can set **up to 20 pages** in this object the pages should be specified with absolute URLs (including http:// or https://) example: `'pages': {` `'1':'https://www.apple.com/mac/*',` `'2':'https://dataforseo.com/*',` `'3':'https://support.microsoft.com/'` `}`if you specify a single page here, we will return results only for this page; you can also use a wildcard ('*') character to specify the search pattern example: `'example.com'` search for the exact URL `'example.com/eng/*'` search for the *example.com* page and all its related URLs which start with *'/eng/'*, such as *'example.com/eng/index.html'* and *'example.com/eng/help/'*, etc. **note:** a wilcard should be placed after the slash ('/') character in the end of the URL, it is **not possible** to place it after the domain in the following way: `https://dataforseo.com`***** use `https://dataforseo.com`** /*** instead **Note:** this endpoint will not provide results if the number of intersecting keywords exceeds 10 million */
     pages?: {
         [key: string]: string;
     } | undefined;
-    /** URLs of pages you want to exclude optional field you can set up to 10 pages in this array if you use this array, results will contain the keywords for which URLs from the pages object rank, but URLs from exclude_pages array do not; note that if you specify this field, the results will be based on the keywords any URL from pages ranks for regardless of intersections between them. However, you can set intersection_mode to intersect and results will contain the keywords all URLs from pages rank for in the same SERP and URLs from exclude_pages do not. use a wildcard (‘*’) character to specify the search pattern example: 'exclude_pages': [ 'https://www.apple.com/iphone/*', 'https://dataforseo.com/apis/*', 'https://www.microsoft.com/en-us/industry/services/' ] */
+    /** *URLs of pages you want to exclude* optional field you can set **up to 10 pages** in this array if you use this array, results will contain the keywords for which URLs from the `pages` object rank, but URLs from `exclude_pages` array do not; **note** that if you specify this field, the results will be based on the keywords **any** URL from `pages` ranks for regardless of intersections between them. However, you can set `intersection_mode` to `intersect` and results will contain the keywords **all** URLs from `pages` rank for in the same SERP and URLs from `exclude_pages` do not.  use a wildcard ('*') character to specify the search pattern example: `'exclude_pages':` `['https://www.apple.com/iphone/*',` `'https://dataforseo.com/apis/*',` `'https://www.microsoft.com/en-us/industry/services/']` */
     exclude_pages?: string[] | undefined;
-    /** full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom */
+    /** *full name of the location* **required field if you don't specify** `location_code` **Note:** it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_name` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `United Kingdom` */
     location_name?: string | undefined;
-    /** location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840 */
+    /** *location code* **required field if you don't specify** `location_name` **Note:** it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_code` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `2840` */
     location_code?: number | undefined;
-    /** full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English */
+    /** *full name of the language* **required field if you don't specify** `language_code` **Note:** it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_name` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `English` */
     language_name?: string | undefined;
-    /** language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en */
+    /** *language code* **required field if you don't specify** `language_name` **Note:** it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_code` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `en` */
     language_code?: string | undefined;
-    /** search results type indicates type of search results included in the response optional field possible values: ['organic', 'paid', 'featured_snippet', 'local_pack'] default value: ['organic', 'paid'] */
+    /** *search results type* indicates type of search results included in the response optional field possible values:  `['organic', 'paid', 'featured_snippet', 'local_pack']` default value:  `['organic', 'paid']` */
     item_types?: string[] | undefined;
-    /** the maximum number of returned keywords optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned keywords* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the items array of returned keywords optional field default value: 0 if you specify 10 here, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
+    /** *offset in the `items` array of returned keywords* optional field default value: `0` if you specify `10` here, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
     offset?: number | undefined;
-    /** indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true */
+    /** *indicates if the subdomains will be included in the search* optional field if set to `false`, the subdomains will be ignored default value: `true` */
     include_subdomains?: boolean | undefined;
-    /** indicates whether to intersect keywords optional field use this field to intersect or merge results for the specified URLs possible values: union, intersect union – results are based on all keywords any URL from pages rank for; intersect – results are based on the keywords all URLs from pages rank for in the same SERP: by default, results are based on the intersect mode if you specify only pages array. If you specify exclude_pages as well, results are based on the union mode */
+    /** *indicates whether to intersect keywords* optional field use this field to intersect or merge results for the specified URLs possible values: `union`, `intersect` `union` - results are based on all keywords **any** URL from `pages` rank for; `intersect` - results are based on the keywords **all** URLs from `pages` rank for in the same SERP: by default, results are based on the `intersect` mode if you specify only `pages` array. If you specify `exclude_pages` as well, results are based on the `union` mode */
     intersection_mode?: string | undefined;
-    /** include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false */
+    /** *include data from SERP for each keyword* optional field if set to `true`, we will return a `serp_info` array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: `false` */
     include_serp_info?: boolean | undefined;
-    /** include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `clickstream_etv`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | undefined;
-    /** ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true` only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** 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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters note that if you want to filter by any field in the intersection_result array you need to specify the number of corresponding page for instance, if you want to filter results by the ranking of the first specified URL, you should set the following filter: [intersection_result.1.rank_absolute,'=',1] if you want to filter results and receive only organic listings for the third specified URL, you should set the following filter: [intersection_result.3.type,'=','organic'] , etc.example: ['keyword_data.keyword_info.search_volume','in',[100,1000]] [['intersection_result.1.etv','>',0],'and',['intersection_result.1.description','like','%goat%']][['keyword_data.keyword_info.search_volume','>',100], 'and', [['intersection_result.2.description','like','%goat%'], 'or', ['intersection_result.2.type','=','organic']]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** *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`, `ilike`, `not_ilike`, `like`, `not_like`, `match`, `not_match` you can use the `%` operator with `like` and `not_like`, as well as `ilike` and `not_ilike` to match any string of zero or more characters **note** that if you want to filter by any field in the `intersection_result` array you need to specify the number of corresponding page for instance, if you want to filter results by the ranking of the first specified URL, you should set the following filter: `[intersection_result.1.rank_absolute,'=',1]` if you want to filter results and receive only organic listings for the third specified URL, you should set the following filter: `[intersection_result.3.type,'=','organic']` , etc.example: `['keyword_data.keyword_info.search_volume','in',[100,1000]]` `[['intersection_result.1.etv','>',0],'and',['intersection_result.1.description','like','%goat%']]``[['keyword_data.keyword_info.search_volume','>',100],'and',[['intersection_result.2.description','like','%goat%'],'or',['intersection_result.2.type','=','organic']]]` for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** 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 parameter example: ['keyword_data.keyword_info.competition,desc'] default rule: ['keyword_data.keyword_info.search_volume,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: ['intersection_result.1.rank_group,asc','intersection_result.2.rank_absolute,asc'] */
+    /** *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 parameter example: `['keyword_data.keyword_info.competition,desc']` default rule: `['keyword_data.keyword_info.search_volume,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: `['intersection_result.1.rank_group,asc','intersection_result.2.rank_absolute,asc']` */
     order_by?: 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 DataforseoLabsGooglePageIntersectionLiveRequestInfo implements IDataforseoLabsGooglePageIntersectionLiveRequestInfo {
-    /** target URLs of pages required field you can set up to 20 pages in this object the pages should be specified with absolute URLs (including http:// or https://) example: 'pages': { '1':'https://www.apple.com/mac/*', '2':'https://dataforseo.com/*', '3':'https://support.microsoft.com/' }if you specify a single page here, we will return results only for this page; you can also use a wildcard (‘*’) character to specify the search pattern example: 'example.com' search for the exact URL 'example.com/eng/*' search for the example.com page and all its related URLs which start with ‘/eng/’, such as “example.com/eng/index.html” and “example.com/eng/help/”, etc. note: a wilcard should be placed after the slash (‘/’) character in the end of the URL, it is not possible to place it after the domain in the following way: https://dataforseo.com* use https://dataforseo.com/* instead Note: this endpoint will not provide results if the number of intersecting keywords exceeds 10 million */
+    /** *target URLs of pages* **required field** you can set **up to 20 pages** in this object the pages should be specified with absolute URLs (including http:// or https://) example: `'pages': {` `'1':'https://www.apple.com/mac/*',` `'2':'https://dataforseo.com/*',` `'3':'https://support.microsoft.com/'` `}`if you specify a single page here, we will return results only for this page; you can also use a wildcard ('*') character to specify the search pattern example: `'example.com'` search for the exact URL `'example.com/eng/*'` search for the *example.com* page and all its related URLs which start with *'/eng/'*, such as *'example.com/eng/index.html'* and *'example.com/eng/help/'*, etc. **note:** a wilcard should be placed after the slash ('/') character in the end of the URL, it is **not possible** to place it after the domain in the following way: `https://dataforseo.com`***** use `https://dataforseo.com`** /*** instead **Note:** this endpoint will not provide results if the number of intersecting keywords exceeds 10 million */
     pages?: {
         [key: string]: string;
     } | undefined;
-    /** URLs of pages you want to exclude optional field you can set up to 10 pages in this array if you use this array, results will contain the keywords for which URLs from the pages object rank, but URLs from exclude_pages array do not; note that if you specify this field, the results will be based on the keywords any URL from pages ranks for regardless of intersections between them. However, you can set intersection_mode to intersect and results will contain the keywords all URLs from pages rank for in the same SERP and URLs from exclude_pages do not. use a wildcard (‘*’) character to specify the search pattern example: 'exclude_pages': [ 'https://www.apple.com/iphone/*', 'https://dataforseo.com/apis/*', 'https://www.microsoft.com/en-us/industry/services/' ] */
+    /** *URLs of pages you want to exclude* optional field you can set **up to 10 pages** in this array if you use this array, results will contain the keywords for which URLs from the `pages` object rank, but URLs from `exclude_pages` array do not; **note** that if you specify this field, the results will be based on the keywords **any** URL from `pages` ranks for regardless of intersections between them. However, you can set `intersection_mode` to `intersect` and results will contain the keywords **all** URLs from `pages` rank for in the same SERP and URLs from `exclude_pages` do not.  use a wildcard ('&ast;') character to specify the search pattern example: `'exclude_pages':` `['https://www.apple.com/iphone/&ast;',` `'https://dataforseo.com/apis/&ast;',` `'https://www.microsoft.com/en-us/industry/services/']` */
     exclude_pages?: string[] | undefined;
-    /** full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom */
+    /** *full name of the location* **required field if you don't specify** `location_code` **Note:** it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_name` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `United Kingdom` */
     location_name?: string | undefined;
-    /** location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840 */
+    /** *location code* **required field if you don't specify** `location_name` **Note:** it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_code` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `2840` */
     location_code?: number | undefined;
-    /** full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English */
+    /** *full name of the language* **required field if you don't specify** `language_code` **Note:** it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_name` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `English` */
     language_name?: string | undefined;
-    /** language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en */
+    /** *language code* **required field if you don't specify** `language_name` **Note:** it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_code` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `en` */
     language_code?: string | undefined;
-    /** search results type indicates type of search results included in the response optional field possible values: ['organic', 'paid', 'featured_snippet', 'local_pack'] default value: ['organic', 'paid'] */
+    /** *search results type* indicates type of search results included in the response optional field possible values:  `['organic', 'paid', 'featured_snippet', 'local_pack']` default value:  `['organic', 'paid']` */
     item_types?: string[] | undefined;
-    /** the maximum number of returned keywords optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned keywords* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the items array of returned keywords optional field default value: 0 if you specify 10 here, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
+    /** *offset in the `items` array of returned keywords* optional field default value: `0` if you specify `10` here, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
     offset?: number | undefined;
-    /** indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true */
+    /** *indicates if the subdomains will be included in the search* optional field if set to `false`, the subdomains will be ignored default value: `true` */
     include_subdomains?: boolean | undefined;
-    /** indicates whether to intersect keywords optional field use this field to intersect or merge results for the specified URLs possible values: union, intersect union – results are based on all keywords any URL from pages rank for; intersect – results are based on the keywords all URLs from pages rank for in the same SERP: by default, results are based on the intersect mode if you specify only pages array. If you specify exclude_pages as well, results are based on the union mode */
+    /** *indicates whether to intersect keywords* optional field use this field to intersect or merge results for the specified URLs possible values: `union`, `intersect` `union` - results are based on all keywords **any** URL from `pages` rank for; `intersect` - results are based on the keywords **all** URLs from `pages` rank for in the same SERP: by default, results are based on the `intersect` mode if you specify only `pages` array. If you specify `exclude_pages` as well, results are based on the `union` mode */
     intersection_mode?: string | undefined;
-    /** include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false */
+    /** *include data from SERP for each keyword* optional field if set to `true`, we will return a `serp_info` array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: `false` */
     include_serp_info?: boolean | undefined;
-    /** include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `clickstream_etv`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | undefined;
-    /** ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true` only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** 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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters note that if you want to filter by any field in the intersection_result array you need to specify the number of corresponding page for instance, if you want to filter results by the ranking of the first specified URL, you should set the following filter: [intersection_result.1.rank_absolute,'=',1] if you want to filter results and receive only organic listings for the third specified URL, you should set the following filter: [intersection_result.3.type,'=','organic'] , etc.example: ['keyword_data.keyword_info.search_volume','in',[100,1000]] [['intersection_result.1.etv','>',0],'and',['intersection_result.1.description','like','%goat%']][['keyword_data.keyword_info.search_volume','>',100], 'and', [['intersection_result.2.description','like','%goat%'], 'or', ['intersection_result.2.type','=','organic']]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** *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`, `ilike`, `not_ilike`, `like`, `not_like`, `match`, `not_match` you can use the `%` operator with `like` and `not_like`, as well as `ilike` and `not_ilike` to match any string of zero or more characters **note** that if you want to filter by any field in the `intersection_result` array you need to specify the number of corresponding page for instance, if you want to filter results by the ranking of the first specified URL, you should set the following filter: `[intersection_result.1.rank_absolute,'=',1]` if you want to filter results and receive only organic listings for the third specified URL, you should set the following filter: `[intersection_result.3.type,'=','organic']` , etc.example: `['keyword_data.keyword_info.search_volume','in',[100,1000]]` `[['intersection_result.1.etv','>',0],'and',['intersection_result.1.description','like','%goat%']]``[['keyword_data.keyword_info.search_volume','>',100],'and',[['intersection_result.2.description','like','%goat%'],'or',['intersection_result.2.type','=','organic']]]` for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** 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 parameter example: ['keyword_data.keyword_info.competition,desc'] default rule: ['keyword_data.keyword_info.search_volume,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: ['intersection_result.1.rank_group,asc','intersection_result.2.rank_absolute,asc'] */
+    /** *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 parameter example: `['keyword_data.keyword_info.competition,desc']` default rule: `['keyword_data.keyword_info.search_volume,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: `['intersection_result.1.rank_group,asc','intersection_result.2.rank_absolute,asc']` */
     order_by?: 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?: IDataforseoLabsGooglePageIntersectionLiveRequestInfo);

package/dist/cjs/models/DataforseoLabsGooglePageIntersectionLiveResponseInfo.d.ts

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

package/dist/cjs/models/DataforseoLabsGooglePageIntersectionLiveResultInfo.d.ts

@@ -1,43 +1,43 @@
 import { DataforseoLabsGooglePageIntersectionLiveItem } from "./DataforseoLabsGooglePageIntersectionLiveItem";
 export interface IDataforseoLabsGooglePageIntersectionLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** URLs you specified a POST array */
+    /** *URLs you specified a POST array* */
     pages?: {
         [key: string]: string;
     } | undefined;
-    /** URLs you specified in a POST array that will be excluded from the results */
+    /** *URLs you specified in a POST array that will be excluded from the results* */
     exclude_pages?: string[] | undefined;
-    /** location code in a POST array */
+    /** *location code in a POST array* */
     location_code?: number | undefined;
-    /** language code in a POST array */
+    /** *language code in a POST array* */
     language_code?: string | undefined;
-    /** total amount of results in our database relevant to your request */
+    /** *total amount of results in our database relevant to your request* */
     total_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** contains keywords, relevant SERP elements and related data */
+    /** *contains keywords, relevant SERP elements and related data* */
     items?: DataforseoLabsGooglePageIntersectionLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGooglePageIntersectionLiveResultInfo implements IDataforseoLabsGooglePageIntersectionLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** URLs you specified a POST array */
+    /** *URLs you specified a POST array* */
     pages?: {
         [key: string]: string;
     } | undefined;
-    /** URLs you specified in a POST array that will be excluded from the results */
+    /** *URLs you specified in a POST array that will be excluded from the results* */
     exclude_pages?: string[] | undefined;
-    /** location code in a POST array */
+    /** *location code in a POST array* */
     location_code?: number | undefined;
-    /** language code in a POST array */
+    /** *language code in a POST array* */
     language_code?: string | undefined;
-    /** total amount of results in our database relevant to your request */
+    /** *total amount of results in our database relevant to your request* */
     total_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** contains keywords, relevant SERP elements and related data */
+    /** *contains keywords, relevant SERP elements and related data* */
     items?: DataforseoLabsGooglePageIntersectionLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGooglePageIntersectionLiveResultInfo);

package/dist/cjs/models/DataforseoLabsGooglePageIntersectionLiveTaskInfo.d.ts

@@ -1,12 +1,12 @@
 import { DataforseoLabsGooglePageIntersectionLiveResultInfo } from "./DataforseoLabsGooglePageIntersectionLiveResultInfo";
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface IDataforseoLabsGooglePageIntersectionLiveTaskInfo extends IBaseResponseTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: DataforseoLabsGooglePageIntersectionLiveResultInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGooglePageIntersectionLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGooglePageIntersectionLiveTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: DataforseoLabsGooglePageIntersectionLiveResultInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGooglePageIntersectionLiveTaskInfo);

package/dist/cjs/models/DataforseoLabsGoogleRankedKeywordsLiveItem.d.ts

@@ -1,20 +1,20 @@
 import { KeywordDataInfo } from "./KeywordDataInfo";
 import { RankedSerpElement } from "./RankedSerpElement";
 export interface IDataforseoLabsGoogleRankedKeywordsLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keyword data for the returned keyword */
+    /** *keyword data for the returned keyword* */
     keyword_data?: KeywordDataInfo | undefined;
-    /** contains data on the domain’s SERP element found for the returned keyword */
+    /** *contains data on the domain's SERP element found for the returned `keyword`* */
     ranked_serp_element?: RankedSerpElement | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleRankedKeywordsLiveItem implements IDataforseoLabsGoogleRankedKeywordsLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keyword data for the returned keyword */
+    /** *keyword data for the returned keyword* */
     keyword_data?: KeywordDataInfo | undefined;
-    /** contains data on the domain’s SERP element found for the returned keyword */
+    /** *contains data on the domain's SERP element found for the returned `keyword`* */
     ranked_serp_element?: RankedSerpElement | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleRankedKeywordsLiveItem);

package/dist/cjs/models/DataforseoLabsGoogleRankedKeywordsLiveRequestInfo.d.ts

@@ -1,66 +1,66 @@
 export interface IDataforseoLabsGoogleRankedKeywordsLiveRequestInfo {
-    /** domain name or page url required field the domain name of the target website, subdomain or URL of the target webpage; the domain name must be specified without https:// or www.; the subdomain must be specified without https://; the webpage URL must be specified with https:// or www. Note: if you specify the webpage URL without https:// or www., the result will be returned for the entire domain rather than the specific page */
+    /** *domain name or page url* **required field** the domain name of the target website, subdomain or URL of the target webpage; the **domain name** must be specified **without** `https://` or `www.`; the **subdomain** must be specified **without** `https://`; the **webpage URL** must be specified **with** `https://` or `www.` **Note:** if you specify the **webpage URL** without `https://` or `www.`, the result will be returned for the **entire domain** rather than the specific page */
     target?: string | undefined;
-    /** full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom */
+    /** *full name of the location* optional field if you use this field, you don't need to specify `location_code` you can receive the list of available locations with their `location_name` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` ignore this field to get the results for all available locations example: `United Kingdom` */
     location_name?: string | undefined;
-    /** location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840 */
+    /** *location code* optional field if you use this field, you don't need to specify `location_name` you can receive the list of available locations with their `location_code` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` ignore this field to get the results for all available locations example: `2840` */
     location_code?: number | undefined;
-    /** full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English */
+    /** *full name of the language* optional field if you use this field, you don't need to specify `language_code` you can receive the list of available languages with their `language_name` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` ignore this field to get the results for all available languages example: `English` */
     language_name?: string | undefined;
-    /** language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en */
+    /** *language code* optional field if you use this field, you don't need to specify `language_name` you can receive the list of available languages with their `language_code` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` ignore this field to get the results for all available languages example: `en` */
     language_code?: string | undefined;
-    /** ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true` only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: ['organic', 'paid', 'featured_snippet', 'local_pack', 'ai_overview_reference'] default value: ['organic', 'paid'] */
+    /** *display results by item type* optional field indicates the type of search results included in the response **Note:** if the `item_types` array contains item types that are different from `organic`, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values:  `['organic', 'paid', 'featured_snippet', 'local_pack', 'ai_overview_reference']` default value:  `['organic', 'paid']` */
     item_types?: string[] | undefined;
-    /** include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, clickstream_gender_distribution, clickstream_age_distribution, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `clickstream_etv`, `clickstream_gender_distribution`, `clickstream_age_distribution`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | undefined;
-    /** the maximum number of returned keywords optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned keywords* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
+    /** *offset in the results array of returned keywords* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
     offset?: number | undefined;
-    /** return rankings distribution by rank_absolute optional field default value: false if set to true, we will return the field metrics_absolute containing rankings distribution by the rank_absolute parameter that indicates the result’s position among all SERP elements */
+    /** *return rankings distribution by `rank_absolute`* optional field default value: `false` if set to `true`, we will return the field `metrics_absolute` containing rankings distribution by the `rank_absolute` parameter that indicates the result’s position among all SERP elements */
     load_rank_absolute?: boolean | undefined;
-    /** data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return keywords for which the specified target currently has ranking results in SERP; lost — return keywords for which the specified target had previously had ranking results in SERP, but didn’t have them during the last check; all — return both types of keywords. default value: live */
+    /** *data collection mode* optional field you can use this field to filter the results; possible types of filtering: `live` — return keywords for which the specified `target` currently has ranking results in SERP; `lost` — return keywords for which the specified `target` had previously had ranking results in SERP, but didn't have them during the last check; `all` — return both types of keywords. default value: `live` */
     historical_serp_mode?: string | undefined;
-    /** 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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ['ranked_serp_element.serp_item.rank_group','','paid']] [['keyword_data.keyword_info.search_volume','<>',0], 'and', [['ranked_serp_element.serp_item.type','<>','paid'],'or',['ranked_serp_element.serp_item.is_malicious','=',false]]] if you want to get the keywords a particular webpage ranks for, you can use a target field or filter by the ranked_serp_element.serp_item.relative_url parameter example: ['ranked_serp_element.serp_item.relative_url', '=', '/apis/rank-tracker-api'] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** *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`, `match`, `not_match`, `ilike`, `not_ilike`, `like`, `not_like` you can use the `%` operator with `like` and `not_like`, as well as `ilike` and `not_ilike` to match any string of zero or more characters example: `['ranked_serp_element.serp_item.rank_group','','paid']]` `[['keyword_data.keyword_info.search_volume','<>',0],'and',[['ranked_serp_element.serp_item.type','<>','paid'],'or',['ranked_serp_element.serp_item.is_malicious','=',false]]]` if you want to get the keywords a particular webpage ranks for, you can use a `[target](/v3/dataforseo_labs/google/ranked_keywords/live/#target)` field or filter by the `ranked_serp_element.serp_item.relative_url` parameter example: `['ranked_serp_element.serp_item.relative_url', '=', '/apis/rank-tracker-api']` for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** 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: ['keyword_data.keyword_info.competition,desc'] default rule: ['ranked_serp_element.serp_item.rank_group,asc'] 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: ['keyword_data.keyword_info.search_volume,desc','keyword_data.keyword_info.cpc,desc'] */
+    /** *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: `['keyword_data.keyword_info.competition,desc']` default rule: `['ranked_serp_element.serp_item.rank_group,asc']` **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: `['keyword_data.keyword_info.search_volume,desc','keyword_data.keyword_info.cpc,desc']` */
     order_by?: 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 DataforseoLabsGoogleRankedKeywordsLiveRequestInfo implements IDataforseoLabsGoogleRankedKeywordsLiveRequestInfo {
-    /** domain name or page url required field the domain name of the target website, subdomain or URL of the target webpage; the domain name must be specified without https:// or www.; the subdomain must be specified without https://; the webpage URL must be specified with https:// or www. Note: if you specify the webpage URL without https:// or www., the result will be returned for the entire domain rather than the specific page */
+    /** *domain name or page url* **required field** the domain name of the target website, subdomain or URL of the target webpage; the **domain name** must be specified **without** `https://` or `www.`; the **subdomain** must be specified **without** `https://`; the **webpage URL** must be specified **with** `https://` or `www.` **Note:** if you specify the **webpage URL** without `https://` or `www.`, the result will be returned for the **entire domain** rather than the specific page */
     target?: string | undefined;
-    /** full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom */
+    /** *full name of the location* optional field if you use this field, you don't need to specify `location_code` you can receive the list of available locations with their `location_name` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` ignore this field to get the results for all available locations example: `United Kingdom` */
     location_name?: string | undefined;
-    /** location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840 */
+    /** *location code* optional field if you use this field, you don't need to specify `location_name` you can receive the list of available locations with their `location_code` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` ignore this field to get the results for all available locations example: `2840` */
     location_code?: number | undefined;
-    /** full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English */
+    /** *full name of the language* optional field if you use this field, you don't need to specify `language_code` you can receive the list of available languages with their `language_name` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` ignore this field to get the results for all available languages example: `English` */
     language_name?: string | undefined;
-    /** language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en */
+    /** *language code* optional field if you use this field, you don't need to specify `language_name` you can receive the list of available languages with their `language_code` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` ignore this field to get the results for all available languages example: `en` */
     language_code?: string | undefined;
-    /** ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true` only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: ['organic', 'paid', 'featured_snippet', 'local_pack', 'ai_overview_reference'] default value: ['organic', 'paid'] */
+    /** *display results by item type* optional field indicates the type of search results included in the response **Note:** if the `item_types` array contains item types that are different from `organic`, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values:  `['organic', 'paid', 'featured_snippet', 'local_pack', 'ai_overview_reference']` default value:  `['organic', 'paid']` */
     item_types?: string[] | undefined;
-    /** include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, clickstream_gender_distribution, clickstream_age_distribution, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `clickstream_etv`, `clickstream_gender_distribution`, `clickstream_age_distribution`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | undefined;
-    /** the maximum number of returned keywords optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned keywords* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
+    /** *offset in the results array of returned keywords* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
     offset?: number | undefined;
-    /** return rankings distribution by rank_absolute optional field default value: false if set to true, we will return the field metrics_absolute containing rankings distribution by the rank_absolute parameter that indicates the result’s position among all SERP elements */
+    /** *return rankings distribution by `rank_absolute`* optional field default value: `false` if set to `true`, we will return the field `metrics_absolute` containing rankings distribution by the `rank_absolute` parameter that indicates the result’s position among all SERP elements */
     load_rank_absolute?: boolean | undefined;
-    /** data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return keywords for which the specified target currently has ranking results in SERP; lost — return keywords for which the specified target had previously had ranking results in SERP, but didn’t have them during the last check; all — return both types of keywords. default value: live */
+    /** *data collection mode* optional field you can use this field to filter the results; possible types of filtering: `live` — return keywords for which the specified `target` currently has ranking results in SERP; `lost` — return keywords for which the specified `target` had previously had ranking results in SERP, but didn't have them during the last check; `all` — return both types of keywords. default value: `live` */
     historical_serp_mode?: string | undefined;
-    /** 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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ['ranked_serp_element.serp_item.rank_group','','paid']] [['keyword_data.keyword_info.search_volume','<>',0], 'and', [['ranked_serp_element.serp_item.type','<>','paid'],'or',['ranked_serp_element.serp_item.is_malicious','=',false]]] if you want to get the keywords a particular webpage ranks for, you can use a target field or filter by the ranked_serp_element.serp_item.relative_url parameter example: ['ranked_serp_element.serp_item.relative_url', '=', '/apis/rank-tracker-api'] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** *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`, `match`, `not_match`, `ilike`, `not_ilike`, `like`, `not_like` you can use the `%` operator with `like` and `not_like`, as well as `ilike` and `not_ilike` to match any string of zero or more characters example: `['ranked_serp_element.serp_item.rank_group','','paid']]` `[['keyword_data.keyword_info.search_volume','<>',0],'and',[['ranked_serp_element.serp_item.type','<>','paid'],'or',['ranked_serp_element.serp_item.is_malicious','=',false]]]` if you want to get the keywords a particular webpage ranks for, you can use a `[target](/v3/dataforseo_labs/google/ranked_keywords/live/#target)` field or filter by the `ranked_serp_element.serp_item.relative_url` parameter example: `['ranked_serp_element.serp_item.relative_url', '=', '/apis/rank-tracker-api']` for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** 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: ['keyword_data.keyword_info.competition,desc'] default rule: ['ranked_serp_element.serp_item.rank_group,asc'] 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: ['keyword_data.keyword_info.search_volume,desc','keyword_data.keyword_info.cpc,desc'] */
+    /** *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: `['keyword_data.keyword_info.competition,desc']` default rule: `['ranked_serp_element.serp_item.rank_group,asc']` **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: `['keyword_data.keyword_info.search_volume,desc','keyword_data.keyword_info.cpc,desc']` */
     order_by?: 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?: IDataforseoLabsGoogleRankedKeywordsLiveRequestInfo);

package/dist/cjs/models/DataforseoLabsGoogleRankedKeywordsLiveResponseInfo.d.ts

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

package/dist/cjs/models/DataforseoLabsGoogleRankedKeywordsLiveResultInfo.d.ts

@@ -1,52 +1,52 @@
 import { DataforseoLabsGoogleRankedKeywordsLiveItem } from "./DataforseoLabsGoogleRankedKeywordsLiveItem";
 import { DataforseoLabsMetricsInfo } from "./DataforseoLabsMetricsInfo";
 export interface IDataforseoLabsGoogleRankedKeywordsLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** target domain or webpage in a POST array */
+    /** *target domain or webpage in a POST array* */
     target?: string | undefined;
-    /** location code in a POST array if there is no data, then the value is null */
+    /** *location code in a POST array*             if there is no data, then the value is `null` */
     location_code?: number | undefined;
-    /** language code in a POST array if there is no data, then the value is null */
+    /** *language code in a POST array*             if there is no data, then the value is `null` */
     language_code?: string | undefined;
-    /** total number of results in our database relevant to your request */
+    /** *total number of results in our database relevant to your request* */
     total_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** ranking data relevant to the specified domain or webpage  ranking data is provided by the rank_group parameters that show the result’s rank considering only equivalent SERP elements */
+    /** *ranking data relevant to the specified domain or webpage*             ranking data is provided by the `rank_group` parameters that show the result’s rank considering only equivalent SERP elements */
     metrics?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;
-    /** ranking data relevant to the specified domain or webpage ranking data is provided by the rank_absolute parameters that indicate the result’s position among all SERP elements */
+    /** *ranking data relevant to the specified domain or webpage*             ranking data is provided by the `rank_absolute` parameters that indicate the result’s position among all SERP elements */
     metrics_absolute?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;
-    /** contains ranked keywords and related data */
+    /** *contains ranked keywords and related data* */
     items?: DataforseoLabsGoogleRankedKeywordsLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleRankedKeywordsLiveResultInfo implements IDataforseoLabsGoogleRankedKeywordsLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** target domain or webpage in a POST array */
+    /** *target domain or webpage in a POST array* */
     target?: string | undefined;
-    /** location code in a POST array if there is no data, then the value is null */
+    /** *location code in a POST array*             if there is no data, then the value is `null` */
     location_code?: number | undefined;
-    /** language code in a POST array if there is no data, then the value is null */
+    /** *language code in a POST array*             if there is no data, then the value is `null` */
     language_code?: string | undefined;
-    /** total number of results in our database relevant to your request */
+    /** *total number of results in our database relevant to your request* */
     total_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** ranking data relevant to the specified domain or webpage  ranking data is provided by the rank_group parameters that show the result’s rank considering only equivalent SERP elements */
+    /** *ranking data relevant to the specified domain or webpage*             ranking data is provided by the `rank_group` parameters that show the result’s rank considering only equivalent SERP elements */
     metrics?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;
-    /** ranking data relevant to the specified domain or webpage ranking data is provided by the rank_absolute parameters that indicate the result’s position among all SERP elements */
+    /** *ranking data relevant to the specified domain or webpage*             ranking data is provided by the `rank_absolute` parameters that indicate the result’s position among all SERP elements */
     metrics_absolute?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;
-    /** contains ranked keywords and related data */
+    /** *contains ranked keywords and related data* */
     items?: DataforseoLabsGoogleRankedKeywordsLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleRankedKeywordsLiveResultInfo);

package/dist/cjs/models/DataforseoLabsGoogleRankedKeywordsLiveTaskInfo.d.ts

@@ -1,12 +1,12 @@
 import { DataforseoLabsGoogleRankedKeywordsLiveResultInfo } from "./DataforseoLabsGoogleRankedKeywordsLiveResultInfo";
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface IDataforseoLabsGoogleRankedKeywordsLiveTaskInfo extends IBaseResponseTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: DataforseoLabsGoogleRankedKeywordsLiveResultInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleRankedKeywordsLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleRankedKeywordsLiveTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: DataforseoLabsGoogleRankedKeywordsLiveResultInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleRankedKeywordsLiveTaskInfo);

package/dist/cjs/models/DataforseoTrendsDataInfo.d.ts

@@ -1,15 +1,15 @@
 import { DemographyItemValueInfo } from "./DemographyItemValueInfo";
 export interface IDataforseoTrendsDataInfo {
-    /** relevant keyword for which demographic data is provided */
+    /** *relevant keyword for which demographic data is provided* */
     keyword?: string | undefined;
-    /** contains age range and corresponding keyword popularity values */
+    /** *contains age range and corresponding keyword popularity values* */
     values?: DemographyItemValueInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoTrendsDataInfo implements IDataforseoTrendsDataInfo {
-    /** relevant keyword for which demographic data is provided */
+    /** *relevant keyword for which demographic data is provided* */
     keyword?: string | undefined;
-    /** contains age range and corresponding keyword popularity values */
+    /** *contains age range and corresponding keyword popularity values* */
     values?: DemographyItemValueInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoTrendsDataInfo);