dataforseo-client 2.1.1 → 2.1.3

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

@@ -1,58 +1,58 @@
 export interface IDataforseoLabsGoogleTopSearchesLiveRequestInfo {
-    /** 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 locations 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 locations 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 locations 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 locations 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;
-    /** include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false */
+    /** *include data from SERP for each keyword* optional field if set to `true`, we will return a `serp_info` array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: `false` */
     include_serp_info?: boolean | undefined;
-    /** include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | undefined;
-    /** ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true` only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , >=, =, <>, in, not_in, 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: ['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 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: `['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',''or',['keyword_info.high_top_of_page_bid','<=',0.5]]]` for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting type example: ['keyword_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.cpc,desc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order you should use a comma to set up a sorting type example: `['keyword_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.cpc,desc']` */
     order_by?: string[] | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
-    /** the maximum number of returned keywords optional field note: you can get more than 1000 results by using the offset_token provided in the response to each subsequent request default value: 1000 maximum value: 1000 */
+    /** *the maximum number of returned keywords* optional field note: you can get more than 1000 results by using the `offset_token` provided in the response to each subsequent request default value: `1000` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords 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 keywords* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords **Note:** we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the `offset_token` instead. */
     offset?: number | undefined;
-    /** offset token for subsequent 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 requests* optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique `offset_token` value from the response array, you will get the subsequent results of the initial task; `offset_token` values are unique for each subsequent task  **Note:** if the `offset_token` is specified in the request, all other parameters except `limit` will not be taken into account when processing a task. learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token) */
     offset_token?: string | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleTopSearchesLiveRequestInfo implements IDataforseoLabsGoogleTopSearchesLiveRequestInfo {
-    /** 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 locations 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 locations 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 locations 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 locations 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;
-    /** include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false */
+    /** *include data from SERP for each keyword* optional field if set to `true`, we will return a `serp_info` array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: `false` */
     include_serp_info?: boolean | undefined;
-    /** include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | undefined;
-    /** ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true` only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , >=, =, <>, in, not_in, 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: ['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 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: `['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',''or',['keyword_info.high_top_of_page_bid','<=',0.5]]]` for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting type example: ['keyword_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.cpc,desc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order you should use a comma to set up a sorting type example: `['keyword_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.cpc,desc']` */
     order_by?: string[] | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
-    /** the maximum number of returned keywords optional field note: you can get more than 1000 results by using the offset_token provided in the response to each subsequent request default value: 1000 maximum value: 1000 */
+    /** *the maximum number of returned keywords* optional field note: you can get more than 1000 results by using the `offset_token` provided in the response to each subsequent request default value: `1000` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords 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 keywords* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords **Note:** we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the `offset_token` instead. */
     offset?: number | undefined;
-    /** offset token for subsequent 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 requests* optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique `offset_token` value from the response array, you will get the subsequent results of the initial task; `offset_token` values are unique for each subsequent task  **Note:** if the `offset_token` is specified in the request, all other parameters except `limit` will not be taken into account when processing a task. learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token) */
     offset_token?: string | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleTopSearchesLiveRequestInfo);

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

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

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

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

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

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

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

@@ -1,30 +1,30 @@
 export interface IDataforseoLabsIdListRequestInfo {
-    /** start time for filtering results required field if include_metadata is set to true, maximum value: a month from current datetime; if include_metadata is set to false, maximum value: six months from current datetime; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *start time for filtering results* **required field** if `include_metadata` is set to `true`, maximum value: a month from current datetime; if `include_metadata` is set to `false`, maximum value: six months from current datetime; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_from?: string | undefined;
-    /** finish time for filtering results required field maximum value: current datetime; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-31 13:57:46 +00:00 */
+    /** *finish time for filtering results* **required field** maximum value: current datetime; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-31 13:57:46 +00:00` */
     datetime_to?: string | undefined;
-    /** the maximum number of returned task IDs optional field default value: 1000 maximum value: 1000 */
+    /** *the maximum number of returned task IDs* optional field default value: `1000` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned task IDs optional field default value: 0 if you specify the 10 value, the first ten tasks in the results array will be omitted */
+    /** *offset in the results array of returned task IDs* optional field default value: `0` if you specify the `10` value, the first ten tasks in the results array will be omitted */
     offset?: number | undefined;
-    /** sorting by task execution time optional field possible values: 'asc', 'desc' default value: 'asc' */
+    /** *sorting by task execution time* optional field possible values: `'asc'`, `'desc'` default value: `'asc'` */
     sort?: string | undefined;
-    /** include task metadata in the respond optional field default value: false */
+    /** *include task metadata in the respond* optional field default value: `false` */
     include_metadata?: boolean | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsIdListRequestInfo implements IDataforseoLabsIdListRequestInfo {
-    /** start time for filtering results required field if include_metadata is set to true, maximum value: a month from current datetime; if include_metadata is set to false, maximum value: six months from current datetime; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *start time for filtering results* **required field** if `include_metadata` is set to `true`, maximum value: a month from current datetime; if `include_metadata` is set to `false`, maximum value: six months from current datetime; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_from?: string | undefined;
-    /** finish time for filtering results required field maximum value: current datetime; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-31 13:57:46 +00:00 */
+    /** *finish time for filtering results* **required field** maximum value: current datetime; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-31 13:57:46 +00:00` */
     datetime_to?: string | undefined;
-    /** the maximum number of returned task IDs optional field default value: 1000 maximum value: 1000 */
+    /** *the maximum number of returned task IDs* optional field default value: `1000` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned task IDs optional field default value: 0 if you specify the 10 value, the first ten tasks in the results array will be omitted */
+    /** *offset in the results array of returned task IDs* optional field default value: `0` if you specify the `10` value, the first ten tasks in the results array will be omitted */
     offset?: number | undefined;
-    /** sorting by task execution time optional field possible values: 'asc', 'desc' default value: 'asc' */
+    /** *sorting by task execution time* optional field possible values: `'asc'`, `'desc'` default value: `'asc'` */
     sort?: string | undefined;
-    /** include task metadata in the respond optional field default value: false */
+    /** *include task metadata in the respond* optional field default value: `false` */
     include_metadata?: boolean | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsIdListRequestInfo);

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

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

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

@@ -1,36 +1,36 @@
 export interface IDataforseoLabsIdListResultInfo {
-    /** task identifier unique task identifier in our system in the UUID format */
+    /** *task identifier* **unique task identifier in our system in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format** */
     id?: string | undefined;
-    /** URL of the task URL you used for making an API call */
+    /** *URL of the task* URL you used for making an API call */
     url?: string | undefined;
-    /** date and time when the task was made in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *date and time when the task was made* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_posted?: string | undefined;
-    /** date and time when the task was completed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *date and time when the task was completed* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_done?: string | undefined;
-    /** informational message of the task you can find the full list of general informational messages here */
+    /** *informational message of the task* you can find the full list of general informational messages [here](/v3/appendix-errors/) */
     status?: string | undefined;
-    /** total tasks cost, USD */
+    /** *total tasks cost, USD* */
     cost?: number | undefined;
-    /** contains parameters you specified in the POST request */
+    /** *contains parameters you specified in the POST request* */
     metadata?: {
         [key: string]: any;
     } | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsIdListResultInfo implements IDataforseoLabsIdListResultInfo {
-    /** task identifier unique task identifier in our system in the UUID format */
+    /** *task identifier* **unique task identifier in our system in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format** */
     id?: string | undefined;
-    /** URL of the task URL you used for making an API call */
+    /** *URL of the task* URL you used for making an API call */
     url?: string | undefined;
-    /** date and time when the task was made in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *date and time when the task was made* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_posted?: string | undefined;
-    /** date and time when the task was completed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *date and time when the task was completed* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_done?: string | undefined;
-    /** informational message of the task you can find the full list of general informational messages here */
+    /** *informational message of the task* you can find the full list of general informational messages [here](/v3/appendix-errors/) */
     status?: string | undefined;
-    /** total tasks cost, USD */
+    /** *total tasks cost, USD* */
     cost?: number | undefined;
-    /** contains parameters you specified in the POST request */
+    /** *contains parameters you specified in the POST request* */
     metadata?: {
         [key: string]: any;
     } | undefined;

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

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

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

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

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

@@ -1,31 +1,31 @@
 import { AvailableLanguages } from "./AvailableLanguages";
 export interface IDataforseoLabsLocationsAndLanguagesResultInfo {
-    /** location code */
+    /** *location code* */
     location_code?: number | undefined;
-    /** full name of the location */
+    /** *full name of the location* */
     location_name?: string | undefined;
-    /** the code of the superordinate location the value will be null as Country is the only supported location_type for this API */
+    /** *the code of the superordinate location* the value will be `null` as `Country` is the only supported `location_type` for this API */
     location_code_parent?: number | undefined;
-    /** ISO country code of the location */
+    /** *ISO country code of the location* */
     country_iso_code?: string | undefined;
-    /** location type possible values: Country */
+    /** *location type* possible values: `Country` */
     location_type?: string | undefined;
-    /** supported languages contains the languages which are supported for a specific location */
+    /** *supported languages* contains the languages which are supported for a specific location */
     available_languages?: AvailableLanguages[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsLocationsAndLanguagesResultInfo implements IDataforseoLabsLocationsAndLanguagesResultInfo {
-    /** location code */
+    /** *location code* */
     location_code?: number | undefined;
-    /** full name of the location */
+    /** *full name of the location* */
     location_name?: string | undefined;
-    /** the code of the superordinate location the value will be null as Country is the only supported location_type for this API */
+    /** *the code of the superordinate location* the value will be `null` as `Country` is the only supported `location_type` for this API */
     location_code_parent?: number | undefined;
-    /** ISO country code of the location */
+    /** *ISO country code of the location* */
     country_iso_code?: string | undefined;
-    /** location type possible values: Country */
+    /** *location type* possible values: `Country` */
     location_type?: string | undefined;
-    /** supported languages contains the languages which are supported for a specific location */
+    /** *supported languages* contains the languages which are supported for a specific location */
     available_languages?: AvailableLanguages[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsLocationsAndLanguagesResultInfo);

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

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

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

@@ -1,100 +1,100 @@
 export interface IDataforseoLabsMetricsInfo {
-    /** number of organic SERPs where the domain or subdomain ranks #1 */
+    /** *number of organic SERPs where the domain or subdomain ranks #1* */
     pos_1?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #2-3 */
+    /** *number of organic SERPs where the domain or subdomain ranks #2-3* */
     pos_2_3?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #4-10 */
+    /** *number of organic SERPs where the domain or subdomain ranks #4-10* */
     pos_4_10?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #11-20 */
+    /** *number of organic SERPs where the domain or subdomain ranks #11-20* */
     pos_11_20?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #21-30 */
+    /** *number of organic SERPs where the domain or subdomain ranks #21-30* */
     pos_21_30?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #31-40 */
+    /** *number of organic SERPs where the domain or subdomain ranks #31-40* */
     pos_31_40?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #41-50 */
+    /** *number of organic SERPs where the domain or subdomain ranks #41-50* */
     pos_41_50?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #51-60 */
+    /** *number of organic SERPs where the domain or subdomain ranks #51-60* */
     pos_51_60?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #61-70 */
+    /** *number of organic SERPs where the domain or subdomain ranks #61-70* */
     pos_61_70?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #71-80 */
+    /** *number of organic SERPs where the domain or subdomain ranks #71-80* */
     pos_71_80?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #81-90 */
+    /** *number of organic SERPs where the domain or subdomain ranks #81-90* */
     pos_81_90?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #91-100 */
+    /** *number of organic SERPs where the domain or subdomain ranks #91-100* */
     pos_91_100?: number | undefined;
-    /** estimated traffic volume estimated organic monthly traffic to the domain or subdomain calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain or subdomain ranks for learn more about how the metric is calculated in this help center article */
+    /** *estimated traffic volume* estimated organic monthly traffic to the domain or subdomain calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain or subdomain ranks for learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-etv-calculated) */
     etv?: number | undefined;
-    /** total count of organic SERPs that contain the domain or subdomain */
+    /** *total count of organic SERPs that contain the domain or subdomain* */
     count?: number | undefined;
-    /** estimated cost of converting organic search traffic into paid represents the estimated monthly cost (USD) of running ads for all keywords in the category that the domain or subdomain ranks for the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search learn more about how the metric is calculated in this help center article */
+    /** *estimated cost of converting organic search traffic into paid* represents the estimated monthly cost (USD) of running ads for all keywords in the category that the domain or subdomain ranks for the metric is calculated as the product of organic `etv` and paid `cpc` values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-traffic-cost-calculated) */
     estimated_paid_traffic_cost?: number | undefined;
-    /** number of new ranked elements indicates how many new ranked elements were found for the indicated target */
+    /** *number of new ranked elements* indicates how many new ranked elements were found for the indicated target */
     is_new?: number | undefined;
-    /** rank went up indicates how many ranked elements of the indicated target went up */
+    /** *rank went up* indicates how many ranked elements of the indicated target went up */
     is_up?: number | undefined;
-    /** rank went down indicates how many ranked elements of the indicated target went down */
+    /** *rank went down* indicates how many ranked elements of the indicated target went down */
     is_down?: number | undefined;
-    /** lost ranked elements indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check */
+    /** *lost ranked elements* indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren't found during the last check */
     is_lost?: number | undefined;
-    /** estimated traffic volume based on clickstream data calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article */
+    /** *estimated traffic volume based on clickstream data* calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true` learn more about how the metric is calculated in this [help center article](https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated) */
     clickstream_etv?: number | undefined;
-    /** distribution of estimated clickstream-based metrics by gender to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article */
+    /** *distribution of estimated clickstream-based metrics by gender* to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true` learn more about how the metric is calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     clickstream_gender_distribution?: {
         [key: string]: number;
     } | undefined;
-    /** distribution of clickstream-based metrics by age to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article */
+    /** *distribution of clickstream-based metrics by age* to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true` learn more about how the metric is calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     clickstream_age_distribution?: {
         [key: string]: number;
     } | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsMetricsInfo implements IDataforseoLabsMetricsInfo {
-    /** number of organic SERPs where the domain or subdomain ranks #1 */
+    /** *number of organic SERPs where the domain or subdomain ranks #1* */
     pos_1?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #2-3 */
+    /** *number of organic SERPs where the domain or subdomain ranks #2-3* */
     pos_2_3?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #4-10 */
+    /** *number of organic SERPs where the domain or subdomain ranks #4-10* */
     pos_4_10?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #11-20 */
+    /** *number of organic SERPs where the domain or subdomain ranks #11-20* */
     pos_11_20?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #21-30 */
+    /** *number of organic SERPs where the domain or subdomain ranks #21-30* */
     pos_21_30?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #31-40 */
+    /** *number of organic SERPs where the domain or subdomain ranks #31-40* */
     pos_31_40?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #41-50 */
+    /** *number of organic SERPs where the domain or subdomain ranks #41-50* */
     pos_41_50?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #51-60 */
+    /** *number of organic SERPs where the domain or subdomain ranks #51-60* */
     pos_51_60?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #61-70 */
+    /** *number of organic SERPs where the domain or subdomain ranks #61-70* */
     pos_61_70?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #71-80 */
+    /** *number of organic SERPs where the domain or subdomain ranks #71-80* */
     pos_71_80?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #81-90 */
+    /** *number of organic SERPs where the domain or subdomain ranks #81-90* */
     pos_81_90?: number | undefined;
-    /** number of organic SERPs where the domain or subdomain ranks #91-100 */
+    /** *number of organic SERPs where the domain or subdomain ranks #91-100* */
     pos_91_100?: number | undefined;
-    /** estimated traffic volume estimated organic monthly traffic to the domain or subdomain calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain or subdomain ranks for learn more about how the metric is calculated in this help center article */
+    /** *estimated traffic volume* estimated organic monthly traffic to the domain or subdomain calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain or subdomain ranks for learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-etv-calculated) */
     etv?: number | undefined;
-    /** total count of organic SERPs that contain the domain or subdomain */
+    /** *total count of organic SERPs that contain the domain or subdomain* */
     count?: number | undefined;
-    /** estimated cost of converting organic search traffic into paid represents the estimated monthly cost (USD) of running ads for all keywords in the category that the domain or subdomain ranks for the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search learn more about how the metric is calculated in this help center article */
+    /** *estimated cost of converting organic search traffic into paid* represents the estimated monthly cost (USD) of running ads for all keywords in the category that the domain or subdomain ranks for the metric is calculated as the product of organic `etv` and paid `cpc` values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-traffic-cost-calculated) */
     estimated_paid_traffic_cost?: number | undefined;
-    /** number of new ranked elements indicates how many new ranked elements were found for the indicated target */
+    /** *number of new ranked elements* indicates how many new ranked elements were found for the indicated target */
     is_new?: number | undefined;
-    /** rank went up indicates how many ranked elements of the indicated target went up */
+    /** *rank went up* indicates how many ranked elements of the indicated target went up */
     is_up?: number | undefined;
-    /** rank went down indicates how many ranked elements of the indicated target went down */
+    /** *rank went down* indicates how many ranked elements of the indicated target went down */
     is_down?: number | undefined;
-    /** lost ranked elements indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check */
+    /** *lost ranked elements* indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren't found during the last check */
     is_lost?: number | undefined;
-    /** estimated traffic volume based on clickstream data calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article */
+    /** *estimated traffic volume based on clickstream data* calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true` learn more about how the metric is calculated in this [help center article](https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated) */
     clickstream_etv?: number | undefined;
-    /** distribution of estimated clickstream-based metrics by gender to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article */
+    /** *distribution of estimated clickstream-based metrics by gender* to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true` learn more about how the metric is calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     clickstream_gender_distribution?: {
         [key: string]: number;
     } | undefined;
-    /** distribution of clickstream-based metrics by age to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article */
+    /** *distribution of clickstream-based metrics by age* to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true` learn more about how the metric is calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     clickstream_age_distribution?: {
         [key: string]: number;
     } | undefined;