dataforseo-client 2.1.1 → 2.1.3

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

@@ -1,35 +1,35 @@
 import { DataforseoLabsGoogleKeywordsForAppLiveItem } from "./DataforseoLabsGoogleKeywordsForAppLiveItem";
 export interface IDataforseoLabsGoogleKeywordsForAppLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** id of the app in a POST array */
+    /** *id of the app in a POST array* */
     app_id?: 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 data related to the ranking keywords for the app specified in the app_id field */
+    /** *contains data related to the ranking keywords for the app specified in the `app_id` field* */
     items?: DataforseoLabsGoogleKeywordsForAppLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordsForAppLiveResultInfo implements IDataforseoLabsGoogleKeywordsForAppLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** id of the app in a POST array */
+    /** *id of the app in a POST array* */
     app_id?: 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 data related to the ranking keywords for the app specified in the app_id field */
+    /** *contains data related to the ranking keywords for the app specified in the `app_id` field* */
     items?: DataforseoLabsGoogleKeywordsForAppLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordsForAppLiveResultInfo);

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

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

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

@@ -1,66 +1,66 @@
 export interface IDataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo {
-    /** product and service categories required field The maximum number of categories you can specify: 20 you can download the full list of possible categories */
+    /** product and service categoriesrequired fieldThe maximum number of categories you can specify: 20you can download the full list of possible categories */
     category_codes?: 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 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 */
     location_name?: string | undefined;
-    /** 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 */
+    /** 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 */
     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 languagerequired field if you don't specify language_codeNote: it is required to specify either language_name or 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:English */
     language_name?: string | undefined;
-    /** unique language identifier 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 */
+    /** unique language identifierrequired field if you don't specify language_nameNote: it is required to specify either language_name or language_codeyou 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:en */
     language_code?: string | undefined;
-    /** category intersections optional field if set to true, you will get keywords featured in all specified categories; if set to false, you will keywords that are specified in any of the specified categories; default value: true */
+    /** category intersectionsoptional fieldif set to true, you will get keywords featured in all specified categories;if set to false, you will keywords that are specified in any of the specified categories;default value: true */
     category_intersection?: boolean | 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 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_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, 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 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 article */
     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 keywordsoptional fieldif set to true only core keywords will be returned, all highly similar keywords will be excluded;default value: false */
     ignore_synonyms?: boolean | undefined;
-    /** the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000 */
+    /** the maximum number of keywords in the results arrayoptional fielddefault value: 100maximum 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 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 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?: number | undefined;
-    /** 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 */
+    /** 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?: 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, not_ilike to match any string of zero or more characters example: ['keyword_info.search_volume','>',0] [['keyword_info.search_volume','in',[0,1000]], 'and', ['keyword_info.competition_level','=','LOW']] [['keyword_info.search_volume','>',100], 'and', [['keyword_info.cpc','<',0.5], 'or', ['keyword_info.high_top_of_page_bid','<=',0.5]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** 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, not_ilike to match any string of zero or more charactersexample:['keyword_info.search_volume','>',0][['keyword_info.search_volume','in',[0,1000]],'and',['keyword_info.competition_level','=','LOW']][['keyword_info.search_volume','>',100],'and',[['keyword_info.cpc','<',0.5],'or',['keyword_info.high_top_of_page_bid','<=',0.5]]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide */
     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_info.competition,desc'] default rule: ['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: ['keyword_info.search_volume,desc','keyword_info.competition,asc'] */
+    /** results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending orderyou should use a comma to set up a sorting typeexample:['keyword_info.competition,desc']default rule:['keyword_info.search_volume,desc']note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:['keyword_info.search_volume,desc','keyword_info.competition,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 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 */
     tag?: string | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo implements IDataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo {
-    /** product and service categories required field The maximum number of categories you can specify: 20 you can download the full list of possible categories */
+    /** product and service categoriesrequired fieldThe maximum number of categories you can specify: 20you can download the full list of possible categories */
     category_codes?: 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 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 */
     location_name?: string | undefined;
-    /** 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 */
+    /** 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 */
     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 languagerequired field if you don't specify language_codeNote: it is required to specify either language_name or 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:English */
     language_name?: string | undefined;
-    /** unique language identifier 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 */
+    /** unique language identifierrequired field if you don't specify language_nameNote: it is required to specify either language_name or language_codeyou 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:en */
     language_code?: string | undefined;
-    /** category intersections optional field if set to true, you will get keywords featured in all specified categories; if set to false, you will keywords that are specified in any of the specified categories; default value: true */
+    /** category intersectionsoptional fieldif set to true, you will get keywords featured in all specified categories;if set to false, you will keywords that are specified in any of the specified categories;default value: true */
     category_intersection?: boolean | 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 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_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, 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 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 article */
     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 keywordsoptional fieldif set to true only core keywords will be returned, all highly similar keywords will be excluded;default value: false */
     ignore_synonyms?: boolean | undefined;
-    /** the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000 */
+    /** the maximum number of keywords in the results arrayoptional fielddefault value: 100maximum 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 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 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?: number | undefined;
-    /** 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 */
+    /** 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?: 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, not_ilike to match any string of zero or more characters example: ['keyword_info.search_volume','>',0] [['keyword_info.search_volume','in',[0,1000]], 'and', ['keyword_info.competition_level','=','LOW']] [['keyword_info.search_volume','>',100], 'and', [['keyword_info.cpc','<',0.5], 'or', ['keyword_info.high_top_of_page_bid','<=',0.5]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** 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, not_ilike to match any string of zero or more charactersexample:['keyword_info.search_volume','>',0][['keyword_info.search_volume','in',[0,1000]],'and',['keyword_info.competition_level','=','LOW']][['keyword_info.search_volume','>',100],'and',[['keyword_info.cpc','<',0.5],'or',['keyword_info.high_top_of_page_bid','<=',0.5]]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide */
     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_info.competition,desc'] default rule: ['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: ['keyword_info.search_volume,desc','keyword_info.competition,asc'] */
+    /** results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending orderyou should use a comma to set up a sorting typeexample:['keyword_info.competition,desc']default rule:['keyword_info.search_volume,desc']note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:['keyword_info.search_volume,desc','keyword_info.competition,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 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 */
     tag?: string | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo);

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

@@ -14,7 +14,7 @@ export interface IDataforseoLabsGoogleKeywordsForCategoriesLiveResultInfo {
     items_count?: number | undefined;
     /** current offset value */
     offset?: number | undefined;
-    /** 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 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?: string | undefined;
     /** contains keyword ideas and related data */
     items?: KeywordDataInfo[] | undefined;
@@ -35,7 +35,7 @@ export declare class DataforseoLabsGoogleKeywordsForCategoriesLiveResultInfo imp
     items_count?: number | undefined;
     /** current offset value */
     offset?: number | undefined;
-    /** 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 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?: string | undefined;
     /** contains keyword ideas and related data */
     items?: KeywordDataInfo[] | undefined;

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

@@ -1,62 +1,62 @@
 export interface IDataforseoLabsGoogleKeywordsForSiteLiveRequestInfo {
-    /** target domain required field the domain name of the target website the domain should be specified without https:// */
+    /** target domainrequired fieldthe domain name of the target websitethe domain should be specified without https:// */
     target?: 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 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 */
     location_name?: string | undefined;
-    /** 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 */
+    /** 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 */
     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 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 to determine the default language */
+    /** 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 */
     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 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 to determine the default language */
+    /** 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?: 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 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_serp_info?: boolean | 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 searchoptional fieldif set to false, the subdomains will be ignoreddefault value: true */
     include_subdomains?: 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, 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 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_clickstream_data?: boolean | undefined;
-    /** the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000 */
+    /** the maximum number of keywords in the results arrayoptional fielddefault value: 100maximum 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 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 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?: number | undefined;
-    /** 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 */
+    /** 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?: 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 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 or this help center guide */
+    /** 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 */
     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 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 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'] */
+    /** 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'] */
     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 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 */
     tag?: string | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordsForSiteLiveRequestInfo implements IDataforseoLabsGoogleKeywordsForSiteLiveRequestInfo {
-    /** target domain required field the domain name of the target website the domain should be specified without https:// */
+    /** target domainrequired fieldthe domain name of the target websitethe domain should be specified without https:// */
     target?: 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 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 */
     location_name?: string | undefined;
-    /** 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 */
+    /** 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 */
     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 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 to determine the default language */
+    /** 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 */
     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 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 to determine the default language */
+    /** 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?: 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 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_serp_info?: boolean | 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 searchoptional fieldif set to false, the subdomains will be ignoreddefault value: true */
     include_subdomains?: 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, 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 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_clickstream_data?: boolean | undefined;
-    /** the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000 */
+    /** the maximum number of keywords in the results arrayoptional fielddefault value: 100maximum 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 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 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?: number | undefined;
-    /** 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 */
+    /** 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?: 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 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 or this help center guide */
+    /** 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 */
     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 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 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'] */
+    /** 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'] */
     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 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 */
     tag?: string | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordsForSiteLiveRequestInfo);

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

@@ -14,7 +14,7 @@ export interface IDataforseoLabsGoogleKeywordsForSiteLiveResultInfo {
     items_count?: number | undefined;
     /** current offset value */
     offset?: number | undefined;
-    /** 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 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?: string | undefined;
     /** contains keyword ideas and related data */
     items?: KeywordDataInfo[] | undefined;
@@ -35,7 +35,7 @@ export declare class DataforseoLabsGoogleKeywordsForSiteLiveResultInfo implement
     items_count?: number | undefined;
     /** current offset value */
     offset?: number | undefined;
-    /** 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 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?: string | undefined;
     /** contains keyword ideas and related data */
     items?: KeywordDataInfo[] | undefined;

package/dist/esm/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;