dataforseo-client 2.1.2 → 2.1.5

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

@@ -1,62 +1,62 @@
 export interface IDataforseoLabsGoogleKeywordsForSiteLiveRequestInfo {
-    /** target domainrequired fieldthe domain name of the target websitethe domain should be specified without https:// */
+    /** *target domain* **required field** the domain name of the target website the domain should be specified without `https://` */
     target?: string | undefined;
-    /** full name of the locationrequired field if you don't specify location_codeNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample: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;
-    /** unique location identifierrequired field if you don't specify location_nameNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:2840 */
+    /** *unique location identifier* **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 languageoptional fieldif you use this field, you don't need to specify language_codeyou can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:EnglishNote: if omitted, results default to the language with the most keyword records in the specified location;refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
+    /** *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` example: `English` **Note:** if omitted, results default to the language with the most keyword records in the specified location; refer to the `available_languages.keywords` field of the [Locations and Languages endpoint](https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages) to determine the default language */
     language_name?: string | undefined;
-    /** language codeoptional fieldif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:enNote: if omitted, results default to the language with the most keyword records in the specified location;refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
+    /** *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` example: `en` **Note:** if omitted, results default to the language with the most keyword records in the specified location; refer to the `available_languages.keywords` field of the [Locations and Languages endpoint](https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages) to determine the default language */
     language_code?: string | undefined;
-    /** include data from SERP for each keywordoptional fieldif 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 responsedefault 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;
-    /** indicates if the subdomains will be included in the searchoptional fieldif set to false, the subdomains will be ignoreddefault 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;
-    /** include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to_true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the responsedefault value: falsewith this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center articlen */
+    /** *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`, `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)n' */
     include_clickstream_data?: boolean | undefined;
-    /** the maximum number of keywords in the results arrayoptional fielddefault value: 100maximum value: 1000 */
+    /** *the maximum number of keywords in the results array* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned keywordsoptional fielddefault value: 0if 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 keywordsNote: we recommend using this parameter only when retrieving up to 10,000 resultsfor retrieving over 10,000 results, use the offset_token instead. */
+    /** *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 **Note:** we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the `offset_token` instead. */
     offset?: number | undefined;
-    /** offset 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 10,000 results in a single request;by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;offset_token values are unique for each subsequent taskNote: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.learn more about this parameter on our Help Center */
+    /** *offset 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 10,000 results in a single request; by specifying the unique `offset_token` value from the response array, you will get the subsequent results of the initial task; `offset_token` values are unique for each subsequent task **Note:** if the `offset_token` is specified in the request, all other parameters except `limit` will not be taken into account when processing a task. learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token) */
     offset_token?: string | undefined;
-    /** 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, match, not_match, ilike, not_ilike, like, not_likeyou can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more charactersnote that you can not filter the results by relevanceexample:['keyword_info.search_volume','>',0]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 **note that you can not filter the results by `relevance`** example: `['keyword_info.search_volume','>',0]` 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 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 parameterdefault rule:['relevance,desc']relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint.note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:['relevance,desc','keyword_info.search_volume,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 parameter default rule: `['relevance,desc']` relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. **Note** that `relevance` is only our internal system identifier, so **it can not be used as a filter**, and you will not find this field in the `result` array. The relevance score is based on a similar principle as used in [the Keywords For Keywords](/v3/keywords_data/google/keywords_for_keywords/live/?php) endpoint.**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: `['relevance,desc','keyword_info.search_volume,desc']` */
     order_by?: string[] | undefined;
-    /** 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 */
+    /** *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 DataforseoLabsGoogleKeywordsForSiteLiveRequestInfo implements IDataforseoLabsGoogleKeywordsForSiteLiveRequestInfo {
-    /** target domainrequired fieldthe domain name of the target websitethe domain should be specified without https:// */
+    /** *target domain* **required field** the domain name of the target website the domain should be specified without `https://` */
     target?: string | undefined;
-    /** full name of the locationrequired field if you don't specify location_codeNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample: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;
-    /** unique location identifierrequired field if you don't specify location_nameNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:2840 */
+    /** *unique location identifier* **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 languageoptional fieldif you use this field, you don't need to specify language_codeyou can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:EnglishNote: if omitted, results default to the language with the most keyword records in the specified location;refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
+    /** *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` example: `English` **Note:** if omitted, results default to the language with the most keyword records in the specified location; refer to the `available_languages.keywords` field of the [Locations and Languages endpoint](https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages) to determine the default language */
     language_name?: string | undefined;
-    /** language codeoptional fieldif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:enNote: if omitted, results default to the language with the most keyword records in the specified location;refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
+    /** *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` example: `en` **Note:** if omitted, results default to the language with the most keyword records in the specified location; refer to the `available_languages.keywords` field of the [Locations and Languages endpoint](https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages) to determine the default language */
     language_code?: string | undefined;
-    /** include data from SERP for each keywordoptional fieldif 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 responsedefault 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;
-    /** indicates if the subdomains will be included in the searchoptional fieldif set to false, the subdomains will be ignoreddefault 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;
-    /** include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to_true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the responsedefault value: falsewith this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center articlen */
+    /** *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`, `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)n' */
     include_clickstream_data?: boolean | undefined;
-    /** the maximum number of keywords in the results arrayoptional fielddefault value: 100maximum value: 1000 */
+    /** *the maximum number of keywords in the results array* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned keywordsoptional fielddefault value: 0if 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 keywordsNote: we recommend using this parameter only when retrieving up to 10,000 resultsfor retrieving over 10,000 results, use the offset_token instead. */
+    /** *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 **Note:** we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the `offset_token` instead. */
     offset?: number | undefined;
-    /** offset 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 10,000 results in a single request;by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;offset_token values are unique for each subsequent taskNote: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.learn more about this parameter on our Help Center */
+    /** *offset 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 10,000 results in a single request; by specifying the unique `offset_token` value from the response array, you will get the subsequent results of the initial task; `offset_token` values are unique for each subsequent task **Note:** if the `offset_token` is specified in the request, all other parameters except `limit` will not be taken into account when processing a task. learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token) */
     offset_token?: string | undefined;
-    /** 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, match, not_match, ilike, not_ilike, like, not_likeyou can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more charactersnote that you can not filter the results by relevanceexample:['keyword_info.search_volume','>',0]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 **note that you can not filter the results by `relevance`** example: `['keyword_info.search_volume','>',0]` 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 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 parameterdefault rule:['relevance,desc']relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint.note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:['relevance,desc','keyword_info.search_volume,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 parameter default rule: `['relevance,desc']` relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. **Note** that `relevance` is only our internal system identifier, so **it can not be used as a filter**, and you will not find this field in the `result` array. The relevance score is based on a similar principle as used in [the Keywords For Keywords](/v3/keywords_data/google/keywords_for_keywords/live/?php) endpoint.**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: `['relevance,desc','keyword_info.search_volume,desc']` */
     order_by?: string[] | undefined;
-    /** 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 */
+    /** *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?: IDataforseoLabsGoogleKeywordsForSiteLiveRequestInfo);

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

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

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

@@ -1,43 +1,43 @@
 import { KeywordDataInfo } from "./KeywordDataInfo";
 export interface IDataforseoLabsGoogleKeywordsForSiteLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** target domain in a POST array */
+    /** *target domain in a POST array* */
     target?: 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 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;
-    /** current offset value */
+    /** *current offset value* */
     offset?: number | undefined;
-    /** offset token for subsequent requestsyou can use the string provided in this field to get the subsequent results of the initial task;note: offset_token values are unique for each subsequent task */
+    /** *offset token for subsequent requests* you can use the string provided in this field to get the subsequent results of the initial task; **note:** `offset_token` values are unique for each subsequent task */
     offset_token?: string | undefined;
-    /** contains keyword ideas and related data */
+    /** *contains keyword ideas and related data* */
     items?: KeywordDataInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordsForSiteLiveResultInfo implements IDataforseoLabsGoogleKeywordsForSiteLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** target domain in a POST array */
+    /** *target domain in a POST array* */
     target?: 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 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;
-    /** current offset value */
+    /** *current offset value* */
     offset?: number | undefined;
-    /** offset token for subsequent requestsyou can use the string provided in this field to get the subsequent results of the initial task;note: offset_token values are unique for each subsequent task */
+    /** *offset token for subsequent requests* you can use the string provided in this field to get the subsequent results of the initial task; **note:** `offset_token` values are unique for each subsequent task */
     offset_token?: string | undefined;
-    /** contains keyword ideas and related data */
+    /** *contains keyword ideas and related data* */
     items?: KeywordDataInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordsForSiteLiveResultInfo);

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

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

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

@@ -1,22 +1,22 @@
 import { KeywordDataInfo } from "./KeywordDataInfo";
 import { BaseDataforseoLabsApiElementItem } from "./BaseDataforseoLabsApiElementItem";
 export interface IDataforseoLabsGooglePageIntersectionLiveItem {
-    /** 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 SERP elements found for the returned keyword data will be provided in separate arrays for each URL you specified in the pages object when setting a task; depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively */
+    /** *contains data on the SERP elements found for the returned `keyword`* data will be provided in separate arrays for each URL you specified in the `pages` object when setting a task; depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively */
     intersection_result?: {
         [key: string]: BaseDataforseoLabsApiElementItem;
     } | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGooglePageIntersectionLiveItem implements IDataforseoLabsGooglePageIntersectionLiveItem {
-    /** 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 SERP elements found for the returned keyword data will be provided in separate arrays for each URL you specified in the pages object when setting a task; depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively */
+    /** *contains data on the SERP elements found for the returned `keyword`* data will be provided in separate arrays for each URL you specified in the `pages` object when setting a task; depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively */
     intersection_result?: {
         [key: string]: BaseDataforseoLabsApiElementItem;
     } | undefined;

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);