dataforseo-client 2.1.1 → 2.1.2

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

@@ -1,49 +1,49 @@
 import { DataforseoLabsMetricsInfo } from "./DataforseoLabsMetricsInfo";
 export interface IDataforseoLabsGoogleCompetitorsDomainLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** domain name */
+    /** *domain name* */
     domain?: string | undefined;
-    /** average position of the domain in SERP Note: average position is calculated for intersected keywords only; the value for a given domain may differ when combined with different target websites */
+    /** *average position of the domain in SERP* **Note:** average position is calculated for intersected keywords only; the value for a given domain may differ when combined with different target websites */
     avg_position?: number | undefined;
-    /** sum of all domain positions in SERP Note: average position is calculated for intersected keywords only; the value for a given domain may differ when combined with different target websites */
+    /** *sum of all domain positions in SERP* **Note:** average position is calculated for intersected keywords only; the value for a given domain may differ when combined with different target websites */
     sum_position?: number | undefined;
-    /** number of intersecting keywords */
+    /** *number of intersecting keywords* */
     intersections?: number | undefined;
-    /** metrics for all keywords of the domain full overview of ranking and traffic data relevant to all keywords that the provided domain is ranking for */
+    /** *metrics for all keywords of the domain* full overview of ranking and traffic data relevant to all keywords that the provided `domain` is ranking for */
     full_domain_metrics?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;
-    /** metrics for intersecting keywords ranking and traffic data relevant to the keywords that the provided domain shares with the target domain note: in this array ranking and traffic data is provided for the target considering the keywords target shares in search with the competitor’s domain */
+    /** *metrics for intersecting keywords* ranking and traffic data relevant to the keywords that the provided `domain` shares with the `target` domain **note:** in this array ranking and traffic data is provided for the `target` considering the keywords `target` shares in search with the competitor's `domain` */
     metrics?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;
-    /** metrics for intersecting keywords ranking and traffic data relevant to the keywords that the provided domain shares with the target domain note: in this array ranking and traffic data is provided for the returned competitor’s domain */
+    /** *metrics for intersecting keywords* ranking and traffic data relevant to the keywords that the provided `domain` shares with the `target` domain **note:** in this array ranking and traffic data is provided for the returned competitor's `domain` */
     competitor_metrics?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleCompetitorsDomainLiveItem implements IDataforseoLabsGoogleCompetitorsDomainLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** domain name */
+    /** *domain name* */
     domain?: string | undefined;
-    /** average position of the domain in SERP Note: average position is calculated for intersected keywords only; the value for a given domain may differ when combined with different target websites */
+    /** *average position of the domain in SERP* **Note:** average position is calculated for intersected keywords only; the value for a given domain may differ when combined with different target websites */
     avg_position?: number | undefined;
-    /** sum of all domain positions in SERP Note: average position is calculated for intersected keywords only; the value for a given domain may differ when combined with different target websites */
+    /** *sum of all domain positions in SERP* **Note:** average position is calculated for intersected keywords only; the value for a given domain may differ when combined with different target websites */
     sum_position?: number | undefined;
-    /** number of intersecting keywords */
+    /** *number of intersecting keywords* */
     intersections?: number | undefined;
-    /** metrics for all keywords of the domain full overview of ranking and traffic data relevant to all keywords that the provided domain is ranking for */
+    /** *metrics for all keywords of the domain* full overview of ranking and traffic data relevant to all keywords that the provided `domain` is ranking for */
     full_domain_metrics?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;
-    /** metrics for intersecting keywords ranking and traffic data relevant to the keywords that the provided domain shares with the target domain note: in this array ranking and traffic data is provided for the target considering the keywords target shares in search with the competitor’s domain */
+    /** *metrics for intersecting keywords* ranking and traffic data relevant to the keywords that the provided `domain` shares with the `target` domain **note:** in this array ranking and traffic data is provided for the `target` considering the keywords `target` shares in search with the competitor's `domain` */
     metrics?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;
-    /** metrics for intersecting keywords ranking and traffic data relevant to the keywords that the provided domain shares with the target domain note: in this array ranking and traffic data is provided for the returned competitor’s domain */
+    /** *metrics for intersecting keywords* ranking and traffic data relevant to the keywords that the provided `domain` shares with the `target` domain **note:** in this array ranking and traffic data is provided for the returned competitor's `domain` */
     competitor_metrics?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;

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

@@ -1,74 +1,74 @@
 export interface IDataforseoLabsGoogleCompetitorsDomainLiveRequestInfo {
-    /** domain required field the domain name of the target website the domain should be specified without https:// and www. you can specify page URL, but the results will be specific to the domain in the specified URL */
+    /** *domain* **required field** the domain name of the target website the domain should be specified without `https://` and `www.` you can specify page URL, but the results will be specific to the domain in the specified URL */
     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 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;
-    /** display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: ['organic', 'paid', 'featured_snippet', 'local_pack'] default value: ['organic', 'paid'] */
+    /** *display results by item type* optional field indicates the type of search results included in the response **Note:** if the `item_types` array contains item types that are different from `organic`, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values:  `['organic', 'paid', 'featured_snippet', 'local_pack']` default value:  `['organic', 'paid']` */
     item_types?: string[] | undefined;
-    /** include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data 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_etv`, `clickstream_gender_distribution`, and_`clickstream_age_distribution`_fields with clickstream data 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;
-    /** 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 example: ['metrics.organic.count','>',50] [[['metrics.organic.count','>=',50],'and',['metrics.organic.pos_1','in',[1,5]]], 'or', ['metrics.organic.etv','>=','100']] 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` example: `['metrics.organic.count','>',50]` `[[['metrics.organic.count','>=',50],'and',['metrics.organic.pos_1','in',[1,5]]],'or',['metrics.organic.etv','>=','100']]` 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 specify a sorting type example: ['metrics.paid.etv,asc'] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ['metrics.organic.etv,desc','metrics.paid.count,asc'] default rule: ['metrics.organic.count,desc'] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array */
+    /** *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 specify a sorting type example: `['metrics.paid.etv,asc']` **Note:** you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: `['metrics.organic.etv,desc','metrics.paid.count,asc']` default rule: `['metrics.organic.count,desc']` **Note:** if the `item_types` array contains item types that are different from `organic`, the results will be ordered by the first item type in the array */
     order_by?: string[] | undefined;
-    /** the maximum number of returned domains optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned domains* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
+    /** *offset in the results array of returned domains* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
     offset?: number | undefined;
-    /** maximum rank up to which competitors will be considered optional field default value: 100 if you specify 10 here, we will extract competitors from the top 10 Google search results only */
+    /** *maximum rank up to which competitors will be considered* optional field default value: `100` if you specify `10` here, we will extract competitors from the top 10 Google search results only */
     max_rank_group?: number | undefined;
-    /** indicates whether to exclude world’s largest websites optional field default value: false set to true if you want to get highly-relevant competitors excluding the websites listed below: wikipedia.org pinterest.com amazon.com google.com facebook.com wordpress.com medium.com quora.com reddit.com youtube.com ebay.com uol.com.br instagram.com olx.com twitter.com linkedin.com slideshare.net */
+    /** *indicates whether to exclude world's largest websites* optional field default value: `false` set to `true` if you want to get highly-relevant competitors excluding the websites listed below: `wikipedia.orgpinterest.comamazon.comgoogle.comfacebook.comwordpress.commedium.comquora.comreddit.comyoutube.comebay.comuol.com.brinstagram.comolx.comtwitter.comlinkedin.comslideshare.net` */
     exclude_top_domains?: boolean | undefined;
-    /** exclude domains from the results optional field use this parameter to exclude specific domains from the results Note: you can specify up to 1000 domains in this array example: 'exclude_domains': [ 'reddit.com', 'youtube.com' ] */
+    /** *exclude domains from the results* optional field use this parameter to exclude specific domains from the results **Note:** you can specify up to 1000 domains in this array example: `'exclude_domains': ['reddit.com','youtube.com']` */
     exclude_domains?: string[] | undefined;
-    /** additional domains for improving results accuracy optional field to improve the accuracy of the result, you can specify domains that are known to intersect with the target in SERPs; if you use this array, metrics in the result will be based on SERPs where both target website and intersecting_domains appear; Note: you can specify up to 20 domains in this array */
+    /** *additional domains for improving results accuracy* optional field to improve the accuracy of the result, you can specify domains that are known to intersect with the `target` in SERPs; if you use this array, metrics in the result will be based on SERPs where both `target` website and `intersecting_domains` appear; **Note:** you can specify up to 20 domains in this array */
     intersecting_domains?: string[] | undefined;
-    /** ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to_`true`, only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false`n */
     ignore_synonyms?: boolean | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleCompetitorsDomainLiveRequestInfo implements IDataforseoLabsGoogleCompetitorsDomainLiveRequestInfo {
-    /** domain required field the domain name of the target website the domain should be specified without https:// and www. you can specify page URL, but the results will be specific to the domain in the specified URL */
+    /** *domain* **required field** the domain name of the target website the domain should be specified without `https://` and `www.` you can specify page URL, but the results will be specific to the domain in the specified URL */
     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 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;
-    /** display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: ['organic', 'paid', 'featured_snippet', 'local_pack'] default value: ['organic', 'paid'] */
+    /** *display results by item type* optional field indicates the type of search results included in the response **Note:** if the `item_types` array contains item types that are different from `organic`, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values:  `['organic', 'paid', 'featured_snippet', 'local_pack']` default value:  `['organic', 'paid']` */
     item_types?: string[] | undefined;
-    /** include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data 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_etv`, `clickstream_gender_distribution`, and_`clickstream_age_distribution`_fields with clickstream data 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;
-    /** 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 example: ['metrics.organic.count','>',50] [[['metrics.organic.count','>=',50],'and',['metrics.organic.pos_1','in',[1,5]]], 'or', ['metrics.organic.etv','>=','100']] 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` example: `['metrics.organic.count','>',50]` `[[['metrics.organic.count','>=',50],'and',['metrics.organic.pos_1','in',[1,5]]],'or',['metrics.organic.etv','>=','100']]` 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 specify a sorting type example: ['metrics.paid.etv,asc'] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ['metrics.organic.etv,desc','metrics.paid.count,asc'] default rule: ['metrics.organic.count,desc'] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array */
+    /** *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 specify a sorting type example: `['metrics.paid.etv,asc']` **Note:** you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: `['metrics.organic.etv,desc','metrics.paid.count,asc']` default rule: `['metrics.organic.count,desc']` **Note:** if the `item_types` array contains item types that are different from `organic`, the results will be ordered by the first item type in the array */
     order_by?: string[] | undefined;
-    /** the maximum number of returned domains optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned domains* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
+    /** *offset in the results array of returned domains* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
     offset?: number | undefined;
-    /** maximum rank up to which competitors will be considered optional field default value: 100 if you specify 10 here, we will extract competitors from the top 10 Google search results only */
+    /** *maximum rank up to which competitors will be considered* optional field default value: `100` if you specify `10` here, we will extract competitors from the top 10 Google search results only */
     max_rank_group?: number | undefined;
-    /** indicates whether to exclude world’s largest websites optional field default value: false set to true if you want to get highly-relevant competitors excluding the websites listed below: wikipedia.org pinterest.com amazon.com google.com facebook.com wordpress.com medium.com quora.com reddit.com youtube.com ebay.com uol.com.br instagram.com olx.com twitter.com linkedin.com slideshare.net */
+    /** *indicates whether to exclude world's largest websites* optional field default value: `false` set to `true` if you want to get highly-relevant competitors excluding the websites listed below: `wikipedia.orgpinterest.comamazon.comgoogle.comfacebook.comwordpress.commedium.comquora.comreddit.comyoutube.comebay.comuol.com.brinstagram.comolx.comtwitter.comlinkedin.comslideshare.net` */
     exclude_top_domains?: boolean | undefined;
-    /** exclude domains from the results optional field use this parameter to exclude specific domains from the results Note: you can specify up to 1000 domains in this array example: 'exclude_domains': [ 'reddit.com', 'youtube.com' ] */
+    /** *exclude domains from the results* optional field use this parameter to exclude specific domains from the results **Note:** you can specify up to 1000 domains in this array example: `'exclude_domains': ['reddit.com','youtube.com']` */
     exclude_domains?: string[] | undefined;
-    /** additional domains for improving results accuracy optional field to improve the accuracy of the result, you can specify domains that are known to intersect with the target in SERPs; if you use this array, metrics in the result will be based on SERPs where both target website and intersecting_domains appear; Note: you can specify up to 20 domains in this array */
+    /** *additional domains for improving results accuracy* optional field to improve the accuracy of the result, you can specify domains that are known to intersect with the `target` in SERPs; if you use this array, metrics in the result will be based on SERPs where both `target` website and `intersecting_domains` appear; **Note:** you can specify up to 20 domains in this array */
     intersecting_domains?: string[] | undefined;
-    /** ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to_`true`, only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false`n */
     ignore_synonyms?: boolean | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleCompetitorsDomainLiveRequestInfo);

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

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

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

@@ -1,35 +1,35 @@
 import { DataforseoLabsGoogleCompetitorsDomainLiveItem } from "./DataforseoLabsGoogleCompetitorsDomainLiveItem";
 export interface IDataforseoLabsGoogleCompetitorsDomainLiveResultInfo {
-    /** 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 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 target and competitor domains */
+    /** *contains data related to the `target` and competitor domains* */
     items?: DataforseoLabsGoogleCompetitorsDomainLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleCompetitorsDomainLiveResultInfo implements IDataforseoLabsGoogleCompetitorsDomainLiveResultInfo {
-    /** 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 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 target and competitor domains */
+    /** *contains data related to the `target` and competitor domains* */
     items?: DataforseoLabsGoogleCompetitorsDomainLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleCompetitorsDomainLiveResultInfo);

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

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

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

@@ -1,57 +1,57 @@
 import { DataforseoLabsMetricsInfo } from "./DataforseoLabsMetricsInfo";
 export interface IDataforseoLabsGoogleDomainMetricsByCategoriesLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** categories for which domains are collected */
+    /** *categories for which domains are collected* */
     top_categories?: number[] | undefined;
-    /** current organic ETV of the domain */
+    /** *current organic ETV of the domain* */
     organic_etv?: number | undefined;
-    /** current total count of organic SERPs that contain the domain */
+    /** *current total count of organic SERPs that contain the domain* */
     organic_count?: number | undefined;
-    /** current number of lost ranked elements indicates how many ranked elements of the domain were previously presented in SERPs, but weren’t found during the last check */
+    /** *current number of lost ranked elements* indicates how many ranked elements of the domain were previously presented in SERPs, but weren’t found during the last check */
     organic_is_lost?: number | undefined;
-    /** current number of new ranked elements indicates how many new ranked elements were found for the domain */
+    /** *current number of new ranked elements* indicates how many new ranked elements were found for the domain */
     organic_is_new?: number | undefined;
-    /** domain found for the specified category */
+    /** *domain found for the specified category* */
     domain?: string | undefined;
-    /** primary domain */
+    /** *primary domain* */
     main_domain?: string | undefined;
-    /** historical ranking and traffic data of the domain */
+    /** *historical ranking and traffic data of the domain* */
     metrics_history?: {
         [key: string]: {
             [key: string]: DataforseoLabsMetricsInfo;
         };
     } | undefined;
-    /** metrics difference between first_date and second_date calculated by subtracting domain metrics as of the greater date from domain metrics as of the smaller date */
+    /** *metrics difference between `first_date` and `second_date`* calculated by subtracting domain metrics as of the greater date from domain metrics as of the smaller date */
     metrics_difference?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleDomainMetricsByCategoriesLiveItem implements IDataforseoLabsGoogleDomainMetricsByCategoriesLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** categories for which domains are collected */
+    /** *categories for which domains are collected* */
     top_categories?: number[] | undefined;
-    /** current organic ETV of the domain */
+    /** *current organic ETV of the domain* */
     organic_etv?: number | undefined;
-    /** current total count of organic SERPs that contain the domain */
+    /** *current total count of organic SERPs that contain the domain* */
     organic_count?: number | undefined;
-    /** current number of lost ranked elements indicates how many ranked elements of the domain were previously presented in SERPs, but weren’t found during the last check */
+    /** *current number of lost ranked elements* indicates how many ranked elements of the domain were previously presented in SERPs, but weren’t found during the last check */
     organic_is_lost?: number | undefined;
-    /** current number of new ranked elements indicates how many new ranked elements were found for the domain */
+    /** *current number of new ranked elements* indicates how many new ranked elements were found for the domain */
     organic_is_new?: number | undefined;
-    /** domain found for the specified category */
+    /** *domain found for the specified category* */
     domain?: string | undefined;
-    /** primary domain */
+    /** *primary domain* */
     main_domain?: string | undefined;
-    /** historical ranking and traffic data of the domain */
+    /** *historical ranking and traffic data of the domain* */
     metrics_history?: {
         [key: string]: {
             [key: string]: DataforseoLabsMetricsInfo;
         };
     } | undefined;
-    /** metrics difference between first_date and second_date calculated by subtracting domain metrics as of the greater date from domain metrics as of the smaller date */
+    /** *metrics difference between `first_date` and `second_date`* calculated by subtracting domain metrics as of the greater date from domain metrics as of the smaller date */
     metrics_difference?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;

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

@@ -1,78 +1,78 @@
 export interface IDataforseoLabsGoogleDomainMetricsByCategoriesLiveRequestInfo {
-    /** product and service categories required field The maximum number of categories you can specify: 5 you can download the full list of possible categories */
+    /** *product and service categories* **required field** The maximum number of categories you can specify: 5 you can download [the full list of possible categories](https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv) */
     category_codes?: string[] | undefined;
-    /** first date of comparison period required field first date for which domain metrics will be provided; date format: 'yyyy-mm-dd'; example: '2021-06-01'; the list available dates is available through the available history endpoint; Note: first_date cannot be greater than today’s date; Also note: the dates specified in first_date and second_date cannot point to the same month of the same year; you can specify the dates in any order: first_date can be greater than second_date and vice versa; minimum date: '2020-10-01' */
+    /** *first date of comparison period* **required field** first date for which domain metrics will be provided; date format: `'yyyy-mm-dd'`; example: `'2021-06-01'`; the list available dates is available through the [available history endpoint](/v3/dataforseo_labs/google/available_history/live/); **Note:** `first_date` cannot be greater than today's date; **Also note:** the dates specified in `first_date` and `second_date` cannot point to the same month of the same year; you can specify the dates in any order: `first_date` can be greater than `second_date` and vice versa; minimum date: `'2020-10-01'` */
     first_date?: string | undefined;
-    /** second date of comparison period required field second date for which domain metrics will be provided; date format: 'yyyy-mm-dd'; example: '2021-10-01'; the list available dates is available through the available history endpoint; Note: second_date cannot be greater than today’s date; Also note: the dates specified in first_date and second_date cannot point to the same month of the same year; you can specify the dates in any order: second_date can be greater than first_date and vice versa; minimum date: '2020-10-01' */
+    /** *second date of comparison period* **required field** second date for which domain metrics will be provided; date format: `'yyyy-mm-dd'`; example: `'2021-10-01'`; the list available dates is available through the [available history endpoint](/v3/dataforseo_labs/google/available_history/live/); **Note:** `second_date` cannot be greater than today's date; **Also note:** the dates specified in `first_date` and `second_date` cannot point to the same month of the same year; you can specify the dates in any order: `second_date` can be greater than `first_date` and vice versa; minimum date: `'2020-10-01'` */
     second_date?: 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 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 `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; example: `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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; example: 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 `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 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 `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; example: `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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; example: en */
+    /** *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 `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; example: `en` */
     language_code?: string | undefined;
-    /** display results by item type optional field indicates the type of search results included in the response; Note: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: ['organic', 'paid', 'featured_snippet', 'local_pack']; default value: ['organic', 'paid'] */
+    /** *display results by item type* optional field indicates the type of search results included in the response; **Note:** if the `item_types` array contains item types that are different from the `organic` object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values:  `['organic', 'paid', 'featured_snippet', 'local_pack']`; default value:  `['organic', 'paid']` */
     item_types?: string[] | undefined;
-    /** number of additional domain categories optional field by using this parameter, you can receive domains relevant to additional categories that are not specified in category_codes above; to learn more about the parameter, please refer to this help center article; by default, top_categories_count is equal to the number of categories specified in the category_codes array; Note: top_categories_count cannot be less than the number of categories in the category_codes array; maximum value: 5 */
+    /** *number of additional domain categories* optional field by using this parameter, you can receive domains relevant to additional categories that are not specified in `category_codes` above; to learn more about the parameter, please refer to [this help center article;](https://dataforseo.com/help-center/what-is-top_categories_count) by default, `top_categories_count` is equal to the number of categories specified in the `category_codes` array; **Note:** `top_categories_count` cannot be less than the number of categories in the `category_codes` array; maximum value: `5` */
     top_categories_count?: number | undefined;
-    /** return subdomains in the API response optional field if false, the API response will contain main_domain only; if true, the API will return main_domain plus its subdomains (if available); default value: true */
+    /** *return subdomains in the API response* optional field if `false`, the API response will contain `main_domain` only; if `true`, the API will return `main_domain` plus its subdomains (if available); default value: `true` */
     include_subdomains?: boolean | undefined;
-    /** minimum current organic ETV of the domain optional field if specified, the API will return only domains with organic_etv greater than the specified value */
+    /** *minimum current organic ETV of the domain* optional field if specified, the API will return only domains with `organic_etv` greater than the specified value */
     etv_min?: number | undefined;
-    /** maximum current organic ETV of the domain optional field if specified, the API will return only domains with organic_etv lesser than the specified value */
+    /** *maximum current organic ETV of the domain* optional field if specified, the API will return only domains with `organic_etv` lesser than the specified value */
     etv_max?: number | undefined;
-    /** correlate data with previously obtained datasets optional field default value: true; if you use this parameter, our system will correlate data you obtain now with previously obtained datasets; this parameter is intended to mitigate any inconsistencies that may result from changes to our database; Note: we do not recommend setting correlate to false */
+    /** *correlate data with previously obtained datasets* optional field default value: `true`; if you use this parameter, our system will correlate data you obtain now with previously obtained datasets; this parameter is intended to mitigate any inconsistencies that may result from changes to our database; **Note:** we do not recommend setting `correlate` to `false` */
     correlate?: boolean | undefined;
-    /** the maximum number of domains in the results array optional field default value: 100; maximum value: 1000 */
+    /** *the maximum number of domains in the results array* optional field default value: `100`; maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned domains optional field default value: 0; if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains */
+    /** *offset in the results array of returned domains* optional field default value: `0`; if you specify the `10` value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains */
     offset?: number | undefined;
-    /** array of results filtering parameters optional field you can add several filters at once (8 filters maximum); you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like; you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters; example: ['metrics_history.202110.organic.pos_1', '>', 15]; for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)**; you should set a logical operator `and`, `or` between the conditions the following operators are supported: `regex`, `not_regex`, ``, `>=`, `=`, `<>`, `in`, `not_in`, `match`, `not_match`, `ilike`, `not_ilike`, `like`, `not_like`; you can use the `%` operator with `like` and `not_like`, as well as `ilike` and `not_ilike` to match any string of zero or more characters; example: `['metrics_history.202110.organic.pos_1', '>', 15]`; 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; default rule: ['organic_etv,desc']; possible sorting types: asc – results will be sorted in ascending order desc – results will be sorted in descending order; you should use a comma to set up a sorting type; example: ['organic_count,desc']; note that you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: ['organic_etv,desc','organic_count,asc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results; default rule: `['organic_etv,desc']`; possible sorting types: `asc` - results will be sorted in ascending order `desc` - results will be sorted in descending order; you should use a comma to set up a sorting type; example: `['organic_count,desc']`; **note that you can set no more than three sorting rules in a single request**; you should use a comma to separate several sorting rules; example: `['organic_etv,desc','organic_count,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 DataforseoLabsGoogleDomainMetricsByCategoriesLiveRequestInfo implements IDataforseoLabsGoogleDomainMetricsByCategoriesLiveRequestInfo {
-    /** product and service categories required field The maximum number of categories you can specify: 5 you can download the full list of possible categories */
+    /** *product and service categories* **required field** The maximum number of categories you can specify: 5 you can download [the full list of possible categories](https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv) */
     category_codes?: string[] | undefined;
-    /** first date of comparison period required field first date for which domain metrics will be provided; date format: 'yyyy-mm-dd'; example: '2021-06-01'; the list available dates is available through the available history endpoint; Note: first_date cannot be greater than today’s date; Also note: the dates specified in first_date and second_date cannot point to the same month of the same year; you can specify the dates in any order: first_date can be greater than second_date and vice versa; minimum date: '2020-10-01' */
+    /** *first date of comparison period* **required field** first date for which domain metrics will be provided; date format: `'yyyy-mm-dd'`; example: `'2021-06-01'`; the list available dates is available through the [available history endpoint](/v3/dataforseo_labs/google/available_history/live/); **Note:** `first_date` cannot be greater than today's date; **Also note:** the dates specified in `first_date` and `second_date` cannot point to the same month of the same year; you can specify the dates in any order: `first_date` can be greater than `second_date` and vice versa; minimum date: `'2020-10-01'` */
     first_date?: string | undefined;
-    /** second date of comparison period required field second date for which domain metrics will be provided; date format: 'yyyy-mm-dd'; example: '2021-10-01'; the list available dates is available through the available history endpoint; Note: second_date cannot be greater than today’s date; Also note: the dates specified in first_date and second_date cannot point to the same month of the same year; you can specify the dates in any order: second_date can be greater than first_date and vice versa; minimum date: '2020-10-01' */
+    /** *second date of comparison period* **required field** second date for which domain metrics will be provided; date format: `'yyyy-mm-dd'`; example: `'2021-10-01'`; the list available dates is available through the [available history endpoint](/v3/dataforseo_labs/google/available_history/live/); **Note:** `second_date` cannot be greater than today's date; **Also note:** the dates specified in `first_date` and `second_date` cannot point to the same month of the same year; you can specify the dates in any order: `second_date` can be greater than `first_date` and vice versa; minimum date: `'2020-10-01'` */
     second_date?: 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 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 `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; example: `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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; example: 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 `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 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 `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; example: `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 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; example: en */
+    /** *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 `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; example: `en` */
     language_code?: string | undefined;
-    /** display results by item type optional field indicates the type of search results included in the response; Note: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: ['organic', 'paid', 'featured_snippet', 'local_pack']; default value: ['organic', 'paid'] */
+    /** *display results by item type* optional field indicates the type of search results included in the response; **Note:** if the `item_types` array contains item types that are different from the `organic` object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values:  `['organic', 'paid', 'featured_snippet', 'local_pack']`; default value:  `['organic', 'paid']` */
     item_types?: string[] | undefined;
-    /** number of additional domain categories optional field by using this parameter, you can receive domains relevant to additional categories that are not specified in category_codes above; to learn more about the parameter, please refer to this help center article; by default, top_categories_count is equal to the number of categories specified in the category_codes array; Note: top_categories_count cannot be less than the number of categories in the category_codes array; maximum value: 5 */
+    /** *number of additional domain categories* optional field by using this parameter, you can receive domains relevant to additional categories that are not specified in `category_codes` above; to learn more about the parameter, please refer to [this help center article;](https://dataforseo.com/help-center/what-is-top_categories_count) by default, `top_categories_count` is equal to the number of categories specified in the `category_codes` array; **Note:** `top_categories_count` cannot be less than the number of categories in the `category_codes` array; maximum value: `5` */
     top_categories_count?: number | undefined;
-    /** return subdomains in the API response optional field if false, the API response will contain main_domain only; if true, the API will return main_domain plus its subdomains (if available); default value: true */
+    /** *return subdomains in the API response* optional field if `false`, the API response will contain `main_domain` only; if `true`, the API will return `main_domain` plus its subdomains (if available); default value: `true` */
     include_subdomains?: boolean | undefined;
-    /** minimum current organic ETV of the domain optional field if specified, the API will return only domains with organic_etv greater than the specified value */
+    /** *minimum current organic ETV of the domain* optional field if specified, the API will return only domains with `organic_etv` greater than the specified value */
     etv_min?: number | undefined;
-    /** maximum current organic ETV of the domain optional field if specified, the API will return only domains with organic_etv lesser than the specified value */
+    /** *maximum current organic ETV of the domain* optional field if specified, the API will return only domains with `organic_etv` lesser than the specified value */
     etv_max?: number | undefined;
-    /** correlate data with previously obtained datasets optional field default value: true; if you use this parameter, our system will correlate data you obtain now with previously obtained datasets; this parameter is intended to mitigate any inconsistencies that may result from changes to our database; Note: we do not recommend setting correlate to false */
+    /** *correlate data with previously obtained datasets* optional field default value: `true`; if you use this parameter, our system will correlate data you obtain now with previously obtained datasets; this parameter is intended to mitigate any inconsistencies that may result from changes to our database; **Note:** we do not recommend setting `correlate` to `false` */
     correlate?: boolean | undefined;
-    /** the maximum number of domains in the results array optional field default value: 100; maximum value: 1000 */
+    /** *the maximum number of domains in the results array* optional field default value: `100`; maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned domains optional field default value: 0; if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains */
+    /** *offset in the results array of returned domains* optional field default value: `0`; if you specify the `10` value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains */
     offset?: number | undefined;
-    /** array of results filtering parameters optional field you can add several filters at once (8 filters maximum); you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like; you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters; example: ['metrics_history.202110.organic.pos_1', '>', 15]; for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)**; you should set a logical operator `and`, `or` between the conditions the following operators are supported: `regex`, `not_regex`, ``, `>=`, `=`, `<>`, `in`, `not_in`, `match`, `not_match`, `ilike`, `not_ilike`, `like`, `not_like`; you can use the `%` operator with `like` and `not_like`, as well as `ilike` and `not_ilike` to match any string of zero or more characters; example: `['metrics_history.202110.organic.pos_1', '>', 15]`; 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; default rule: ['organic_etv,desc']; possible sorting types: asc – results will be sorted in ascending order desc – results will be sorted in descending order; you should use a comma to set up a sorting type; example: ['organic_count,desc']; note that you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: ['organic_etv,desc','organic_count,asc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results; default rule: `['organic_etv,desc']`; possible sorting types: `asc` - results will be sorted in ascending order `desc` - results will be sorted in descending order; you should use a comma to set up a sorting type; example: `['organic_count,desc']`; **note that you can set no more than three sorting rules in a single request**; you should use a comma to separate several sorting rules; example: `['organic_etv,desc','organic_count,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?: IDataforseoLabsGoogleDomainMetricsByCategoriesLiveRequestInfo);

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

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