dataforseo-client 2.1.1 → 2.1.3

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

@@ -4,70 +4,70 @@ import { AnalysisContentInfo } from "./AnalysisContentInfo";
 export interface IContentAnalysisSearchLiveItem {
     /** type of element */
     type?: string | undefined;
-    /** URL where the citation was found */
+    /** *URL where the citation was found* */
     url?: string | undefined;
-    /** domain name */
+    /** *domain name* */
     domain?: string | undefined;
-    /** main domain */
+    /** *main domain* */
     main_domain?: string | undefined;
-    /** rank of the url this value is based on backlink data for the given URL from DataForSEO Backlink Index; url_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in this help center article */
+    /** *rank of the `url`* this value is based on backlink data for the given URL from DataForSEO Backlink Index; `url_rank` is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in [this help center article](https://dataforseo.com/help-center/what_is_rank_in_backlinks_api) */
     url_rank?: number | undefined;
-    /** backlink spam score of the url this value is based on backlink data for the given URL from DataForSEO Backlink Index; learn more about how the metric is calculated on this help center page */
+    /** *backlink spam score of the `url`* this value is based on backlink data for the given URL from DataForSEO Backlink Index; learn more about how the metric is calculated on [this help center page](https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated) */
     spam_score?: number | undefined;
-    /** rank of the domain this value is based on backlink data for the given domain from DataForSEO Backlink Index; domain_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in this help center article */
+    /** *rank of the `domain`* this value is based on backlink data for the given domain from DataForSEO Backlink Index; `domain_rank` is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in [this help center article](https://dataforseo.com/help-center/what_is_rank_in_backlinks_api) */
     domain_rank?: number | undefined;
-    /** date and time when our crawler visited the page in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2017-01-24 13:20:59 +00:00 */
+    /** *date and time when our crawler visited the page* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2017-01-24 13:20:59 +00:00` */
     fetch_time?: string | undefined;
-    /** country code of the domain registration to obtain a full list of available countries, refer to the Locations endpoint */
+    /** *country code of the domain registration* to obtain a full list of available countries, refer to the [Locations](/v3/content_analysis/locations/) endpoint */
     country?: string | undefined;
-    /** main language of the domain to obtain a full list of available languages, refer to the Languages endpoint */
+    /** *main language of the domain* to obtain a full list of available languages, refer to the [Languages](/v3/content_analysis/languages/) endpoint */
     language?: string | undefined;
-    /** citation prominence score this value is based on url_rank, domain_rank, keyword presence in title, main_title, url, snippet the higher the score, the more value the related citation has */
+    /** *citation prominence score* this value is based on `url_rank`, `domain_rank`, `keyword` presence in `title`, `main_title`, `url`, `snippet` the higher the `score`, the more value the related citation has */
     score?: number | undefined;
-    /** contains all relevant page categories product and service categories relevant for the page to obtain a full list of available categories, refer to the Categories endpoint */
+    /** *contains all relevant page categories* product and service categories relevant for the page to obtain a full list of available categories, refer to the [Categories](/v3/content_analysis/categories/) endpoint */
     page_category?: number[] | undefined;
-    /** page types */
+    /** *page types* */
     page_types?: string[] | undefined;
-    /** ratings found on the page all ratings found on the page based on microdata */
+    /** *ratings found on the page* all ratings found on the page based on microdata */
     ratings?: ContentRatingInfo[] | undefined;
-    /** social media engagement metrics data on social media interactions associated with the content based on website embeds developed and supported by social media platforms */
+    /** *social media engagement metrics* data on social media interactions associated with the content based on website embeds developed and supported by social media platforms */
     social_metrics?: SocialMetricsInfo[] | undefined;
-    /** contains data on citations from the given url */
+    /** *contains data on citations from the given `url`* */
     content_info?: AnalysisContentInfo | undefined;
     [key: string]: any;
 }
 export declare class ContentAnalysisSearchLiveItem implements IContentAnalysisSearchLiveItem {
     /** type of element */
     type?: string | undefined;
-    /** URL where the citation was found */
+    /** *URL where the citation was found* */
     url?: string | undefined;
-    /** domain name */
+    /** *domain name* */
     domain?: string | undefined;
-    /** main domain */
+    /** *main domain* */
     main_domain?: string | undefined;
-    /** rank of the url this value is based on backlink data for the given URL from DataForSEO Backlink Index; url_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in this help center article */
+    /** *rank of the `url`* this value is based on backlink data for the given URL from DataForSEO Backlink Index; `url_rank` is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in [this help center article](https://dataforseo.com/help-center/what_is_rank_in_backlinks_api) */
     url_rank?: number | undefined;
-    /** backlink spam score of the url this value is based on backlink data for the given URL from DataForSEO Backlink Index; learn more about how the metric is calculated on this help center page */
+    /** *backlink spam score of the `url`* this value is based on backlink data for the given URL from DataForSEO Backlink Index; learn more about how the metric is calculated on [this help center page](https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated) */
     spam_score?: number | undefined;
-    /** rank of the domain this value is based on backlink data for the given domain from DataForSEO Backlink Index; domain_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in this help center article */
+    /** *rank of the `domain`* this value is based on backlink data for the given domain from DataForSEO Backlink Index; `domain_rank` is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in [this help center article](https://dataforseo.com/help-center/what_is_rank_in_backlinks_api) */
     domain_rank?: number | undefined;
-    /** date and time when our crawler visited the page in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2017-01-24 13:20:59 +00:00 */
+    /** *date and time when our crawler visited the page* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2017-01-24 13:20:59 +00:00` */
     fetch_time?: string | undefined;
-    /** country code of the domain registration to obtain a full list of available countries, refer to the Locations endpoint */
+    /** *country code of the domain registration* to obtain a full list of available countries, refer to the [Locations](/v3/content_analysis/locations/) endpoint */
     country?: string | undefined;
-    /** main language of the domain to obtain a full list of available languages, refer to the Languages endpoint */
+    /** *main language of the domain* to obtain a full list of available languages, refer to the [Languages](/v3/content_analysis/languages/) endpoint */
     language?: string | undefined;
-    /** citation prominence score this value is based on url_rank, domain_rank, keyword presence in title, main_title, url, snippet the higher the score, the more value the related citation has */
+    /** *citation prominence score* this value is based on `url_rank`, `domain_rank`, `keyword` presence in `title`, `main_title`, `url`, `snippet` the higher the `score`, the more value the related citation has */
     score?: number | undefined;
-    /** contains all relevant page categories product and service categories relevant for the page to obtain a full list of available categories, refer to the Categories endpoint */
+    /** *contains all relevant page categories* product and service categories relevant for the page to obtain a full list of available categories, refer to the [Categories](/v3/content_analysis/categories/) endpoint */
     page_category?: number[] | undefined;
-    /** page types */
+    /** *page types* */
     page_types?: string[] | undefined;
-    /** ratings found on the page all ratings found on the page based on microdata */
+    /** *ratings found on the page* all ratings found on the page based on microdata */
     ratings?: ContentRatingInfo[] | undefined;
-    /** social media engagement metrics data on social media interactions associated with the content based on website embeds developed and supported by social media platforms */
+    /** *social media engagement metrics* data on social media interactions associated with the content based on website embeds developed and supported by social media platforms */
     social_metrics?: SocialMetricsInfo[] | undefined;
-    /** contains data on citations from the given url */
+    /** *contains data on citations from the given `url`* */
     content_info?: AnalysisContentInfo | undefined;
     [key: string]: any;
     constructor(data?: IContentAnalysisSearchLiveItem);

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

@@ -1,54 +1,54 @@
 export interface IContentAnalysisSearchLiveRequestInfo {
-    /** target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: 'keyword': '\'tesla palo alto\'' learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *target keyword* **required field** UTF-8 encoding the keywords will be converted to a lowercase format; **Note**: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;  example:  `'keyword': '\'tesla palo alto\''` learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
     keyword?: string | undefined;
-    /** target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you can indicate several fields; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: 'keyword_fields': {     'snippet': '\'logitech mouse\'',     'main_title': 'sale' } */
+    /** *target keyword fields and target keywords* optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: `title`, `main_title`, `previous_title`, `snippet` you can indicate several fields; **Note**: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;  example: `'keyword_fields': { 'snippet': '\'logitech mouse\'', 'main_title': 'sale' }'` */
     keyword_fields?: {
         [key: string]: string;
     } | undefined;
-    /** target page types optional field use this parameter to filter the dataset by page types possible values: 'ecommerce', 'news', 'blogs', 'message-boards', 'organization' */
+    /** *target page types* optional field use this parameter to filter the dataset by page types possible values:  `'ecommerce'`, `'news'`, `'blogs'`, `'message-boards'`, `'organization'` */
     page_type?: string[] | undefined;
-    /** results grouping type optional field possible grouping types: as_is – returns all citations for the target keyword one_per_domain – returns one citation of the keyword per domain default value: as_is */
+    /** *results grouping type* optional field possible grouping types: `as_is` - returns all citations for the target `keyword` `one_per_domain` - returns one citation of the `keyword` per domain default value: `as_is` */
     search_mode?: string | undefined;
-    /** the maximum number of returned citations optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned citations* optional field default value: `100` maximum value: `1000` */
     limit?: 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, like,not_like, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ['country','=', 'US'] [['domain_rank','>',800],'and',['content_info.connotation_types.negative','>',0.9]] [['domain_rank','>',800], 'and', [['page_types','has','ecommerce'], 'or', ['content_info.text_category','has',10994]]] for more information about filters, please refer to Content Analysis API – Filters */
+    /** *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`, `like`,`not_like`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['country','=', 'US']` `[['domain_rank','>',800],'and',['content_info.connotation_types.negative','>',0.9]]` `[['domain_rank','>',800],'and',[['page_types','has','ecommerce'],'or',['content_info.text_category','has',10994]]]` for more information about filters, please refer to [Content Analysis API - Filters](/v3/content_analysis/filters) */
     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: ['content_info.sentiment_connotations.anger,desc'] default rule: ['content_info.sentiment_connotations.anger,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: ['content_info.sentiment_connotations.anger,desc','keyword_data.keyword_info.cpc,desc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order you should use a comma to set up a sorting type example: `['content_info.sentiment_connotations.anger,desc']` default rule: `['content_info.sentiment_connotations.anger,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: `['content_info.sentiment_connotations.anger,desc','keyword_data.keyword_info.cpc,desc']` */
     order_by?: string[] | undefined;
-    /** offset in the results array of returned citations optional field default value: 0 if you specify the 10 value, the first ten citations in the results array will be omitted and the data will be provided for the successive citations 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 citations* optional field default value: `0` if you specify the `10` value, the first ten citations in the results array will be omitted and the data will be provided for the successive citations **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 field 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 field 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;
-    /** defines the scale used for calculating and displaying the domain_rank, and url_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank values are displayed on a 0–100 scale one_thousand — rank values are displayed on a 0–1000 scale default value: one_thousand learn more about how this parameter works in this Help Center article */
+    /** *defines the scale used for calculating and displaying the `domain_rank`, and `url_rank` values* optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: `one_hundred` — rank values are displayed on a 0–100 scale `one_thousand` — rank values are displayed on a 0–1000 scale default value: `one_thousand` learn more about how this parameter works in [this Help Center article](https://dataforseo.com/help-center/using-the-rank_scale-parameter-in-content-analysis-api) */
     rank_scale?: 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 ContentAnalysisSearchLiveRequestInfo implements IContentAnalysisSearchLiveRequestInfo {
-    /** target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: 'keyword': '\'tesla palo alto\'' learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *target keyword* **required field** UTF-8 encoding the keywords will be converted to a lowercase format; **Note**: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;  example:  `'keyword': '\'tesla palo alto\''` learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
     keyword?: string | undefined;
-    /** target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you can indicate several fields; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: 'keyword_fields': {     'snippet': '\'logitech mouse\'',     'main_title': 'sale' } */
+    /** *target keyword fields and target keywords* optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: `title`, `main_title`, `previous_title`, `snippet` you can indicate several fields; **Note**: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;  example: `'keyword_fields': { 'snippet': '\'logitech mouse\'', 'main_title': 'sale' }'` */
     keyword_fields?: {
         [key: string]: string;
     } | undefined;
-    /** target page types optional field use this parameter to filter the dataset by page types possible values: 'ecommerce', 'news', 'blogs', 'message-boards', 'organization' */
+    /** *target page types* optional field use this parameter to filter the dataset by page types possible values:  `'ecommerce'`, `'news'`, `'blogs'`, `'message-boards'`, `'organization'` */
     page_type?: string[] | undefined;
-    /** results grouping type optional field possible grouping types: as_is – returns all citations for the target keyword one_per_domain – returns one citation of the keyword per domain default value: as_is */
+    /** *results grouping type* optional field possible grouping types: `as_is` - returns all citations for the target `keyword` `one_per_domain` - returns one citation of the `keyword` per domain default value: `as_is` */
     search_mode?: string | undefined;
-    /** the maximum number of returned citations optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned citations* optional field default value: `100` maximum value: `1000` */
     limit?: 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, like,not_like, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ['country','=', 'US'] [['domain_rank','>',800],'and',['content_info.connotation_types.negative','>',0.9]] [['domain_rank','>',800], 'and', [['page_types','has','ecommerce'], 'or', ['content_info.text_category','has',10994]]] for more information about filters, please refer to Content Analysis API – Filters */
+    /** *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`, `like`,`not_like`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['country','=', 'US']` `[['domain_rank','>',800],'and',['content_info.connotation_types.negative','>',0.9]]` `[['domain_rank','>',800],'and',[['page_types','has','ecommerce'],'or',['content_info.text_category','has',10994]]]` for more information about filters, please refer to [Content Analysis API - Filters](/v3/content_analysis/filters) */
     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: ['content_info.sentiment_connotations.anger,desc'] default rule: ['content_info.sentiment_connotations.anger,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: ['content_info.sentiment_connotations.anger,desc','keyword_data.keyword_info.cpc,desc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order you should use a comma to set up a sorting type example: `['content_info.sentiment_connotations.anger,desc']` default rule: `['content_info.sentiment_connotations.anger,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: `['content_info.sentiment_connotations.anger,desc','keyword_data.keyword_info.cpc,desc']` */
     order_by?: string[] | undefined;
-    /** offset in the results array of returned citations optional field default value: 0 if you specify the 10 value, the first ten citations in the results array will be omitted and the data will be provided for the successive citations 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 citations* optional field default value: `0` if you specify the `10` value, the first ten citations in the results array will be omitted and the data will be provided for the successive citations **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 field 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 field 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;
-    /** defines the scale used for calculating and displaying the domain_rank, and url_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank values are displayed on a 0–100 scale one_thousand — rank values are displayed on a 0–1000 scale default value: one_thousand learn more about how this parameter works in this Help Center article */
+    /** *defines the scale used for calculating and displaying the `domain_rank`, and `url_rank` values* optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: `one_hundred` — rank values are displayed on a 0–100 scale `one_thousand` — rank values are displayed on a 0–1000 scale default value: `one_thousand` learn more about how this parameter works in [this Help Center article](https://dataforseo.com/help-center/using-the-rank_scale-parameter-in-content-analysis-api) */
     rank_scale?: 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?: IContentAnalysisSearchLiveRequestInfo);

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

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

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

@@ -1,23 +1,23 @@
 import { ContentAnalysisSearchLiveItem } from "./ContentAnalysisSearchLiveItem";
 export interface IContentAnalysisSearchLiveResultInfo {
-    /** 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;
-    /** 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 citations and related data */
+    /** *contains citations and related data* */
     items?: ContentAnalysisSearchLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class ContentAnalysisSearchLiveResultInfo implements IContentAnalysisSearchLiveResultInfo {
-    /** 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;
-    /** 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 citations and related data */
+    /** *contains citations and related data* */
     items?: ContentAnalysisSearchLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IContentAnalysisSearchLiveResultInfo);

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

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

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

@@ -3,33 +3,33 @@ import { ContentAnalysisCategoriesInfo } from "./ContentAnalysisCategoriesInfo";
 export interface IContentAnalysisSummaryInfo {
     /** type of element */
     type?: 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;
-    /** rank of all URLs citing the keyword normalized sum of ranks of all URLs citing the target keyword */
+    /** *rank of all URLs citing the `keyword`* normalized sum of ranks of all URLs citing the target `keyword` */
     rank?: number | undefined;
-    /** top domains citing the target keyword contains objects with top domains citing the target keword and citation count per each domain */
+    /** *top domains citing the target keyword* contains objects with top domains citing the target keword and citation count per each domain */
     top_domains?: TopDomainInfo[] | undefined;
-    /** sentiment connotations contains sentiments (emotional reactions) related to the target keyword citation and the number of citations per each sentiment possible sentiment connotations: anger, happiness, love, sadness, share, fun */
+    /** *sentiment connotations* contains sentiments (emotional reactions) related to the target keyword citation and the number of citations per each sentiment possible sentiment connotations: `anger`, `happiness`, `love`, `sadness`, `share`, `fun` */
     sentiment_connotations?: {
         [key: string]: number;
     } | undefined;
-    /** connotation types contains types of sentiments (sentiment polarity) related to the keyword citation and citation count per each sentiment type possible sentiment connotation types: positive, negative, neutral */
+    /** *connotation types* contains types of sentiments (sentiment polarity) related to the keyword citation and citation count per each sentiment type possible sentiment connotation types: `positive`, `negative`, `neutral` */
     connotation_types?: {
         [key: string]: number;
     } | undefined;
-    /** text categories contains objects with text categories and citation count in each text category to obtain a full list of available categories, refer to the Categories endpoint */
+    /** *text categories* contains objects with text categories and citation count in each text category to obtain a full list of available categories, refer to the [Categories](/v3/content_analysis/categories/) endpoint */
     text_categories?: ContentAnalysisCategoriesInfo[] | undefined;
-    /** page categories contains objects with page categories and citation count in each page category to obtain a full list of available categories, refer to the Categories endpoint */
+    /** *page categories* contains objects with page categories and citation count in each page category to obtain a full list of available categories, refer to the [Categories](/v3/content_analysis/categories/) endpoint */
     page_categories?: ContentAnalysisCategoriesInfo[] | undefined;
-    /** page types contains page types and citation count per each page type */
+    /** *page types* contains page types and citation count per each page type */
     page_types?: {
         [key: string]: number;
     } | undefined;
-    /** countries contains countries and citation count in each country to obtain a full list of available countries, refer to the Locations endpoint */
+    /** *countries* contains countries and citation count in each country to obtain a full list of available countries, refer to the [Locations](/v3/content_analysis/locations/) endpoint */
     countries?: {
         [key: string]: number;
     } | undefined;
-    /** languages contains languages and citation count in each language to obtain a full list of available languages, refer to the Languages endpoint */
+    /** *languages* contains languages and citation count in each language to obtain a full list of available languages, refer to the [Languages](/v3/content_analysis/languages/) endpoint */
     languages?: {
         [key: string]: number;
     } | undefined;
@@ -38,33 +38,33 @@ export interface IContentAnalysisSummaryInfo {
 export declare class ContentAnalysisSummaryInfo implements IContentAnalysisSummaryInfo {
     /** type of element */
     type?: 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;
-    /** rank of all URLs citing the keyword normalized sum of ranks of all URLs citing the target keyword */
+    /** *rank of all URLs citing the `keyword`* normalized sum of ranks of all URLs citing the target `keyword` */
     rank?: number | undefined;
-    /** top domains citing the target keyword contains objects with top domains citing the target keword and citation count per each domain */
+    /** *top domains citing the target keyword* contains objects with top domains citing the target keword and citation count per each domain */
     top_domains?: TopDomainInfo[] | undefined;
-    /** sentiment connotations contains sentiments (emotional reactions) related to the target keyword citation and the number of citations per each sentiment possible sentiment connotations: anger, happiness, love, sadness, share, fun */
+    /** *sentiment connotations* contains sentiments (emotional reactions) related to the target keyword citation and the number of citations per each sentiment possible sentiment connotations: `anger`, `happiness`, `love`, `sadness`, `share`, `fun` */
     sentiment_connotations?: {
         [key: string]: number;
     } | undefined;
-    /** connotation types contains types of sentiments (sentiment polarity) related to the keyword citation and citation count per each sentiment type possible sentiment connotation types: positive, negative, neutral */
+    /** *connotation types* contains types of sentiments (sentiment polarity) related to the keyword citation and citation count per each sentiment type possible sentiment connotation types: `positive`, `negative`, `neutral` */
     connotation_types?: {
         [key: string]: number;
     } | undefined;
-    /** text categories contains objects with text categories and citation count in each text category to obtain a full list of available categories, refer to the Categories endpoint */
+    /** *text categories* contains objects with text categories and citation count in each text category to obtain a full list of available categories, refer to the [Categories](/v3/content_analysis/categories/) endpoint */
     text_categories?: ContentAnalysisCategoriesInfo[] | undefined;
-    /** page categories contains objects with page categories and citation count in each page category to obtain a full list of available categories, refer to the Categories endpoint */
+    /** *page categories* contains objects with page categories and citation count in each page category to obtain a full list of available categories, refer to the [Categories](/v3/content_analysis/categories/) endpoint */
     page_categories?: ContentAnalysisCategoriesInfo[] | undefined;
-    /** page types contains page types and citation count per each page type */
+    /** *page types* contains page types and citation count per each page type */
     page_types?: {
         [key: string]: number;
     } | undefined;
-    /** countries contains countries and citation count in each country to obtain a full list of available countries, refer to the Locations endpoint */
+    /** *countries* contains countries and citation count in each country to obtain a full list of available countries, refer to the [Locations](/v3/content_analysis/locations/) endpoint */
     countries?: {
         [key: string]: number;
     } | undefined;
-    /** languages contains languages and citation count in each language to obtain a full list of available languages, refer to the Languages endpoint */
+    /** *languages* contains languages and citation count in each language to obtain a full list of available languages, refer to the [Languages](/v3/content_analysis/languages/) endpoint */
     languages?: {
         [key: string]: number;
     } | undefined;

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

@@ -1,46 +1,46 @@
 export interface IContentAnalysisSummaryLiveRequestInfo {
-    /** target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: 'keyword': '\'tesla palo alto\'' learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *target keyword* **required field** UTF-8 encoding the keywords will be converted to a lowercase format; **Note**: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;  example:  `'keyword': '\'tesla palo alto\''` learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
     keyword?: string | undefined;
-    /** target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you can indicate several fields; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: 'keyword_fields': {     'snippet': '\'logitech mouse\'',     'main_title': 'sale' } */
+    /** *target keyword fields and target keywords* optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: `title`, `main_title`, `previous_title`, `snippet` you can indicate several fields; **Note**: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;  example: `'keyword_fields': {'snippet': '\'logitech mouse\'','main_title': 'sale'}` */
     keyword_fields?: {
         [key: string]: string;
     } | undefined;
-    /** target page types optional field use this parameter to filter the dataset by page types possible values: 'ecommerce', 'news', 'blogs', 'message-boards', 'organization' */
+    /** *target page types* optional field use this parameter to filter the dataset by page types possible values:  `'ecommerce'`, `'news'`, `'blogs'`, `'message-boards'`, `'organization'` */
     page_type?: string[] | undefined;
-    /** maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages default value: 1 maximum value: 20 */
+    /** *maximum number of elements within internal arrays* optional field you can use this field to limit the number of elements within the following arrays: `top_domains` `text_categories` `page_categories` `countries` `languages` default value: `1` maximum value: `20` */
     internal_list_limit?: number | undefined;
-    /** positive connotation threshold optional field specified as the probability index threshold for positive sentiment related to the citation content if you specify this field, connotation_types object in the response will only contain data on citations with positive sentiment probability more than or equal to the specified value possible values: from 0 to 1 default value: 0.4 */
+    /** *positive connotation threshold* optional field specified as the probability index threshold for positive sentiment related to the citation content if you specify this field, `connotation_types` object in the response will only contain data on citations with `positive` sentiment probability more than or equal to the specified value possible values: from `0` to `1` default value: `0.4` */
     positive_connotation_threshold?: number | undefined;
-    /** sentiment connotation threshold optional field specified as the probability index threshold for sentiment connotations related to the citation content if you specify this field, sentiment_connotations object in the response will only contain data on citations where the probability per each sentiment is more than or equal to the specified value possible values: from 0 to 1 default value: 0.4 */
+    /** *sentiment connotation threshold* optional field specified as the probability index threshold for sentiment connotations related to the citation content if you specify this field, `sentiment_connotations` object in the response will only contain data on citations where the  probability per each sentiment is more than or equal to the specified value possible values: from `0` to `1` default value: `0.4` */
     sentiments_connotation_threshold?: number | undefined;
-    /** initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint 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, like,not_like, has, has_not you can use the % operator with like and not_like to match any string of zero or more characters example: ['domain','<>', 'logitech.com'] [['domain','<>','logitech.com'],'and',['content_info.connotation_types.negative','>',1000]] [['domain','<>','logitech.com']], 'and', [['content_info.connotation_types.negative','>',1000], 'or', ['content_info.text_category','has',10994]]] for more information about filters, please refer to Content Analysis API – Filters learn more about the initial dataset filters in this help center article. */
+    /** *initial dataset filtering parameters* optional field initial filtering parameters that apply to fields in the [Search endpoint](/v3/content_analysis/search/live/?bash) **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`, `like`,`not_like`, `has`, `has_not` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['domain','<>', 'logitech.com']` `[['domain','<>','logitech.com'],'and',['content_info.connotation_types.negative','>',1000]]` `[['domain',''and',[['content_info.connotation_types.negative','>',1000],'or',['content_info.text_category','has',10994]]]` for more information about filters, please refer to [Content Analysis API - Filters](/v3/content_analysis/filters) learn more about the initial dataset filters in [this help center article.](https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work) */
     initial_dataset_filters?: any[] | undefined;
-    /** defines the scale used for calculating and displaying the rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank values are displayed on a 0–100 scale one_thousand — rank values are displayed on a 0–1000 scale default value: one_thousand learn more about how this parameter works in this Help Center article */
+    /** *defines the scale used for calculating and displaying the `rank` values* optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: `one_hundred` — rank values are displayed on a 0–100 scale `one_thousand` — rank values are displayed on a 0–1000 scale default value: `one_thousand` learn more about how this parameter works in [this Help Center article](https://dataforseo.com/help-center/using-the-rank_scale-parameter-in-content-analysis-api) */
     rank_scale?: 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 ContentAnalysisSummaryLiveRequestInfo implements IContentAnalysisSummaryLiveRequestInfo {
-    /** target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: 'keyword': '\'tesla palo alto\'' learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *target keyword* **required field** UTF-8 encoding the keywords will be converted to a lowercase format; **Note**: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;  example:  `'keyword': '\'tesla palo alto\''` learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
     keyword?: string | undefined;
-    /** target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you can indicate several fields; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: 'keyword_fields': {     'snippet': '\'logitech mouse\'',     'main_title': 'sale' } */
+    /** *target keyword fields and target keywords* optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: `title`, `main_title`, `previous_title`, `snippet` you can indicate several fields; **Note**: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;  example: `'keyword_fields': {'snippet': '\'logitech mouse\'','main_title': 'sale'}` */
     keyword_fields?: {
         [key: string]: string;
     } | undefined;
-    /** target page types optional field use this parameter to filter the dataset by page types possible values: 'ecommerce', 'news', 'blogs', 'message-boards', 'organization' */
+    /** *target page types* optional field use this parameter to filter the dataset by page types possible values:  `'ecommerce'`, `'news'`, `'blogs'`, `'message-boards'`, `'organization'` */
     page_type?: string[] | undefined;
-    /** maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages default value: 1 maximum value: 20 */
+    /** *maximum number of elements within internal arrays* optional field you can use this field to limit the number of elements within the following arrays: `top_domains` `text_categories` `page_categories` `countries` `languages` default value: `1` maximum value: `20` */
     internal_list_limit?: number | undefined;
-    /** positive connotation threshold optional field specified as the probability index threshold for positive sentiment related to the citation content if you specify this field, connotation_types object in the response will only contain data on citations with positive sentiment probability more than or equal to the specified value possible values: from 0 to 1 default value: 0.4 */
+    /** *positive connotation threshold* optional field specified as the probability index threshold for positive sentiment related to the citation content if you specify this field, `connotation_types` object in the response will only contain data on citations with `positive` sentiment probability more than or equal to the specified value possible values: from `0` to `1` default value: `0.4` */
     positive_connotation_threshold?: number | undefined;
-    /** sentiment connotation threshold optional field specified as the probability index threshold for sentiment connotations related to the citation content if you specify this field, sentiment_connotations object in the response will only contain data on citations where the probability per each sentiment is more than or equal to the specified value possible values: from 0 to 1 default value: 0.4 */
+    /** *sentiment connotation threshold* optional field specified as the probability index threshold for sentiment connotations related to the citation content if you specify this field, `sentiment_connotations` object in the response will only contain data on citations where the  probability per each sentiment is more than or equal to the specified value possible values: from `0` to `1` default value: `0.4` */
     sentiments_connotation_threshold?: number | undefined;
-    /** initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint 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, like,not_like, has, has_not you can use the % operator with like and not_like to match any string of zero or more characters example: ['domain','<>', 'logitech.com'] [['domain','<>','logitech.com'],'and',['content_info.connotation_types.negative','>',1000]] [['domain','<>','logitech.com']], 'and', [['content_info.connotation_types.negative','>',1000], 'or', ['content_info.text_category','has',10994]]] for more information about filters, please refer to Content Analysis API – Filters learn more about the initial dataset filters in this help center article. */
+    /** *initial dataset filtering parameters* optional field initial filtering parameters that apply to fields in the [Search endpoint](/v3/content_analysis/search/live/?bash) **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`, `like`,`not_like`, `has`, `has_not` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['domain','<>', 'logitech.com']` `[['domain','<>','logitech.com'],'and',['content_info.connotation_types.negative','>',1000]]` `[['domain',''and',[['content_info.connotation_types.negative','>',1000],'or',['content_info.text_category','has',10994]]]` for more information about filters, please refer to [Content Analysis API - Filters](/v3/content_analysis/filters) learn more about the initial dataset filters in [this help center article.](https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work) */
     initial_dataset_filters?: any[] | undefined;
-    /** defines the scale used for calculating and displaying the rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank values are displayed on a 0–100 scale one_thousand — rank values are displayed on a 0–1000 scale default value: one_thousand learn more about how this parameter works in this Help Center article */
+    /** *defines the scale used for calculating and displaying the `rank` values* optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: `one_hundred` — rank values are displayed on a 0–100 scale `one_thousand` — rank values are displayed on a 0–1000 scale default value: `one_thousand` learn more about how this parameter works in [this Help Center article](https://dataforseo.com/help-center/using-the-rank_scale-parameter-in-content-analysis-api) */
     rank_scale?: 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?: IContentAnalysisSummaryLiveRequestInfo);

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

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

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

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

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

@@ -1,18 +1,18 @@
 export interface ICountryDistribution {
-    /** country ISO code */
+    /** *country ISO code* */
     country_iso_code?: string | undefined;
-    /** clickstream-based average monthly search volume rate represents the (approximate) number of searches for the given keyword idea based on clickstream you can learn more about clickstream search volume in this Help Center article */
+    /** *clickstream-based average monthly search volume rate* represents the (approximate) number of searches for the given keyword idea based on clickstream you can learn more about clickstream search volume in [this Help Center article](https://dataforseo.com/help-center/what-is-clickstream-search-volume-and-how-to-get-it-with-dataforseo) */
     search_volume?: number | undefined;
-    /** percentage of global search volume */
+    /** *percentage of global search volume* */
     percentage?: number | undefined;
     [key: string]: any;
 }
 export declare class CountryDistribution implements ICountryDistribution {
-    /** country ISO code */
+    /** *country ISO code* */
     country_iso_code?: string | undefined;
-    /** clickstream-based average monthly search volume rate represents the (approximate) number of searches for the given keyword idea based on clickstream you can learn more about clickstream search volume in this Help Center article */
+    /** *clickstream-based average monthly search volume rate* represents the (approximate) number of searches for the given keyword idea based on clickstream you can learn more about clickstream search volume in [this Help Center article](https://dataforseo.com/help-center/what-is-clickstream-search-volume-and-how-to-get-it-with-dataforseo) */
     search_volume?: number | undefined;
-    /** percentage of global search volume */
+    /** *percentage of global search volume* */
     percentage?: number | undefined;
     [key: string]: any;
     constructor(data?: ICountryDistribution);

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

@@ -1,18 +1,18 @@
 export interface IDataforseoLabsAmazonBulkSearchVolumeLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keyword in a POST array */
+    /** *keyword in a POST array* */
     keyword?: string | undefined;
-    /** average monthly search volume rate represents the (approximate) number of searches for the returned keyword on Amazon */
+    /** *average monthly search volume rate* represents the (approximate) number of searches for the returned keyword on Amazon */
     search_volume?: number | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsAmazonBulkSearchVolumeLiveItem implements IDataforseoLabsAmazonBulkSearchVolumeLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keyword in a POST array */
+    /** *keyword in a POST array* */
     keyword?: string | undefined;
-    /** average monthly search volume rate represents the (approximate) number of searches for the returned keyword on Amazon */
+    /** *average monthly search volume rate* represents the (approximate) number of searches for the returned keyword on Amazon */
     search_volume?: number | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsAmazonBulkSearchVolumeLiveItem);