dataforseo-client 2.1.1 → 2.1.2

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

@@ -1,133 +1,133 @@
 import { TargetInfo } from "./TargetInfo";
 export interface IBacklinksSummaryLiveResultInfo {
-    /** target in a POST array */
+    /** *`target` in a POST array* */
     target?: string | undefined;
-    /** date and time when our crawler found the backlink for the target for the first time in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when our crawler found the backlink for the `target` for the first time* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     first_seen?: string | undefined;
-    /** date and time when the backlink was lost indicates the date and time when our crawler visited the target and it responded with a 4xx or 5xx status code or when its last backlink was removed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the backlink was lost* indicates the date and time when our crawler visited the target and it responded with a 4xx or 5xx status code or when its last backlink was removed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     lost_date?: string | undefined;
-    /** target rank learn more about the metric and how it is calculated in this help center article */
+    /** `target` rank 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) */
     rank?: number | undefined;
-    /** indicates the number of backlinks */
+    /** *indicates the number of backlinks* */
     backlinks?: number | undefined;
-    /** spam score of the backlinks displays the total spam score of all backlinks pointing to the target domain, subdomain, or webpage; to learn more about how the metric is calculated, refer to this Help Center page */
+    /** *spam score of the backlinks* displays the total spam score of all backlinks pointing to the `target` domain, subdomain, or webpage; to learn more about how the metric is calculated, refer to [this Help Center page](https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated) */
     backlinks_spam_score?: number | undefined;
-    /** number of crawled pages for the target */
+    /** *number of crawled pages for the `target`* */
     crawled_pages?: number | undefined;
-    /** information about the target */
+    /** *information about the `target`* */
     info?: TargetInfo | undefined;
-    /** number of internal links calculated as the sum of internal links on the pages of the specified target */
+    /** *number of internal links* calculated as the sum of internal links on the pages of the specified `target` */
     internal_links_count?: number | undefined;
-    /** number of external links on the page calculated as the sum of external links on the pages of the specified target */
+    /** *number of external links on the page* calculated as the sum of external links on the pages of the specified `target` */
     external_links_count?: number | undefined;
-    /** number of broken backlinks number of broken backlinks pointing to the target */
+    /** *number of broken backlinks* number of broken backlinks pointing to the `target` */
     broken_backlinks?: number | undefined;
-    /** number of broken pages number of pages on the target that respond with 4xx or 5xx status codes note that the number of broken pages includes pages on the target discovered by following external links, but it may also include pages discovered by following the target’s sitemap */
+    /** *number of broken pages* number of pages on the `target` that respond with 4xx or 5xx status codes note that the number of broken pages includes pages on the `target` discovered by following external links, but it may also include pages discovered by following the target's sitemap */
     broken_pages?: number | undefined;
-    /** indicates the number of referring domains referring domains include subdomains that are counted as separate domains for this metric */
+    /** *indicates the number of referring domains* referring domains include subdomains that are counted as separate domains for this metric */
     referring_domains?: number | undefined;
-    /** number of domains pointing at least one nofollow link to the target */
+    /** *number of domains pointing at least one nofollow link to the `target`* */
     referring_domains_nofollow?: number | undefined;
-    /** indicates the number of referring main domains */
+    /** *indicates the number of referring main domains* */
     referring_main_domains?: number | undefined;
-    /** number of main domains pointing at least one nofollow link to the target */
+    /** *number of main domains pointing at least one nofollow link to the `target`* */
     referring_main_domains_nofollow?: number | undefined;
-    /** number of referring IP addresses number of IP addresses pointing to this page */
+    /** *number of referring IP addresses* number of IP addresses pointing to this page */
     referring_ips?: number | undefined;
-    /** number of referring subnetworks */
+    /** *number of referring subnetworks* */
     referring_subnets?: number | undefined;
-    /** indicates the number of pages pointing to the target */
+    /** *indicates the number of pages pointing to the target* */
     referring_pages?: number | undefined;
-    /** number of referring pages pointing at least one nofollow link to the target */
+    /** *number of referring pages pointing at least one nofollow link to the `target`* */
     referring_pages_nofollow?: number | undefined;
-    /** top-level domains of the referring links contains top level domains and referring link count per each */
+    /** *top-level domains of the referring links* contains top level domains and referring link count per each */
     referring_links_tld?: {
         [key: string]: number;
     } | undefined;
-    /** types of referring links indicates the types of the referring links and link count per each type possible values: anchor, image, link, meta, canonical, alternate, redirect */
+    /** *types of referring links* indicates the types of the referring links and link count per each type possible values: `anchor`, `image`, `link`, `meta`, `canonical`, `alternate`, `redirect` */
     referring_links_types?: {
         [key: string]: number;
     } | undefined;
-    /** link attributes of the referring links indicates link attributes of the referring links and link count per each attribute example values: nofollow, noopener, noreferrer, external, ugc, sponsored */
+    /** *link attributes of the referring links* indicates link attributes of the referring links and link count per each attribute example values: `nofollow`, `noopener`, `noreferrer`, `external`, `ugc`, `sponsored` */
     referring_links_attributes?: {
         [key: string]: number;
     } | undefined;
-    /** types of referring platforms indicates referring platform types and and link count per each platform possible values: cms, blogs, ecommerce, message-boards, wikis, news, organization */
+    /** *types of referring platforms* indicates referring platform types and and link count per each platform possible values: `cms`, `blogs`, `ecommerce`, `message-boards`, `wikis`, `news`, `organization` */
     referring_links_platform_types?: {
         [key: string]: number;
     } | undefined;
-    /** semantic locations of the referring links indicates semantic elements in HTML where the referring links are located and link count per each semantic location you can get the full list of semantic elements here example values: article, section, summary, '' */
+    /** *semantic locations of the referring links* indicates semantic elements in HTML where the referring links are located and link count per each semantic location you can get the full list of semantic elements [here](https://www.w3schools.com/html/html5_semantic_elements.asp) example values: `article`, `section`, `summary`, `''` */
     referring_links_semantic_locations?: {
         [key: string]: number;
     } | undefined;
-    /** ISO country codes of the referring links indicates ISO country codes of the domains where the referring links are located and the link count per each country */
+    /** *ISO country codes of the referring links* indicates ISO country codes of the domains where the referring links are located and the link count per each country */
     referring_links_countries?: {
         [key: string]: number;
     } | undefined;
     [key: string]: any;
 }
 export declare class BacklinksSummaryLiveResultInfo implements IBacklinksSummaryLiveResultInfo {
-    /** target in a POST array */
+    /** *`target` in a POST array* */
     target?: string | undefined;
-    /** date and time when our crawler found the backlink for the target for the first time in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when our crawler found the backlink for the `target` for the first time* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     first_seen?: string | undefined;
-    /** date and time when the backlink was lost indicates the date and time when our crawler visited the target and it responded with a 4xx or 5xx status code or when its last backlink was removed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the backlink was lost* indicates the date and time when our crawler visited the target and it responded with a 4xx or 5xx status code or when its last backlink was removed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     lost_date?: string | undefined;
-    /** target rank learn more about the metric and how it is calculated in this help center article */
+    /** `target` rank 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) */
     rank?: number | undefined;
-    /** indicates the number of backlinks */
+    /** *indicates the number of backlinks* */
     backlinks?: number | undefined;
-    /** spam score of the backlinks displays the total spam score of all backlinks pointing to the target domain, subdomain, or webpage; to learn more about how the metric is calculated, refer to this Help Center page */
+    /** *spam score of the backlinks* displays the total spam score of all backlinks pointing to the `target` domain, subdomain, or webpage; to learn more about how the metric is calculated, refer to [this Help Center page](https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated) */
     backlinks_spam_score?: number | undefined;
-    /** number of crawled pages for the target */
+    /** *number of crawled pages for the `target`* */
     crawled_pages?: number | undefined;
-    /** information about the target */
+    /** *information about the `target`* */
     info?: TargetInfo | undefined;
-    /** number of internal links calculated as the sum of internal links on the pages of the specified target */
+    /** *number of internal links* calculated as the sum of internal links on the pages of the specified `target` */
     internal_links_count?: number | undefined;
-    /** number of external links on the page calculated as the sum of external links on the pages of the specified target */
+    /** *number of external links on the page* calculated as the sum of external links on the pages of the specified `target` */
     external_links_count?: number | undefined;
-    /** number of broken backlinks number of broken backlinks pointing to the target */
+    /** *number of broken backlinks* number of broken backlinks pointing to the `target` */
     broken_backlinks?: number | undefined;
-    /** number of broken pages number of pages on the target that respond with 4xx or 5xx status codes note that the number of broken pages includes pages on the target discovered by following external links, but it may also include pages discovered by following the target’s sitemap */
+    /** *number of broken pages* number of pages on the `target` that respond with 4xx or 5xx status codes note that the number of broken pages includes pages on the `target` discovered by following external links, but it may also include pages discovered by following the target's sitemap */
     broken_pages?: number | undefined;
-    /** indicates the number of referring domains referring domains include subdomains that are counted as separate domains for this metric */
+    /** *indicates the number of referring domains* referring domains include subdomains that are counted as separate domains for this metric */
     referring_domains?: number | undefined;
-    /** number of domains pointing at least one nofollow link to the target */
+    /** *number of domains pointing at least one nofollow link to the `target`* */
     referring_domains_nofollow?: number | undefined;
-    /** indicates the number of referring main domains */
+    /** *indicates the number of referring main domains* */
     referring_main_domains?: number | undefined;
-    /** number of main domains pointing at least one nofollow link to the target */
+    /** *number of main domains pointing at least one nofollow link to the `target`* */
     referring_main_domains_nofollow?: number | undefined;
-    /** number of referring IP addresses number of IP addresses pointing to this page */
+    /** *number of referring IP addresses* number of IP addresses pointing to this page */
     referring_ips?: number | undefined;
-    /** number of referring subnetworks */
+    /** *number of referring subnetworks* */
     referring_subnets?: number | undefined;
-    /** indicates the number of pages pointing to the target */
+    /** *indicates the number of pages pointing to the target* */
     referring_pages?: number | undefined;
-    /** number of referring pages pointing at least one nofollow link to the target */
+    /** *number of referring pages pointing at least one nofollow link to the `target`* */
     referring_pages_nofollow?: number | undefined;
-    /** top-level domains of the referring links contains top level domains and referring link count per each */
+    /** *top-level domains of the referring links* contains top level domains and referring link count per each */
     referring_links_tld?: {
         [key: string]: number;
     } | undefined;
-    /** types of referring links indicates the types of the referring links and link count per each type possible values: anchor, image, link, meta, canonical, alternate, redirect */
+    /** *types of referring links* indicates the types of the referring links and link count per each type possible values: `anchor`, `image`, `link`, `meta`, `canonical`, `alternate`, `redirect` */
     referring_links_types?: {
         [key: string]: number;
     } | undefined;
-    /** link attributes of the referring links indicates link attributes of the referring links and link count per each attribute example values: nofollow, noopener, noreferrer, external, ugc, sponsored */
+    /** *link attributes of the referring links* indicates link attributes of the referring links and link count per each attribute example values: `nofollow`, `noopener`, `noreferrer`, `external`, `ugc`, `sponsored` */
     referring_links_attributes?: {
         [key: string]: number;
     } | undefined;
-    /** types of referring platforms indicates referring platform types and and link count per each platform possible values: cms, blogs, ecommerce, message-boards, wikis, news, organization */
+    /** *types of referring platforms* indicates referring platform types and and link count per each platform possible values: `cms`, `blogs`, `ecommerce`, `message-boards`, `wikis`, `news`, `organization` */
     referring_links_platform_types?: {
         [key: string]: number;
     } | undefined;
-    /** semantic locations of the referring links indicates semantic elements in HTML where the referring links are located and link count per each semantic location you can get the full list of semantic elements here example values: article, section, summary, '' */
+    /** *semantic locations of the referring links* indicates semantic elements in HTML where the referring links are located and link count per each semantic location you can get the full list of semantic elements [here](https://www.w3schools.com/html/html5_semantic_elements.asp) example values: `article`, `section`, `summary`, `''` */
     referring_links_semantic_locations?: {
         [key: string]: number;
     } | undefined;
-    /** ISO country codes of the referring links indicates ISO country codes of the domains where the referring links are located and the link count per each country */
+    /** *ISO country codes of the referring links* indicates ISO country codes of the domains where the referring links are located and the link count per each country */
     referring_links_countries?: {
         [key: string]: number;
     } | undefined;

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

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

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

@@ -1,38 +1,38 @@
 export interface IBacklinksTimeseriesNewLostSummaryLiveItem {
     /** type of element */
     type?: string | undefined;
-    /** date and time when the data for the target was stored in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the data for the target was stored* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` */
     date?: string | undefined;
-    /** number of new backlinks number of new backlinks pointing to the target */
+    /** *number of new backlinks* number of new backlinks pointing to the `target` */
     new_backlinks?: number | undefined;
-    /** number of lost backlinks number of lost backlinks of the target */
+    /** *number of lost backlinks* number of lost backlinks of the `target` */
     lost_backlinks?: number | undefined;
-    /** number of new referring domains number of new referring domains pointing to the target */
+    /** *number of new referring domains* number of new referring domains pointing to the `target` */
     new_referring_domains?: number | undefined;
-    /** number of lost referring domains number of lost referring domains of the target */
+    /** *number of lost referring domains* number of lost referring domains of the `target` */
     lost_referring_domains?: number | undefined;
-    /** number of new referring main domains number of new referring main domains pointing to the target */
+    /** *number of new referring main domains* number of new referring main domains pointing to the `target` */
     new_referring_main_domains?: number | undefined;
-    /** number of lost referring main domains number of lost referring main domains of the target */
+    /** *number of lost referring main domains* number of lost referring main domains of the `target` */
     lost_referring_main_domains?: number | undefined;
     [key: string]: any;
 }
 export declare class BacklinksTimeseriesNewLostSummaryLiveItem implements IBacklinksTimeseriesNewLostSummaryLiveItem {
     /** type of element */
     type?: string | undefined;
-    /** date and time when the data for the target was stored in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the data for the target was stored* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` */
     date?: string | undefined;
-    /** number of new backlinks number of new backlinks pointing to the target */
+    /** *number of new backlinks* number of new backlinks pointing to the `target` */
     new_backlinks?: number | undefined;
-    /** number of lost backlinks number of lost backlinks of the target */
+    /** *number of lost backlinks* number of lost backlinks of the `target` */
     lost_backlinks?: number | undefined;
-    /** number of new referring domains number of new referring domains pointing to the target */
+    /** *number of new referring domains* number of new referring domains pointing to the `target` */
     new_referring_domains?: number | undefined;
-    /** number of lost referring domains number of lost referring domains of the target */
+    /** *number of lost referring domains* number of lost referring domains of the `target` */
     lost_referring_domains?: number | undefined;
-    /** number of new referring main domains number of new referring main domains pointing to the target */
+    /** *number of new referring main domains* number of new referring main domains pointing to the `target` */
     new_referring_main_domains?: number | undefined;
-    /** number of lost referring main domains number of lost referring main domains of the target */
+    /** *number of lost referring main domains* number of lost referring main domains of the `target` */
     lost_referring_main_domains?: number | undefined;
     [key: string]: any;
     constructor(data?: IBacklinksTimeseriesNewLostSummaryLiveItem);

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

@@ -1,30 +1,30 @@
 export interface IBacklinksTimeseriesNewLostSummaryLiveRequestInfo {
-    /** domain to get data for required field a domain should be specified without https:// and www. example: 'forbes.com' */
+    /** *domain to get data for* **required field** a domain should be specified without `https://` and `www.` example: `'forbes.com'` */
     target?: string | undefined;
-    /** starting date of the time range optional field this field indicates the date which will be used as a threshold for new and lost backlinks and referring domains; the backlinks and referring domains that appeared in our index after the specified date will be considered as new; the backlinks and referring domains that weren’t found after the specified date, but were present before, will be considered as lost; minimum value: 2019-01-30 maximum value shouldn’t exceed the date specified in the date_to date format: 'yyyy-mm-dd' example: '2021-01-01' */
+    /** *starting date of the time range* optional field this field indicates the date which will be used as a threshold for new and lost backlinks and referring domains; the backlinks and referring domains that appeared in our index after the specified date will be considered as new; the backlinks and referring domains that weren't found after the specified date, but were present before, will be considered as lost; minimum value: `2019-01-30` maximum value shouldn't exceed the date specified in the `date_to` date format: `'yyyy-mm-dd'` example: `'2021-01-01'` */
     date_from?: string | undefined;
-    /** ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default minimum value shouldn’t preceed the date specified in the date_from maximum value: today’s date date format: 'yyyy-mm-dd' example: '2021-01-15' */
+    /** *ending date of the time range* optional field if you don't specify this field, the today's date will be used by default minimum value shouldn't preceed the date specified in the `date_from` maximum value: today's date date format: `'yyyy-mm-dd'` example: `'2021-01-15'` */
     date_to?: string | undefined;
-    /** time range which will be used to group the results optional field default value: month possible values: day, week, month, year note: for day, we will return items corresponding to all dates between and including date_from and date_to; for week/month/year, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year for example, if you specify: 'group_range': 'month', 'date_from': '2022-03-23', 'date_to': '2022-05-13' we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31 if there is no data for a certain  day/week/month/year, we will return 0 */
+    /** *time range which will be used to group the results* optional field default value: `month` possible values: `day`, `week`, `month`, `year` **note:** for `day`, we will return items corresponding to all dates between and including `date_from` and `date_to`; for `week`/`month`/`year`, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year for example, if you specify:  `'group_range': 'month','date_from': '2022-03-23','date_to': '2022-05-13'` we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: `2022-03-31`, `2022-04-30`, `2022-05-31` if there is no data for a certain  `day`/`week`/`month`/`year`, we will return `0` */
     group_range?: string | undefined;
-    /** indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true */
+    /** *indicates if the subdomains of the `target` will be included in the search* optional field if set to `false`, the subdomains will be ignored default value: `true` */
     include_subdomains?: boolean | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
 }
 export declare class BacklinksTimeseriesNewLostSummaryLiveRequestInfo implements IBacklinksTimeseriesNewLostSummaryLiveRequestInfo {
-    /** domain to get data for required field a domain should be specified without https:// and www. example: 'forbes.com' */
+    /** *domain to get data for* **required field** a domain should be specified without `https://` and `www.` example: `'forbes.com'` */
     target?: string | undefined;
-    /** starting date of the time range optional field this field indicates the date which will be used as a threshold for new and lost backlinks and referring domains; the backlinks and referring domains that appeared in our index after the specified date will be considered as new; the backlinks and referring domains that weren’t found after the specified date, but were present before, will be considered as lost; minimum value: 2019-01-30 maximum value shouldn’t exceed the date specified in the date_to date format: 'yyyy-mm-dd' example: '2021-01-01' */
+    /** *starting date of the time range* optional field this field indicates the date which will be used as a threshold for new and lost backlinks and referring domains; the backlinks and referring domains that appeared in our index after the specified date will be considered as new; the backlinks and referring domains that weren't found after the specified date, but were present before, will be considered as lost; minimum value: `2019-01-30` maximum value shouldn't exceed the date specified in the `date_to` date format: `'yyyy-mm-dd'` example: `'2021-01-01'` */
     date_from?: string | undefined;
-    /** ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default minimum value shouldn’t preceed the date specified in the date_from maximum value: today’s date date format: 'yyyy-mm-dd' example: '2021-01-15' */
+    /** *ending date of the time range* optional field if you don't specify this field, the today's date will be used by default minimum value shouldn't preceed the date specified in the `date_from` maximum value: today's date date format: `'yyyy-mm-dd'` example: `'2021-01-15'` */
     date_to?: string | undefined;
-    /** time range which will be used to group the results optional field default value: month possible values: day, week, month, year note: for day, we will return items corresponding to all dates between and including date_from and date_to; for week/month/year, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year for example, if you specify: 'group_range': 'month', 'date_from': '2022-03-23', 'date_to': '2022-05-13' we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31 if there is no data for a certain  day/week/month/year, we will return 0 */
+    /** *time range which will be used to group the results* optional field default value: `month` possible values: `day`, `week`, `month`, `year` **note:** for `day`, we will return items corresponding to all dates between and including `date_from` and `date_to`; for `week`/`month`/`year`, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year for example, if you specify:  `'group_range': 'month','date_from': '2022-03-23','date_to': '2022-05-13'` we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: `2022-03-31`, `2022-04-30`, `2022-05-31` if there is no data for a certain  `day`/`week`/`month`/`year`, we will return `0` */
     group_range?: string | undefined;
-    /** indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true */
+    /** *indicates if the subdomains of the `target` will be included in the search* optional field if set to `false`, the subdomains will be ignored default value: `true` */
     include_subdomains?: boolean | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
     constructor(data?: IBacklinksTimeseriesNewLostSummaryLiveRequestInfo);

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

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

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

@@ -1,31 +1,31 @@
 import { BacklinksTimeseriesNewLostSummaryLiveItem } from "./BacklinksTimeseriesNewLostSummaryLiveItem";
 export interface IBacklinksTimeseriesNewLostSummaryLiveResultInfo {
-    /** target from a POST array */
+    /** *`target` from a POST array* */
     target?: string | undefined;
-    /** starting date of the time range in the UTC format: “yyyy-mm-dd” example: 2019-01-01 */
+    /** *starting date of the time range* in the UTC format: “yyyy-mm-dd” example: `2019-01-01` */
     date_from?: string | undefined;
-    /** ending date of the time range in the UTC format: 'yyyy-mm-dd' example: '2019-01-15' */
+    /** *ending date of the time range* in the UTC format: `'yyyy-mm-dd'` example: `'2019-01-15'` */
     date_to?: string | undefined;
-    /** group_range from the POST array */
+    /** *`group_range` from the POST array* */
     group_range?: string | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** contains relevant backlinks and referring domains data */
+    /** *contains relevant backlinks and referring domains data* */
     items?: BacklinksTimeseriesNewLostSummaryLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class BacklinksTimeseriesNewLostSummaryLiveResultInfo implements IBacklinksTimeseriesNewLostSummaryLiveResultInfo {
-    /** target from a POST array */
+    /** *`target` from a POST array* */
     target?: string | undefined;
-    /** starting date of the time range in the UTC format: “yyyy-mm-dd” example: 2019-01-01 */
+    /** *starting date of the time range* in the UTC format: “yyyy-mm-dd” example: `2019-01-01` */
     date_from?: string | undefined;
-    /** ending date of the time range in the UTC format: 'yyyy-mm-dd' example: '2019-01-15' */
+    /** *ending date of the time range* in the UTC format: `'yyyy-mm-dd'` example: `'2019-01-15'` */
     date_to?: string | undefined;
-    /** group_range from the POST array */
+    /** *`group_range` from the POST array* */
     group_range?: string | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** contains relevant backlinks and referring domains data */
+    /** *contains relevant backlinks and referring domains data* */
     items?: BacklinksTimeseriesNewLostSummaryLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IBacklinksTimeseriesNewLostSummaryLiveResultInfo);

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

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

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

@@ -1,58 +1,58 @@
 export interface IBacklinksTimeseriesSummaryLiveItem {
     /** type of element */
     type?: string | undefined;
-    /** date and time when the data for the target was stored in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the data for the target was stored* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` */
     date?: string | undefined;
-    /** target rank for the given date learn more about the metric and how it is calculated in this help center article */
+    /** *`target` rank for the given `date`* 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) */
     rank?: number | undefined;
-    /** number of backlinks for the given date */
+    /** *number of backlinks for the given `date`* */
     backlinks?: number | undefined;
-    /** number of nofollow backlinks for the given date */
+    /** *number of nofollow backlinks for the given `date`* */
     backlinks_nofollow?: number | undefined;
-    /** number of pages pointing to target for the given date */
+    /** *number of pages pointing to `target` for the given `date`* */
     referring_pages?: number | undefined;
-    /** number of referring pages pointing at least one nofollow link to the target for the given date */
+    /** *number of referring pages pointing at least one nofollow link to the `target` for the given `date`* */
     referring_pages_nofollow?: number | undefined;
-    /** number of referring domains for the given date referring domains include subdomains that are counted as separate domains for this metric */
+    /** *number of referring domains for the given `date`* referring domains include subdomains that are counted as separate domains for this metric */
     referring_domains?: number | undefined;
-    /** number of domains pointing at least one nofollow link to the target for the given date */
+    /** *number of domains pointing at least one nofollow link to the `target` for the given `date`* */
     referring_domains_nofollow?: number | undefined;
-    /** number of referring main domains for the given date */
+    /** *number of referring main domains for the given `date`* */
     referring_main_domains?: number | undefined;
-    /** number of main domains pointing at least one nofollow link to the target for the given date */
+    /** *number of main domains pointing at least one nofollow link to the `target` for the given `date`* */
     referring_main_domains_nofollow?: number | undefined;
-    /** number of referring IP addresses for the given date number of IP addresses pointing to this page */
+    /** *number of referring IP addresses for the given `date`* number of IP addresses pointing to this page */
     referring_ips?: number | undefined;
-    /** number of referring subnetworks for the given date */
+    /** *number of referring subnetworks for the given `date`* */
     referring_subnets?: number | undefined;
     [key: string]: any;
 }
 export declare class BacklinksTimeseriesSummaryLiveItem implements IBacklinksTimeseriesSummaryLiveItem {
     /** type of element */
     type?: string | undefined;
-    /** date and time when the data for the target was stored in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the data for the target was stored* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` */
     date?: string | undefined;
-    /** target rank for the given date learn more about the metric and how it is calculated in this help center article */
+    /** *`target` rank for the given `date`* 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) */
     rank?: number | undefined;
-    /** number of backlinks for the given date */
+    /** *number of backlinks for the given `date`* */
     backlinks?: number | undefined;
-    /** number of nofollow backlinks for the given date */
+    /** *number of nofollow backlinks for the given `date`* */
     backlinks_nofollow?: number | undefined;
-    /** number of pages pointing to target for the given date */
+    /** *number of pages pointing to `target` for the given `date`* */
     referring_pages?: number | undefined;
-    /** number of referring pages pointing at least one nofollow link to the target for the given date */
+    /** *number of referring pages pointing at least one nofollow link to the `target` for the given `date`* */
     referring_pages_nofollow?: number | undefined;
-    /** number of referring domains for the given date referring domains include subdomains that are counted as separate domains for this metric */
+    /** *number of referring domains for the given `date`* referring domains include subdomains that are counted as separate domains for this metric */
     referring_domains?: number | undefined;
-    /** number of domains pointing at least one nofollow link to the target for the given date */
+    /** *number of domains pointing at least one nofollow link to the `target` for the given `date`* */
     referring_domains_nofollow?: number | undefined;
-    /** number of referring main domains for the given date */
+    /** *number of referring main domains for the given `date`* */
     referring_main_domains?: number | undefined;
-    /** number of main domains pointing at least one nofollow link to the target for the given date */
+    /** *number of main domains pointing at least one nofollow link to the `target` for the given `date`* */
     referring_main_domains_nofollow?: number | undefined;
-    /** number of referring IP addresses for the given date number of IP addresses pointing to this page */
+    /** *number of referring IP addresses for the given `date`* number of IP addresses pointing to this page */
     referring_ips?: number | undefined;
-    /** number of referring subnetworks for the given date */
+    /** *number of referring subnetworks for the given `date`* */
     referring_subnets?: number | undefined;
     [key: string]: any;
     constructor(data?: IBacklinksTimeseriesSummaryLiveItem);

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

@@ -1,34 +1,34 @@
 export interface IBacklinksTimeseriesSummaryLiveRequestInfo {
-    /** domain to get data for required field a domain should be specified without https:// and www. example: 'forbes.com' */
+    /** *domain to get data for* **required field** a domain should be specified without `https://` and `www.` example: `'forbes.com'` */
     target?: string | undefined;
-    /** starting date of the time range optional field this field indicates the date which will be used as a threshold for summary data; minimum value: 2019-01-30 maximum value shouldn’t exceed the date specified in the date_to date format: 'yyyy-mm-dd' example: '2021-01-01' */
+    /** *starting date of the time range* optional field this field indicates the date which will be used as a threshold for summary data; minimum value: `2019-01-30` maximum value shouldn't exceed the date specified in the `date_to` date format: `'yyyy-mm-dd'` example: `'2021-01-01'` */
     date_from?: string | undefined;
-    /** ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default minimum value shouldn’t preceed the date specified in the date_from maximum value: today’s date date format: 'yyyy-mm-dd' example: '2021-01-15' */
+    /** *ending date of the time range* optional field if you don't specify this field, the today's date will be used by default minimum value shouldn't preceed the date specified in the `date_from` maximum value: today's date date format: `'yyyy-mm-dd'` example: `'2021-01-15'` */
     date_to?: string | undefined;
-    /** time range which will be used to group the results optional field default value: month possible values: day, week, month, year note: for day, we will return items corresponding to all dates between and including date_from and date_to; for week/month/year, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year for example, if you specify: 'group_range': 'month', 'date_from': '2022-03-23', 'date_to': '2022-05-13' we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31 if there is no data for a certain  day/week/month/year, we will return 0 */
+    /** *time range which will be used to group the results* optional field default value: `month` possible values: `day`, `week`, `month`, `year` **note:** for `day`, we will return items corresponding to all dates between and including `date_from` and `date_to`; for `week`/`month`/`year`, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year for example, if you specify:  `'group_range': 'month','date_from': '2022-03-23','date_to': '2022-05-13'` we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: `2022-03-31`, `2022-04-30`, `2022-05-31` if there is no data for a certain  `day`/`week`/`month`/`year`, we will return `0` */
     group_range?: string | undefined;
-    /** indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true */
+    /** *indicates if the subdomains of the `target` will be included in the search* optional field if set to `false`, the subdomains will be ignored default value: `true` */
     include_subdomains?: boolean | undefined;
-    /** defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_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 and how ranking metrics are calculated in this Help Center article */
+    /** *defines the scale used for calculating and displaying the `rank`, `domain_from_rank`, and `page_from_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 and how ranking metrics are calculated in [this Help Center article](https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale) */
     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 BacklinksTimeseriesSummaryLiveRequestInfo implements IBacklinksTimeseriesSummaryLiveRequestInfo {
-    /** domain to get data for required field a domain should be specified without https:// and www. example: 'forbes.com' */
+    /** *domain to get data for* **required field** a domain should be specified without `https://` and `www.` example: `'forbes.com'` */
     target?: string | undefined;
-    /** starting date of the time range optional field this field indicates the date which will be used as a threshold for summary data; minimum value: 2019-01-30 maximum value shouldn’t exceed the date specified in the date_to date format: 'yyyy-mm-dd' example: '2021-01-01' */
+    /** *starting date of the time range* optional field this field indicates the date which will be used as a threshold for summary data; minimum value: `2019-01-30` maximum value shouldn't exceed the date specified in the `date_to` date format: `'yyyy-mm-dd'` example: `'2021-01-01'` */
     date_from?: string | undefined;
-    /** ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default minimum value shouldn’t preceed the date specified in the date_from maximum value: today’s date date format: 'yyyy-mm-dd' example: '2021-01-15' */
+    /** *ending date of the time range* optional field if you don't specify this field, the today's date will be used by default minimum value shouldn't preceed the date specified in the `date_from` maximum value: today's date date format: `'yyyy-mm-dd'` example: `'2021-01-15'` */
     date_to?: string | undefined;
-    /** time range which will be used to group the results optional field default value: month possible values: day, week, month, year note: for day, we will return items corresponding to all dates between and including date_from and date_to; for week/month/year, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year for example, if you specify: 'group_range': 'month', 'date_from': '2022-03-23', 'date_to': '2022-05-13' we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31 if there is no data for a certain  day/week/month/year, we will return 0 */
+    /** *time range which will be used to group the results* optional field default value: `month` possible values: `day`, `week`, `month`, `year` **note:** for `day`, we will return items corresponding to all dates between and including `date_from` and `date_to`; for `week`/`month`/`year`, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year for example, if you specify:  `'group_range': 'month','date_from': '2022-03-23','date_to': '2022-05-13'` we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: `2022-03-31`, `2022-04-30`, `2022-05-31` if there is no data for a certain  `day`/`week`/`month`/`year`, we will return `0` */
     group_range?: string | undefined;
-    /** indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true */
+    /** *indicates if the subdomains of the `target` will be included in the search* optional field if set to `false`, the subdomains will be ignored default value: `true` */
     include_subdomains?: boolean | undefined;
-    /** defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_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 and how ranking metrics are calculated in this Help Center article */
+    /** *defines the scale used for calculating and displaying the `rank`, `domain_from_rank`, and `page_from_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 and how ranking metrics are calculated in [this Help Center article](https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale) */
     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?: IBacklinksTimeseriesSummaryLiveRequestInfo);

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

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