dataforseo-client 1.0.18 → 1.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/main.d.ts +2042 -815
  2. package/main.js +2903 -1149
  3. package/main.js.map +1 -1
  4. package/main.ts +4914 -1955
  5. package/package.json +1 -1
package/main.d.ts CHANGED
@@ -1096,12 +1096,23 @@ export declare class DataforseoLabsApi {
1096
1096
  */
1097
1097
  googleSearchIntentLive(body: (DataforseoLabsGoogleSearchIntentLiveRequestInfo | undefined)[] | undefined): Promise<DataforseoLabsGoogleSearchIntentLiveResponseInfo | null>;
1098
1098
  protected processGoogleSearchIntentLive(response: Response): Promise<DataforseoLabsGoogleSearchIntentLiveResponseInfo | null>;
1099
+ /**
1100
+ * @return Successful operation
1101
+ */
1102
+ dataforseoLabsGoogleCategoriesForKeywordsLanguages(): Promise<DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo | null>;
1103
+ protected processDataforseoLabsGoogleCategoriesForKeywordsLanguages(response: Response): Promise<DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo | null>;
1099
1104
  /**
1100
1105
  * @param body (optional)
1101
1106
  * @return Successful operation
1102
1107
  */
1103
1108
  googleCategoriesForDomainLive(body: (DataforseoLabsGoogleCategoriesForDomainLiveRequestInfo | undefined)[] | undefined): Promise<DataforseoLabsGoogleCategoriesForDomainLiveResponseInfo | null>;
1104
1109
  protected processGoogleCategoriesForDomainLive(response: Response): Promise<DataforseoLabsGoogleCategoriesForDomainLiveResponseInfo | null>;
1110
+ /**
1111
+ * @param body (optional)
1112
+ * @return Successful operation
1113
+ */
1114
+ googleCategoriesForKeywordsLive(body: (DataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo | undefined)[] | undefined): Promise<DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo | null>;
1115
+ protected processGoogleCategoriesForKeywordsLive(response: Response): Promise<DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo | null>;
1105
1116
  /**
1106
1117
  * @param body (optional)
1107
1118
  * @return Successful operation
@@ -1693,6 +1704,36 @@ export declare class KeywordsDataApi {
1693
1704
  */
1694
1705
  bingKeywordPerformanceLive(body: (KeywordsDataBingKeywordPerformanceLiveRequestInfo | undefined)[] | undefined): Promise<KeywordsDataBingKeywordPerformanceLiveResponseInfo | null>;
1695
1706
  protected processBingKeywordPerformanceLive(response: Response): Promise<KeywordsDataBingKeywordPerformanceLiveResponseInfo | null>;
1707
+ /**
1708
+ * @return Successful operation
1709
+ */
1710
+ keywordsDataBingSearchVolumeHistoryLocationsAndLanguages(): Promise<KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo | null>;
1711
+ protected processKeywordsDataBingSearchVolumeHistoryLocationsAndLanguages(response: Response): Promise<KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo | null>;
1712
+ /**
1713
+ * @param body (optional)
1714
+ * @return Successful operation
1715
+ */
1716
+ bingSearchVolumeHistoryTaskPost(body: (KeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo | undefined)[] | undefined): Promise<KeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo | null>;
1717
+ protected processBingSearchVolumeHistoryTaskPost(response: Response): Promise<KeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo | null>;
1718
+ /**
1719
+ * @return Successful operation
1720
+ */
1721
+ bingSearchVolumeHistoryTasksReady(): Promise<KeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo | null>;
1722
+ protected processBingSearchVolumeHistoryTasksReady(response: Response): Promise<KeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo | null>;
1723
+ /**
1724
+ * @param id task identifier
1725
+ unique task identifier in our system in the UUID format
1726
+ you will be able to use it within 30 days to request the results of the task at any time
1727
+ * @return Successful operation
1728
+ */
1729
+ bingSearchVolumeHistoryTaskGet(id: string): Promise<KeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo | null>;
1730
+ protected processBingSearchVolumeHistoryTaskGet(response: Response): Promise<KeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo | null>;
1731
+ /**
1732
+ * @param body (optional)
1733
+ * @return Successful operation
1734
+ */
1735
+ bingSearchVolumeHistoryLive(body: (KeywordsDataBingSearchVolumeHistoryLiveRequestInfo | undefined)[] | undefined): Promise<KeywordsDataBingSearchVolumeHistoryLiveResponseInfo | null>;
1736
+ protected processBingSearchVolumeHistoryLive(response: Response): Promise<KeywordsDataBingSearchVolumeHistoryLiveResponseInfo | null>;
1696
1737
  }
1697
1738
  export declare class BacklinksApi {
1698
1739
  private http;
@@ -2806,6 +2847,12 @@ export declare class BusinessDataApi {
2806
2847
  */
2807
2848
  googleMyBusinessInfoTaskGet(id: string): Promise<BusinessDataGoogleMyBusinessInfoTaskGetResponseInfo | null>;
2808
2849
  protected processGoogleMyBusinessInfoTaskGet(response: Response): Promise<BusinessDataGoogleMyBusinessInfoTaskGetResponseInfo | null>;
2850
+ /**
2851
+ * @param body (optional)
2852
+ * @return Successful operation
2853
+ */
2854
+ googleMyBusinessInfoLive(body: (BusinessDataTaskRequestInfo | undefined)[] | undefined): Promise<BusinessDataGoogleMyBusinessInfoLiveResponseInfo | null>;
2855
+ protected processGoogleMyBusinessInfoLive(response: Response): Promise<BusinessDataGoogleMyBusinessInfoLiveResponseInfo | null>;
2809
2856
  /**
2810
2857
  * @param body (optional)
2811
2858
  * @return Successful operation
@@ -3651,6 +3698,34 @@ raw price string as provided in the result */
3651
3698
  displayed_price?: string | undefined;
3652
3699
  [key: string]: any;
3653
3700
  }
3701
+ export declare class RatingInfo implements IRatingInfo {
3702
+ /** the type of rating
3703
+ here you can find the following elements: Max5, Percents, CustomMax */
3704
+ rating_type?: string | undefined;
3705
+ /** the value of the rating */
3706
+ value?: number | undefined;
3707
+ /** the amount of feedback */
3708
+ votes_count?: number | undefined;
3709
+ /** the maximum value for a rating_type */
3710
+ rating_max?: number | undefined;
3711
+ [key: string]: any;
3712
+ constructor(data?: IRatingInfo);
3713
+ init(_data?: any): void;
3714
+ static fromJS(data: any): RatingInfo;
3715
+ toJSON(data?: any): any;
3716
+ }
3717
+ export interface IRatingInfo {
3718
+ /** the type of rating
3719
+ here you can find the following elements: Max5, Percents, CustomMax */
3720
+ rating_type?: string | undefined;
3721
+ /** the value of the rating */
3722
+ value?: number | undefined;
3723
+ /** the amount of feedback */
3724
+ votes_count?: number | undefined;
3725
+ /** the maximum value for a rating_type */
3726
+ rating_max?: number | undefined;
3727
+ [key: string]: any;
3728
+ }
3654
3729
  export declare class SocialMetricsInfo implements ISocialMetricsInfo {
3655
3730
  /** type of element */
3656
3731
  type?: string | undefined;
@@ -6516,34 +6591,6 @@ export interface IAdLinkElement {
6516
6591
  ad_aclk?: string | undefined;
6517
6592
  [key: string]: any;
6518
6593
  }
6519
- export declare class RatingInfo implements IRatingInfo {
6520
- /** the type of rating
6521
- here you can find the following elements: Max5, Percents, CustomMax */
6522
- rating_type?: string | undefined;
6523
- /** the value of the rating */
6524
- value?: number | undefined;
6525
- /** the amount of feedback */
6526
- votes_count?: number | undefined;
6527
- /** the maximum value for a rating_type */
6528
- rating_max?: number | undefined;
6529
- [key: string]: any;
6530
- constructor(data?: IRatingInfo);
6531
- init(_data?: any): void;
6532
- static fromJS(data: any): RatingInfo;
6533
- toJSON(data?: any): any;
6534
- }
6535
- export interface IRatingInfo {
6536
- /** the type of rating
6537
- here you can find the following elements: Max5, Percents, CustomMax */
6538
- rating_type?: string | undefined;
6539
- /** the value of the rating */
6540
- value?: number | undefined;
6541
- /** the amount of feedback */
6542
- votes_count?: number | undefined;
6543
- /** the maximum value for a rating_type */
6544
- rating_max?: number | undefined;
6545
- [key: string]: any;
6546
- }
6547
6594
  export declare class FaqBoxElement implements IFaqBoxElement {
6548
6595
  /** type of element */
6549
6596
  type?: string | undefined;
@@ -10714,6 +10761,70 @@ the popularity rate based on reviews and displayed in SERP */
10714
10761
  rating?: RatingInfo | undefined;
10715
10762
  [key: string]: any;
10716
10763
  }
10764
+ export declare class CoursesSerpElementItem extends BaseSerpElementItem implements ICoursesSerpElementItem {
10765
+ /** group rank in SERP
10766
+ position within a group of elements with identical type values;
10767
+ positions of elements with different type values are omitted from rank_group;
10768
+ always equals 0 for desktop */
10769
+ rank_group?: number | undefined;
10770
+ /** absolute rank in SERP
10771
+ absolute position among all the elements in SERP
10772
+ always equals 0 for desktop */
10773
+ rank_absolute?: number | undefined;
10774
+ /** the alignment of the element in SERP
10775
+ can take the following values:
10776
+ left, right */
10777
+ position?: string | undefined;
10778
+ /** the XPath of the element */
10779
+ xpath?: string | undefined;
10780
+ /** title of the row */
10781
+ title?: string | undefined;
10782
+ /** array of course categories
10783
+ contains a list of categories relevant to courses */
10784
+ categories?: (string | undefined)[] | undefined;
10785
+ /** additional items present in the element
10786
+ if there are none, equals null */
10787
+ items?: (CoursesElement | undefined)[] | undefined;
10788
+ /** rectangle parameters
10789
+ contains cartesian coordinates and pixel dimensions of the result’s snippet in SERP
10790
+ equals null if calculate_rectangles in the POST request is not set to true */
10791
+ rectangle?: Rectangle | undefined;
10792
+ [key: string]: any;
10793
+ constructor(data?: ICoursesSerpElementItem);
10794
+ init(_data?: any): void;
10795
+ static fromJS(data: any): CoursesSerpElementItem;
10796
+ toJSON(data?: any): any;
10797
+ }
10798
+ export interface ICoursesSerpElementItem extends IBaseSerpElementItem {
10799
+ /** group rank in SERP
10800
+ position within a group of elements with identical type values;
10801
+ positions of elements with different type values are omitted from rank_group;
10802
+ always equals 0 for desktop */
10803
+ rank_group?: number | undefined;
10804
+ /** absolute rank in SERP
10805
+ absolute position among all the elements in SERP
10806
+ always equals 0 for desktop */
10807
+ rank_absolute?: number | undefined;
10808
+ /** the alignment of the element in SERP
10809
+ can take the following values:
10810
+ left, right */
10811
+ position?: string | undefined;
10812
+ /** the XPath of the element */
10813
+ xpath?: string | undefined;
10814
+ /** title of the row */
10815
+ title?: string | undefined;
10816
+ /** array of course categories
10817
+ contains a list of categories relevant to courses */
10818
+ categories?: (string | undefined)[] | undefined;
10819
+ /** additional items present in the element
10820
+ if there are none, equals null */
10821
+ items?: (CoursesElement | undefined)[] | undefined;
10822
+ /** rectangle parameters
10823
+ contains cartesian coordinates and pixel dimensions of the result’s snippet in SERP
10824
+ equals null if calculate_rectangles in the POST request is not set to true */
10825
+ rectangle?: Rectangle | undefined;
10826
+ [key: string]: any;
10827
+ }
10717
10828
  export declare class SerpGoogleOrganicTaskGetAdvancedResultInfo implements ISerpGoogleOrganicTaskGetAdvancedResultInfo {
10718
10829
  /** keyword received in a POST array
10719
10830
  the keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character) */
@@ -10740,7 +10851,7 @@ if the search engine provided results for a keyword that was corrected, we will
10740
10851
  /** types of search results in SERP
10741
10852
  contains types of search results (items) found in SERP.
10742
10853
  possible item types:
10743
- answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box,product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites */
10854
+ answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box,product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites, courses */
10744
10855
  item_types?: (string | undefined)[] | undefined;
10745
10856
  /** total number of results in SERP */
10746
10857
  se_results_count?: number | undefined;
@@ -10780,7 +10891,7 @@ if the search engine provided results for a keyword that was corrected, we will
10780
10891
  /** types of search results in SERP
10781
10892
  contains types of search results (items) found in SERP.
10782
10893
  possible item types:
10783
- answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box,product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites */
10894
+ answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box,product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites, courses */
10784
10895
  item_types?: (string | undefined)[] | undefined;
10785
10896
  /** total number of results in SERP */
10786
10897
  se_results_count?: number | undefined;
@@ -11632,7 +11743,7 @@ if the search engine provided results for a keyword that was corrected, we will
11632
11743
  /** types of search results in SERP
11633
11744
  contains types of search results (items) found in SERP.
11634
11745
  possible item types:
11635
- answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites */
11746
+ answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites, courses */
11636
11747
  item_types?: (string | undefined)[] | undefined;
11637
11748
  /** total number of results in SERP */
11638
11749
  se_results_count?: number | undefined;
@@ -11673,7 +11784,7 @@ if the search engine provided results for a keyword that was corrected, we will
11673
11784
  /** types of search results in SERP
11674
11785
  contains types of search results (items) found in SERP.
11675
11786
  possible item types:
11676
- answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites */
11787
+ answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites, courses */
11677
11788
  item_types?: (string | undefined)[] | undefined;
11678
11789
  /** total number of results in SERP */
11679
11790
  se_results_count?: number | undefined;
@@ -26466,6 +26577,28 @@ export interface ISerpNaverOrganicTaskGetRegularResponseInfo extends IBaseRespon
26466
26577
  tasks?: (SerpNaverOrganicTaskGetRegularTaskInfo | undefined)[] | undefined;
26467
26578
  [key: string]: any;
26468
26579
  }
26580
+ export declare class Price implements IPrice {
26581
+ current?: number | undefined;
26582
+ regular?: number | undefined;
26583
+ max_value?: number | undefined;
26584
+ currency?: string | undefined;
26585
+ is_price_range?: boolean | undefined;
26586
+ displayed_price?: string | undefined;
26587
+ [key: string]: any;
26588
+ constructor(data?: IPrice);
26589
+ init(_data?: any): void;
26590
+ static fromJS(data: any): Price;
26591
+ toJSON(data?: any): any;
26592
+ }
26593
+ export interface IPrice {
26594
+ current?: number | undefined;
26595
+ regular?: number | undefined;
26596
+ max_value?: number | undefined;
26597
+ currency?: string | undefined;
26598
+ is_price_range?: boolean | undefined;
26599
+ displayed_price?: string | undefined;
26600
+ [key: string]: any;
26601
+ }
26469
26602
  export declare class SerpNaverOrganicTaskGetAdvancedResultInfo implements ISerpNaverOrganicTaskGetAdvancedResultInfo {
26470
26603
  /** keyword received in a POST array
26471
26604
  the keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character) */
@@ -33029,7 +33162,7 @@ if false, the results are returned for Google search sites only */
33029
33162
  keyword_info?: KeywordInfo | undefined;
33030
33163
  /** clickstream data for the returned keyword
33031
33164
  to retrieve results for this field, the parameter include_clickstream_data must be set to true */
33032
- clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
33165
+ clickstream_keyword_info?: any | undefined;
33033
33166
  /** additional information about the keyword */
33034
33167
  keyword_properties?: KeywordProperties | undefined;
33035
33168
  /** impressions data for the returned keyword idea
@@ -33041,6 +33174,9 @@ learn more about impressions in this help center article */
33041
33174
  /** SERP data
33042
33175
  the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
33043
33176
  serp_info?: SerpInfo | undefined;
33177
+ /** backlink data for the returned keyword
33178
+ this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
33179
+ avg_backlinks_info?: AvgBacklinksInfo | undefined;
33044
33180
  [key: string]: any;
33045
33181
  constructor(data?: IDataforseoLabsGoogleHistoricalSearchVolumeLiveItem);
33046
33182
  init(_data?: any): void;
@@ -33066,7 +33202,7 @@ if false, the results are returned for Google search sites only */
33066
33202
  keyword_info?: KeywordInfo | undefined;
33067
33203
  /** clickstream data for the returned keyword
33068
33204
  to retrieve results for this field, the parameter include_clickstream_data must be set to true */
33069
- clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
33205
+ clickstream_keyword_info?: any | undefined;
33070
33206
  /** additional information about the keyword */
33071
33207
  keyword_properties?: KeywordProperties | undefined;
33072
33208
  /** impressions data for the returned keyword idea
@@ -33078,6 +33214,9 @@ learn more about impressions in this help center article */
33078
33214
  /** SERP data
33079
33215
  the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
33080
33216
  serp_info?: SerpInfo | undefined;
33217
+ /** backlink data for the returned keyword
33218
+ this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
33219
+ avg_backlinks_info?: AvgBacklinksInfo | undefined;
33081
33220
  [key: string]: any;
33082
33221
  }
33083
33222
  export declare class DataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo implements IDataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo {
@@ -33532,6 +33671,52 @@ export interface IDataforseoLabsGoogleSearchIntentLiveResponseInfo extends IBase
33532
33671
  tasks?: (DataforseoLabsGoogleSearchIntentLiveTaskInfo | undefined)[] | undefined;
33533
33672
  [key: string]: any;
33534
33673
  }
33674
+ export declare class DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo {
33675
+ /** language name */
33676
+ language_name?: string | undefined;
33677
+ /** language code according to ISO 639-1 */
33678
+ language_code?: string | undefined;
33679
+ [key: string]: any;
33680
+ constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo);
33681
+ init(_data?: any): void;
33682
+ static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo;
33683
+ toJSON(data?: any): any;
33684
+ }
33685
+ export interface IDataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo {
33686
+ /** language name */
33687
+ language_name?: string | undefined;
33688
+ /** language code according to ISO 639-1 */
33689
+ language_code?: string | undefined;
33690
+ [key: string]: any;
33691
+ }
33692
+ export declare class DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo {
33693
+ /** array of results */
33694
+ result?: (DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo | undefined)[] | undefined;
33695
+ [key: string]: any;
33696
+ constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo);
33697
+ init(_data?: any): void;
33698
+ static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo;
33699
+ toJSON(data?: any): any;
33700
+ }
33701
+ export interface IDataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo extends IBaseResponseTaskInfo {
33702
+ /** array of results */
33703
+ result?: (DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo | undefined)[] | undefined;
33704
+ [key: string]: any;
33705
+ }
33706
+ export declare class DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo extends BaseResponseInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo {
33707
+ /** array of tasks */
33708
+ tasks?: (DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo | undefined)[] | undefined;
33709
+ [key: string]: any;
33710
+ constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo);
33711
+ init(_data?: any): void;
33712
+ static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo;
33713
+ toJSON(data?: any): any;
33714
+ }
33715
+ export interface IDataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo extends IBaseResponseInfo {
33716
+ /** array of tasks */
33717
+ tasks?: (DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo | undefined)[] | undefined;
33718
+ [key: string]: any;
33719
+ }
33535
33720
  export declare class DataforseoLabsGoogleCategoriesForDomainLiveRequestInfo implements IDataforseoLabsGoogleCategoriesForDomainLiveRequestInfo {
33536
33721
  /** domain or subdomain
33537
33722
  required field
@@ -34004,6 +34189,142 @@ export interface IDataforseoLabsGoogleCategoriesForDomainLiveResponseInfo extend
34004
34189
  tasks?: (DataforseoLabsGoogleCategoriesForDomainLiveTaskInfo | undefined)[] | undefined;
34005
34190
  [key: string]: any;
34006
34191
  }
34192
+ export declare class DataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo {
34193
+ /** target keywords
34194
+ required field
34195
+ UTF-8 encoding
34196
+ maximum number of keywords you can specify in this array: 1000
34197
+ each keyword should be at least 3 characters long;
34198
+ the keywords will be converted to lowercase format */
34199
+ keywords?: string[];
34200
+ /** full name of the language
34201
+ required field if don’t specify language_code
34202
+ you can receive the list of available languages with their language_name by making a separate request to the
34203
+ https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages
34204
+ example:
34205
+ English */
34206
+ language_name?: string | undefined;
34207
+ /** language code
34208
+ required field if don’t specify language_name
34209
+ you can receive the list of available languages with their language_code by making a separate request to the
34210
+ https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages
34211
+ example:
34212
+ en */
34213
+ language_code?: string | undefined;
34214
+ /** user-defined task identifier
34215
+ optional field
34216
+ the character limit is 255
34217
+ you can use this parameter to identify the task and match it with the result
34218
+ you will find the specified tag value in the data object of the response */
34219
+ tag?: string | undefined;
34220
+ [key: string]: any;
34221
+ constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo);
34222
+ init(_data?: any): void;
34223
+ static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo;
34224
+ toJSON(data?: any): any;
34225
+ }
34226
+ export interface IDataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo {
34227
+ /** target keywords
34228
+ required field
34229
+ UTF-8 encoding
34230
+ maximum number of keywords you can specify in this array: 1000
34231
+ each keyword should be at least 3 characters long;
34232
+ the keywords will be converted to lowercase format */
34233
+ keywords?: string[];
34234
+ /** full name of the language
34235
+ required field if don’t specify language_code
34236
+ you can receive the list of available languages with their language_name by making a separate request to the
34237
+ https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages
34238
+ example:
34239
+ English */
34240
+ language_name?: string | undefined;
34241
+ /** language code
34242
+ required field if don’t specify language_name
34243
+ you can receive the list of available languages with their language_code by making a separate request to the
34244
+ https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages
34245
+ example:
34246
+ en */
34247
+ language_code?: string | undefined;
34248
+ /** user-defined task identifier
34249
+ optional field
34250
+ the character limit is 255
34251
+ you can use this parameter to identify the task and match it with the result
34252
+ you will find the specified tag value in the data object of the response */
34253
+ tag?: string | undefined;
34254
+ [key: string]: any;
34255
+ }
34256
+ export declare class DataforseoLabsGoogleCategoriesForKeywordsLiveItem implements IDataforseoLabsGoogleCategoriesForKeywordsLiveItem {
34257
+ /** keyword in a POST array */
34258
+ keyword?: string | undefined;
34259
+ /** product and service categories
34260
+ you can download the full list of possible categories */
34261
+ categories?: number[] | undefined;
34262
+ [key: string]: any;
34263
+ constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLiveItem);
34264
+ init(_data?: any): void;
34265
+ static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLiveItem;
34266
+ toJSON(data?: any): any;
34267
+ }
34268
+ export interface IDataforseoLabsGoogleCategoriesForKeywordsLiveItem {
34269
+ /** keyword in a POST array */
34270
+ keyword?: string | undefined;
34271
+ /** product and service categories
34272
+ you can download the full list of possible categories */
34273
+ categories?: number[] | undefined;
34274
+ [key: string]: any;
34275
+ }
34276
+ export declare class DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo {
34277
+ /** language code in a POST array
34278
+ if there is no data, then the value is null */
34279
+ language_code?: string | undefined;
34280
+ /** the number of results returned in the items array */
34281
+ items_count?: number | undefined;
34282
+ /** contains keywords and related keyword difficulty scores */
34283
+ items?: (DataforseoLabsGoogleCategoriesForKeywordsLiveItem | undefined)[] | undefined;
34284
+ [key: string]: any;
34285
+ constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo);
34286
+ init(_data?: any): void;
34287
+ static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo;
34288
+ toJSON(data?: any): any;
34289
+ }
34290
+ export interface IDataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo {
34291
+ /** language code in a POST array
34292
+ if there is no data, then the value is null */
34293
+ language_code?: string | undefined;
34294
+ /** the number of results returned in the items array */
34295
+ items_count?: number | undefined;
34296
+ /** contains keywords and related keyword difficulty scores */
34297
+ items?: (DataforseoLabsGoogleCategoriesForKeywordsLiveItem | undefined)[] | undefined;
34298
+ [key: string]: any;
34299
+ }
34300
+ export declare class DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo {
34301
+ /** array of results */
34302
+ result?: (DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo | undefined)[] | undefined;
34303
+ [key: string]: any;
34304
+ constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo);
34305
+ init(_data?: any): void;
34306
+ static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo;
34307
+ toJSON(data?: any): any;
34308
+ }
34309
+ export interface IDataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo extends IBaseResponseTaskInfo {
34310
+ /** array of results */
34311
+ result?: (DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo | undefined)[] | undefined;
34312
+ [key: string]: any;
34313
+ }
34314
+ export declare class DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo extends BaseResponseInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo {
34315
+ /** array of tasks */
34316
+ tasks?: (DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo | undefined)[] | undefined;
34317
+ [key: string]: any;
34318
+ constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo);
34319
+ init(_data?: any): void;
34320
+ static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo;
34321
+ toJSON(data?: any): any;
34322
+ }
34323
+ export interface IDataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo extends IBaseResponseInfo {
34324
+ /** array of tasks */
34325
+ tasks?: (DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo | undefined)[] | undefined;
34326
+ [key: string]: any;
34327
+ }
34007
34328
  export declare class DataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo implements IDataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo {
34008
34329
  /** product and service categories
34009
34330
  required field
@@ -34068,7 +34389,7 @@ default value: false */
34068
34389
  ignore_synonyms?: boolean | undefined;
34069
34390
  /** the maximum number of keywords in the results array
34070
34391
  optional field
34071
- default value: 700
34392
+ default value: 100
34072
34393
  maximum value: 1000 */
34073
34394
  limit?: number | undefined;
34074
34395
  /** offset in the results array of returned keywords
@@ -34195,7 +34516,7 @@ default value: false */
34195
34516
  ignore_synonyms?: boolean | undefined;
34196
34517
  /** the maximum number of keywords in the results array
34197
34518
  optional field
34198
- default value: 700
34519
+ default value: 100
34199
34520
  maximum value: 1000 */
34200
34521
  limit?: number | undefined;
34201
34522
  /** offset in the results array of returned keywords
@@ -36424,8 +36745,8 @@ represents the number of search results in SERP relevant to the domain for the s
36424
36745
  /** keyword positions
36425
36746
  SERP positions the related domain holds in SERP for the specified keywords */
36426
36747
  keywords_positions?: {
36427
- [key: string]: number[];
36428
- };
36748
+ [key: string]: (number | undefined)[];
36749
+ } | undefined;
36429
36750
  [key: string]: any;
36430
36751
  constructor(data?: IDataforseoLabsSerpCompetitorsLiveItem);
36431
36752
  init(_data?: any): void;
@@ -36466,8 +36787,8 @@ represents the number of search results in SERP relevant to the domain for the s
36466
36787
  /** keyword positions
36467
36788
  SERP positions the related domain holds in SERP for the specified keywords */
36468
36789
  keywords_positions?: {
36469
- [key: string]: number[];
36470
- };
36790
+ [key: string]: (number | undefined)[];
36791
+ } | undefined;
36471
36792
  [key: string]: any;
36472
36793
  }
36473
36794
  export declare class DataforseoLabsGoogleSerpCompetitorsLiveResultInfo implements IDataforseoLabsGoogleSerpCompetitorsLiveResultInfo {
@@ -37213,10 +37534,10 @@ export declare class DataforseoLabsGoogleDomainIntersectionLiveItem implements I
37213
37534
  se_type?: string | undefined;
37214
37535
  /** keyword data for the returned keyword */
37215
37536
  keyword_data?: KeywordDataInfo | undefined;
37216
- /** contains data on the first domain's SERP element found for the returned keyword
37537
+ /** contains data on the first domains SERP element found for the returned keyword
37217
37538
  the list of supported SERP elements can be found below */
37218
37539
  first_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
37219
- /** contains data on the second domain's SERP element found for the returned keyword
37540
+ /** contains data on the second domains SERP element found for the returned keyword
37220
37541
  the list of supported SERP elements can be found below */
37221
37542
  second_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
37222
37543
  [key: string]: any;
@@ -37230,10 +37551,10 @@ export interface IDataforseoLabsGoogleDomainIntersectionLiveItem {
37230
37551
  se_type?: string | undefined;
37231
37552
  /** keyword data for the returned keyword */
37232
37553
  keyword_data?: KeywordDataInfo | undefined;
37233
- /** contains data on the first domain's SERP element found for the returned keyword
37554
+ /** contains data on the first domains SERP element found for the returned keyword
37234
37555
  the list of supported SERP elements can be found below */
37235
37556
  first_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
37236
- /** contains data on the second domain's SERP element found for the returned keyword
37557
+ /** contains data on the second domains SERP element found for the returned keyword
37237
37558
  the list of supported SERP elements can be found below */
37238
37559
  second_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
37239
37560
  [key: string]: any;
@@ -38324,11 +38645,10 @@ you will find the specified tag value in the data object of the response */
38324
38645
  tag?: string | undefined;
38325
38646
  [key: string]: any;
38326
38647
  }
38327
- export declare class KnowledgeGraphDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IKnowledgeGraphDataforseoLabsSerpElementItem {
38648
+ export declare class PeopleAlsoAskDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IPeopleAlsoAskDataforseoLabsSerpElementItem {
38328
38649
  /** search engine type */
38329
38650
  se_type?: string | undefined;
38330
- /** group rank in SERP
38331
- position within a group of elements with identical type values
38651
+ /** position within a group of elements with identical type values
38332
38652
  positions of elements with different type values are omitted from rank_group */
38333
38653
  rank_group?: number | undefined;
38334
38654
  /** absolute rank in SERP
@@ -38340,35 +38660,18 @@ left, right */
38340
38660
  position?: string | undefined;
38341
38661
  /** the XPath of the element */
38342
38662
  xpath?: string | undefined;
38343
- /** title of the result in SERP */
38344
- title?: string | undefined;
38345
- /** subtitle of the item */
38346
- sub_title?: string | undefined;
38347
- /** description of the results element in SERP */
38348
- description?: string | undefined;
38349
- /** card id */
38350
- card_id?: string | undefined;
38351
- /** relevant URL in SERP */
38352
- url?: string | undefined;
38353
- /** URL of the image from knowledge graph */
38354
- image_url?: string | undefined;
38355
- /** URL of the logo from knowledge graph */
38356
- logo_url?: string | undefined;
38357
- /** google-defined client id */
38358
- cid?: string | undefined;
38359
38663
  /** elements of search results found in SERP */
38360
38664
  items?: (PeopleAlsoAskElement | undefined)[] | undefined;
38361
38665
  [key: string]: any;
38362
- constructor(data?: IKnowledgeGraphDataforseoLabsSerpElementItem);
38666
+ constructor(data?: IPeopleAlsoAskDataforseoLabsSerpElementItem);
38363
38667
  init(_data?: any): void;
38364
- static fromJS(data: any): KnowledgeGraphDataforseoLabsSerpElementItem;
38668
+ static fromJS(data: any): PeopleAlsoAskDataforseoLabsSerpElementItem;
38365
38669
  toJSON(data?: any): any;
38366
38670
  }
38367
- export interface IKnowledgeGraphDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
38671
+ export interface IPeopleAlsoAskDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
38368
38672
  /** search engine type */
38369
38673
  se_type?: string | undefined;
38370
- /** group rank in SERP
38371
- position within a group of elements with identical type values
38674
+ /** position within a group of elements with identical type values
38372
38675
  positions of elements with different type values are omitted from rank_group */
38373
38676
  rank_group?: number | undefined;
38374
38677
  /** absolute rank in SERP
@@ -38380,31 +38683,14 @@ left, right */
38380
38683
  position?: string | undefined;
38381
38684
  /** the XPath of the element */
38382
38685
  xpath?: string | undefined;
38383
- /** title of the result in SERP */
38384
- title?: string | undefined;
38385
- /** subtitle of the item */
38386
- sub_title?: string | undefined;
38387
- /** description of the results element in SERP */
38388
- description?: string | undefined;
38389
- /** card id */
38390
- card_id?: string | undefined;
38391
- /** relevant URL in SERP */
38392
- url?: string | undefined;
38393
- /** URL of the image from knowledge graph */
38394
- image_url?: string | undefined;
38395
- /** URL of the logo from knowledge graph */
38396
- logo_url?: string | undefined;
38397
- /** google-defined client id */
38398
- cid?: string | undefined;
38399
38686
  /** elements of search results found in SERP */
38400
38687
  items?: (PeopleAlsoAskElement | undefined)[] | undefined;
38401
38688
  [key: string]: any;
38402
38689
  }
38403
- export declare class PeopleAlsoAskDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IPeopleAlsoAskDataforseoLabsSerpElementItem {
38690
+ export declare class TwitterDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements ITwitterDataforseoLabsSerpElementItem {
38404
38691
  /** search engine type */
38405
38692
  se_type?: string | undefined;
38406
- /** group rank in SERP
38407
- position within a group of elements with identical type values
38693
+ /** position within a group of elements with identical type values
38408
38694
  positions of elements with different type values are omitted from rank_group */
38409
38695
  rank_group?: number | undefined;
38410
38696
  /** absolute rank in SERP
@@ -38416,19 +38702,22 @@ left, right */
38416
38702
  position?: string | undefined;
38417
38703
  /** the XPath of the element */
38418
38704
  xpath?: string | undefined;
38705
+ /** title of the result in SERP */
38706
+ title?: string | undefined;
38707
+ /** relevant URL of the Ad element in SERP */
38708
+ url?: string | undefined;
38419
38709
  /** elements of search results found in SERP */
38420
- items?: (PeopleAlsoAskElement | undefined)[] | undefined;
38710
+ items?: (TwitterElement | undefined)[] | undefined;
38421
38711
  [key: string]: any;
38422
- constructor(data?: IPeopleAlsoAskDataforseoLabsSerpElementItem);
38712
+ constructor(data?: ITwitterDataforseoLabsSerpElementItem);
38423
38713
  init(_data?: any): void;
38424
- static fromJS(data: any): PeopleAlsoAskDataforseoLabsSerpElementItem;
38714
+ static fromJS(data: any): TwitterDataforseoLabsSerpElementItem;
38425
38715
  toJSON(data?: any): any;
38426
38716
  }
38427
- export interface IPeopleAlsoAskDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
38717
+ export interface ITwitterDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
38428
38718
  /** search engine type */
38429
38719
  se_type?: string | undefined;
38430
- /** group rank in SERP
38431
- position within a group of elements with identical type values
38720
+ /** position within a group of elements with identical type values
38432
38721
  positions of elements with different type values are omitted from rank_group */
38433
38722
  rank_group?: number | undefined;
38434
38723
  /** absolute rank in SERP
@@ -38440,8 +38729,12 @@ left, right */
38440
38729
  position?: string | undefined;
38441
38730
  /** the XPath of the element */
38442
38731
  xpath?: string | undefined;
38732
+ /** title of the result in SERP */
38733
+ title?: string | undefined;
38734
+ /** relevant URL of the Ad element in SERP */
38735
+ url?: string | undefined;
38443
38736
  /** elements of search results found in SERP */
38444
- items?: (PeopleAlsoAskElement | undefined)[] | undefined;
38737
+ items?: (TwitterElement | undefined)[] | undefined;
38445
38738
  [key: string]: any;
38446
38739
  }
38447
38740
  export declare class PeopleAlsoSearchDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IPeopleAlsoSearchDataforseoLabsSerpElementItem {
@@ -38459,10 +38752,9 @@ left, right */
38459
38752
  position?: string | undefined;
38460
38753
  /** the XPath of the element */
38461
38754
  xpath?: string | undefined;
38462
- /** title of the item */
38755
+ /** title of the result in SERP */
38463
38756
  title?: string | undefined;
38464
- /** additional items present in the element
38465
- if there are none, equals null */
38757
+ /** elements of search results found in SERP */
38466
38758
  items?: (string | undefined)[] | undefined;
38467
38759
  [key: string]: any;
38468
38760
  constructor(data?: IPeopleAlsoSearchDataforseoLabsSerpElementItem);
@@ -38485,10 +38777,9 @@ left, right */
38485
38777
  position?: string | undefined;
38486
38778
  /** the XPath of the element */
38487
38779
  xpath?: string | undefined;
38488
- /** title of the item */
38780
+ /** title of the result in SERP */
38489
38781
  title?: string | undefined;
38490
- /** additional items present in the element
38491
- if there are none, equals null */
38782
+ /** elements of search results found in SERP */
38492
38783
  items?: (string | undefined)[] | undefined;
38493
38784
  [key: string]: any;
38494
38785
  }
@@ -38507,8 +38798,7 @@ left, right */
38507
38798
  position?: string | undefined;
38508
38799
  /** the XPath of the element */
38509
38800
  xpath?: string | undefined;
38510
- /** additional items present in the element
38511
- if there are none, equals null */
38801
+ /** elements of search results found in SERP */
38512
38802
  items?: (string | undefined)[] | undefined;
38513
38803
  [key: string]: any;
38514
38804
  constructor(data?: IRelatedSearchesDataforseoLabsSerpElementItem);
@@ -38531,8 +38821,7 @@ left, right */
38531
38821
  position?: string | undefined;
38532
38822
  /** the XPath of the element */
38533
38823
  xpath?: string | undefined;
38534
- /** additional items present in the element
38535
- if there are none, equals null */
38824
+ /** elements of search results found in SERP */
38536
38825
  items?: (string | undefined)[] | undefined;
38537
38826
  [key: string]: any;
38538
38827
  }
@@ -38584,6 +38873,52 @@ if there are none, equals null */
38584
38873
  links?: (LinkElement | undefined)[] | undefined;
38585
38874
  [key: string]: any;
38586
38875
  }
38876
+ export declare class KnowledgeGraphImagesItemDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IKnowledgeGraphImagesItemDataforseoLabsSerpElementItem {
38877
+ /** group rank in SERP
38878
+ position within a group of elements with identical type values
38879
+ positions of elements with different type values are omitted from rank_group */
38880
+ rank_group?: number | undefined;
38881
+ /** absolute rank in SERP
38882
+ absolute position among all the elements in SERP */
38883
+ rank_absolute?: number | undefined;
38884
+ /** the alignment of the element in SERP
38885
+ can take the following values:
38886
+ left, right */
38887
+ position?: string | undefined;
38888
+ /** the XPath of the element */
38889
+ xpath?: string | undefined;
38890
+ /** link of the element */
38891
+ link?: LinkElement | undefined;
38892
+ /** additional items present in the element
38893
+ if there are none, equals null */
38894
+ items?: (KnowledgeGraphImagesElement | undefined)[] | undefined;
38895
+ [key: string]: any;
38896
+ constructor(data?: IKnowledgeGraphImagesItemDataforseoLabsSerpElementItem);
38897
+ init(_data?: any): void;
38898
+ static fromJS(data: any): KnowledgeGraphImagesItemDataforseoLabsSerpElementItem;
38899
+ toJSON(data?: any): any;
38900
+ }
38901
+ export interface IKnowledgeGraphImagesItemDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
38902
+ /** group rank in SERP
38903
+ position within a group of elements with identical type values
38904
+ positions of elements with different type values are omitted from rank_group */
38905
+ rank_group?: number | undefined;
38906
+ /** absolute rank in SERP
38907
+ absolute position among all the elements in SERP */
38908
+ rank_absolute?: number | undefined;
38909
+ /** the alignment of the element in SERP
38910
+ can take the following values:
38911
+ left, right */
38912
+ position?: string | undefined;
38913
+ /** the XPath of the element */
38914
+ xpath?: string | undefined;
38915
+ /** link of the element */
38916
+ link?: LinkElement | undefined;
38917
+ /** additional items present in the element
38918
+ if there are none, equals null */
38919
+ items?: (KnowledgeGraphImagesElement | undefined)[] | undefined;
38920
+ [key: string]: any;
38921
+ }
38587
38922
  export declare class KnowledgeGraphRowItemDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IKnowledgeGraphRowItemDataforseoLabsSerpElementItem {
38588
38923
  /** group rank in SERP
38589
38924
  position within a group of elements with identical type values
@@ -38598,7 +38933,7 @@ left, right */
38598
38933
  position?: string | undefined;
38599
38934
  /** the XPath of the element */
38600
38935
  xpath?: string | undefined;
38601
- /** title of the link */
38936
+ /** title of the item */
38602
38937
  title?: string | undefined;
38603
38938
  /** google defined data attribute ID
38604
38939
  example:
@@ -38630,7 +38965,7 @@ left, right */
38630
38965
  position?: string | undefined;
38631
38966
  /** the XPath of the element */
38632
38967
  xpath?: string | undefined;
38633
- /** title of the link */
38968
+ /** title of the item */
38634
38969
  title?: string | undefined;
38635
38970
  /** google defined data attribute ID
38636
38971
  example:
@@ -38658,7 +38993,7 @@ left, right */
38658
38993
  position?: string | undefined;
38659
38994
  /** the XPath of the element */
38660
38995
  xpath?: string | undefined;
38661
- /** title of the result in SERP */
38996
+ /** title of the link */
38662
38997
  title?: string | undefined;
38663
38998
  /** google defined data attribute ID
38664
38999
  example:
@@ -38689,7 +39024,7 @@ left, right */
38689
39024
  position?: string | undefined;
38690
39025
  /** the XPath of the element */
38691
39026
  xpath?: string | undefined;
38692
- /** title of the result in SERP */
39027
+ /** title of the link */
38693
39028
  title?: string | undefined;
38694
39029
  /** google defined data attribute ID
38695
39030
  example:
@@ -38702,50 +39037,81 @@ if there are none, equals null */
38702
39037
  items?: (KnowledgeGraphListElement | undefined)[] | undefined;
38703
39038
  [key: string]: any;
38704
39039
  }
38705
- export declare class DataforseoLabsGoogleHistoricalSerpsLiveItem implements IDataforseoLabsGoogleHistoricalSerpsLiveItem {
39040
+ export declare class KnowledgeGraphDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IKnowledgeGraphDataforseoLabsSerpElementItem {
38706
39041
  /** search engine type */
38707
39042
  se_type?: string | undefined;
38708
- /** keyword obtained as a result of search engine autocorrection
38709
- the results will be provided for the corrected keyword */
38710
- keyword?: string | undefined;
38711
- /** type of element */
38712
- type?: string | undefined;
38713
- /** search engine domain in a POST array */
38714
- se_domain?: string | undefined;
38715
- /** location code in a POST array */
38716
- location_code?: number | undefined;
38717
- /** language code in a POST array */
38718
- language_code?: string | undefined;
38719
- /** direct URL to search engine results
38720
- you can use it to make sure that we provided accurate results */
38721
- check_url?: string | undefined;
38722
- /** date and time when the result was received
38723
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
38724
- example:
38725
- 2019-11-15 12:57:46 +00:00 */
38726
- datetime?: string | undefined;
38727
- /** autocorrection of the search engine
38728
- if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
38729
- spell?: SpellInfo | undefined;
38730
- /** types of search results in SERP
38731
- contains types of search results (items) found in SERP.
38732
- possible item types:
38733
- answer_box, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver */
38734
- item_types?: (string | undefined)[] | undefined;
38735
- /** total number of results in SERP */
38736
- se_results_count?: number | undefined;
38737
- /** the number of results returned in the items array */
38738
- items_count?: number | undefined;
38739
- /** additional items present in the element
38740
- if there are none, equals null */
39043
+ /** position within a group of elements with identical type values
39044
+ positions of elements with different type values are omitted from rank_group */
39045
+ rank_group?: number | undefined;
39046
+ /** absolute rank in SERP
39047
+ absolute position among all the elements in SERP */
39048
+ rank_absolute?: number | undefined;
39049
+ /** the alignment of the element in SERP
39050
+ can take the following values:
39051
+ left, right */
39052
+ position?: string | undefined;
39053
+ /** the XPath of the element */
39054
+ xpath?: string | undefined;
39055
+ /** title of the result in SERP */
39056
+ title?: string | undefined;
39057
+ /** subtitle of the item */
39058
+ sub_title?: string | undefined;
39059
+ /** description of the results element in SERP */
39060
+ description?: string | undefined;
39061
+ /** card id */
39062
+ card_id?: string | undefined;
39063
+ /** relevant URL of the Ad element in SERP */
39064
+ url?: string | undefined;
39065
+ /** URL of the image from knowledge graph */
39066
+ image_url?: string | undefined;
39067
+ /** URL of the logo from knowledge graph */
39068
+ logo_url?: string | undefined;
39069
+ /** google-defined client id */
39070
+ cid?: string | undefined;
39071
+ /** elements of search results found in SERP */
38741
39072
  items?: (BaseDataforseoLabsSerpElementItem | undefined)[] | undefined;
38742
39073
  [key: string]: any;
38743
- constructor(data?: IDataforseoLabsGoogleHistoricalSerpsLiveItem);
39074
+ constructor(data?: IKnowledgeGraphDataforseoLabsSerpElementItem);
38744
39075
  init(_data?: any): void;
38745
- static fromJS(data: any): DataforseoLabsGoogleHistoricalSerpsLiveItem;
39076
+ static fromJS(data: any): KnowledgeGraphDataforseoLabsSerpElementItem;
38746
39077
  toJSON(data?: any): any;
38747
39078
  }
38748
- export interface IDataforseoLabsGoogleHistoricalSerpsLiveItem {
39079
+ export interface IKnowledgeGraphDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
39080
+ /** search engine type */
39081
+ se_type?: string | undefined;
39082
+ /** position within a group of elements with identical type values
39083
+ positions of elements with different type values are omitted from rank_group */
39084
+ rank_group?: number | undefined;
39085
+ /** absolute rank in SERP
39086
+ absolute position among all the elements in SERP */
39087
+ rank_absolute?: number | undefined;
39088
+ /** the alignment of the element in SERP
39089
+ can take the following values:
39090
+ left, right */
39091
+ position?: string | undefined;
39092
+ /** the XPath of the element */
39093
+ xpath?: string | undefined;
39094
+ /** title of the result in SERP */
39095
+ title?: string | undefined;
39096
+ /** subtitle of the item */
39097
+ sub_title?: string | undefined;
39098
+ /** description of the results element in SERP */
39099
+ description?: string | undefined;
39100
+ /** card id */
39101
+ card_id?: string | undefined;
39102
+ /** relevant URL of the Ad element in SERP */
39103
+ url?: string | undefined;
39104
+ /** URL of the image from knowledge graph */
39105
+ image_url?: string | undefined;
39106
+ /** URL of the logo from knowledge graph */
39107
+ logo_url?: string | undefined;
39108
+ /** google-defined client id */
39109
+ cid?: string | undefined;
39110
+ /** elements of search results found in SERP */
39111
+ items?: (BaseDataforseoLabsSerpElementItem | undefined)[] | undefined;
39112
+ [key: string]: any;
39113
+ }
39114
+ export declare class DataforseoLabsGoogleHistoricalSerpsLiveItem implements IDataforseoLabsGoogleHistoricalSerpsLiveItem {
38749
39115
  /** search engine type */
38750
39116
  se_type?: string | undefined;
38751
39117
  /** keyword obtained as a result of search engine autocorrection
@@ -38783,103 +39149,48 @@ answer_box, carousel, multi_carousel, featured_snippet, google_flights, google_r
38783
39149
  if there are none, equals null */
38784
39150
  items?: (BaseDataforseoLabsSerpElementItem | undefined)[] | undefined;
38785
39151
  [key: string]: any;
38786
- }
38787
- export declare class TwitterDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements ITwitterDataforseoLabsSerpElementItem {
38788
- /** search engine type */
38789
- se_type?: string | undefined;
38790
- /** position within a group of elements with identical type values
38791
- positions of elements with different type values are omitted from rank_group */
38792
- rank_group?: number | undefined;
38793
- /** absolute rank in SERP
38794
- absolute position among all the elements in SERP */
38795
- rank_absolute?: number | undefined;
38796
- /** the alignment of the element in SERP
38797
- can take the following values:
38798
- left, right */
38799
- position?: string | undefined;
38800
- /** the XPath of the element */
38801
- xpath?: string | undefined;
38802
- /** title of the item */
38803
- title?: string | undefined;
38804
- /** URL link */
38805
- url?: string | undefined;
38806
- /** additional items present in the element
38807
- if there are none, equals null */
38808
- items?: (TwitterElement | undefined)[] | undefined;
38809
- [key: string]: any;
38810
- constructor(data?: ITwitterDataforseoLabsSerpElementItem);
39152
+ constructor(data?: IDataforseoLabsGoogleHistoricalSerpsLiveItem);
38811
39153
  init(_data?: any): void;
38812
- static fromJS(data: any): TwitterDataforseoLabsSerpElementItem;
39154
+ static fromJS(data: any): DataforseoLabsGoogleHistoricalSerpsLiveItem;
38813
39155
  toJSON(data?: any): any;
38814
39156
  }
38815
- export interface ITwitterDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
39157
+ export interface IDataforseoLabsGoogleHistoricalSerpsLiveItem {
38816
39158
  /** search engine type */
38817
39159
  se_type?: string | undefined;
38818
- /** position within a group of elements with identical type values
38819
- positions of elements with different type values are omitted from rank_group */
38820
- rank_group?: number | undefined;
38821
- /** absolute rank in SERP
38822
- absolute position among all the elements in SERP */
38823
- rank_absolute?: number | undefined;
38824
- /** the alignment of the element in SERP
38825
- can take the following values:
38826
- left, right */
38827
- position?: string | undefined;
38828
- /** the XPath of the element */
38829
- xpath?: string | undefined;
38830
- /** title of the item */
38831
- title?: string | undefined;
38832
- /** URL link */
38833
- url?: string | undefined;
38834
- /** additional items present in the element
38835
- if there are none, equals null */
38836
- items?: (TwitterElement | undefined)[] | undefined;
38837
- [key: string]: any;
38838
- }
38839
- export declare class KnowledgeGraphImagesItemDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IKnowledgeGraphImagesItemDataforseoLabsSerpElementItem {
38840
- /** group rank in SERP
38841
- position within a group of elements with identical type values
38842
- positions of elements with different type values are omitted from rank_group */
38843
- rank_group?: number | undefined;
38844
- /** absolute rank in SERP
38845
- absolute position among all the elements in SERP */
38846
- rank_absolute?: number | undefined;
38847
- /** the alignment of the element in SERP
38848
- can take the following values:
38849
- left, right */
38850
- position?: string | undefined;
38851
- /** the XPath of the element */
38852
- xpath?: string | undefined;
38853
- /** link of the element */
38854
- link?: LinkElement | undefined;
38855
- /** additional items present in the element
38856
- if there are none, equals null */
38857
- items?: (KnowledgeGraphImagesElement | undefined)[] | undefined;
38858
- [key: string]: any;
38859
- constructor(data?: IKnowledgeGraphImagesItemDataforseoLabsSerpElementItem);
38860
- init(_data?: any): void;
38861
- static fromJS(data: any): KnowledgeGraphImagesItemDataforseoLabsSerpElementItem;
38862
- toJSON(data?: any): any;
38863
- }
38864
- export interface IKnowledgeGraphImagesItemDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
38865
- /** group rank in SERP
38866
- position within a group of elements with identical type values
38867
- positions of elements with different type values are omitted from rank_group */
38868
- rank_group?: number | undefined;
38869
- /** absolute rank in SERP
38870
- absolute position among all the elements in SERP */
38871
- rank_absolute?: number | undefined;
38872
- /** the alignment of the element in SERP
38873
- can take the following values:
38874
- left, right */
38875
- position?: string | undefined;
38876
- /** the XPath of the element */
38877
- xpath?: string | undefined;
38878
- /** link of the element */
38879
- link?: LinkElement | undefined;
39160
+ /** keyword obtained as a result of search engine autocorrection
39161
+ the results will be provided for the corrected keyword */
39162
+ keyword?: string | undefined;
39163
+ /** type of element */
39164
+ type?: string | undefined;
39165
+ /** search engine domain in a POST array */
39166
+ se_domain?: string | undefined;
39167
+ /** location code in a POST array */
39168
+ location_code?: number | undefined;
39169
+ /** language code in a POST array */
39170
+ language_code?: string | undefined;
39171
+ /** direct URL to search engine results
39172
+ you can use it to make sure that we provided accurate results */
39173
+ check_url?: string | undefined;
39174
+ /** date and time when the result was received
39175
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
39176
+ example:
39177
+ 2019-11-15 12:57:46 +00:00 */
39178
+ datetime?: string | undefined;
39179
+ /** autocorrection of the search engine
39180
+ if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
39181
+ spell?: SpellInfo | undefined;
39182
+ /** types of search results in SERP
39183
+ contains types of search results (items) found in SERP.
39184
+ possible item types:
39185
+ answer_box, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver */
39186
+ item_types?: (string | undefined)[] | undefined;
39187
+ /** total number of results in SERP */
39188
+ se_results_count?: number | undefined;
39189
+ /** the number of results returned in the items array */
39190
+ items_count?: number | undefined;
38880
39191
  /** additional items present in the element
38881
39192
  if there are none, equals null */
38882
- items?: (KnowledgeGraphImagesElement | undefined)[] | undefined;
39193
+ items?: (BaseDataforseoLabsSerpElementItem | undefined)[] | undefined;
38883
39194
  [key: string]: any;
38884
39195
  }
38885
39196
  export declare class DataforseoLabsGoogleHistoricalSerpsLiveResultInfo implements IDataforseoLabsGoogleHistoricalSerpsLiveResultInfo {
@@ -38954,7 +39265,8 @@ left, right */
38954
39265
  xpath?: string | undefined;
38955
39266
  /** title of the result in SERP */
38956
39267
  title?: string | undefined;
38957
- /** elements of search results found in SERP */
39268
+ /** additional items present in the element
39269
+ if there are none, equals null */
38958
39270
  items?: (CarouselElement | undefined)[] | undefined;
38959
39271
  [key: string]: any;
38960
39272
  constructor(data?: ICarouselDataforseoLabsSerpElementItem);
@@ -38978,7 +39290,8 @@ left, right */
38978
39290
  xpath?: string | undefined;
38979
39291
  /** title of the result in SERP */
38980
39292
  title?: string | undefined;
38981
- /** elements of search results found in SERP */
39293
+ /** additional items present in the element
39294
+ if there are none, equals null */
38982
39295
  items?: (CarouselElement | undefined)[] | undefined;
38983
39296
  [key: string]: any;
38984
39297
  }
@@ -38996,7 +39309,8 @@ left, right */
38996
39309
  position?: string | undefined;
38997
39310
  /** the XPath of the element */
38998
39311
  xpath?: string | undefined;
38999
- /** elements of search results found in SERP */
39312
+ /** additional items present in the element
39313
+ if there are none, equals null */
39000
39314
  items?: (MultiCarouselElement | undefined)[] | undefined;
39001
39315
  [key: string]: any;
39002
39316
  constructor(data?: IMultiCarouselDataforseoLabsSerpElementItem);
@@ -39018,7 +39332,8 @@ left, right */
39018
39332
  position?: string | undefined;
39019
39333
  /** the XPath of the element */
39020
39334
  xpath?: string | undefined;
39021
- /** elements of search results found in SERP */
39335
+ /** additional items present in the element
39336
+ if there are none, equals null */
39022
39337
  items?: (MultiCarouselElement | undefined)[] | undefined;
39023
39338
  [key: string]: any;
39024
39339
  }
@@ -39036,7 +39351,8 @@ left, right */
39036
39351
  position?: string | undefined;
39037
39352
  /** the XPath of the element */
39038
39353
  xpath?: string | undefined;
39039
- /** elements of search results found in SERP */
39354
+ /** additional items present in the element
39355
+ if there are none, equals null */
39040
39356
  items?: (TopStoriesElement | undefined)[] | undefined;
39041
39357
  [key: string]: any;
39042
39358
  constructor(data?: ITopStoriesDataforseoLabsSerpElementItem);
@@ -39058,7 +39374,8 @@ left, right */
39058
39374
  position?: string | undefined;
39059
39375
  /** the XPath of the element */
39060
39376
  xpath?: string | undefined;
39061
- /** elements of search results found in SERP */
39377
+ /** additional items present in the element
39378
+ if there are none, equals null */
39062
39379
  items?: (TopStoriesElement | undefined)[] | undefined;
39063
39380
  [key: string]: any;
39064
39381
  }
@@ -39131,7 +39448,8 @@ left, right */
39131
39448
  /** solution to the equation
39132
39449
  solution to the mathematical equation specified in the keyword field when setting a task */
39133
39450
  result?: string | undefined;
39134
- /** elements of search results found in SERP */
39451
+ /** additional items present in the element
39452
+ if there are none, equals null */
39135
39453
  items?: (MathSolverElement | undefined)[] | undefined;
39136
39454
  /** sitelinks
39137
39455
  the links shown below some of Google’s search results
@@ -39162,7 +39480,8 @@ left, right */
39162
39480
  /** solution to the equation
39163
39481
  solution to the mathematical equation specified in the keyword field when setting a task */
39164
39482
  result?: string | undefined;
39165
- /** elements of search results found in SERP */
39483
+ /** additional items present in the element
39484
+ if there are none, equals null */
39166
39485
  items?: (MathSolverElement | undefined)[] | undefined;
39167
39486
  /** sitelinks
39168
39487
  the links shown below some of Google’s search results
@@ -39184,7 +39503,8 @@ left, right */
39184
39503
  position?: string | undefined;
39185
39504
  /** the XPath of the element */
39186
39505
  xpath?: string | undefined;
39187
- /** elements of search results found in SERP */
39506
+ /** additional items present in the element
39507
+ if there are none, equals null */
39188
39508
  items?: (VideoElement | undefined)[] | undefined;
39189
39509
  [key: string]: any;
39190
39510
  constructor(data?: IVideoDataforseoLabsSerpElementItem);
@@ -39206,7 +39526,8 @@ left, right */
39206
39526
  position?: string | undefined;
39207
39527
  /** the XPath of the element */
39208
39528
  xpath?: string | undefined;
39209
- /** elements of search results found in SERP */
39529
+ /** additional items present in the element
39530
+ if there are none, equals null */
39210
39531
  items?: (VideoElement | undefined)[] | undefined;
39211
39532
  [key: string]: any;
39212
39533
  }
@@ -39223,9 +39544,9 @@ left, right */
39223
39544
  position?: string | undefined;
39224
39545
  /** the XPath of the element */
39225
39546
  xpath?: string | undefined;
39226
- /** title of the item */
39547
+ /** title of the result in SERP */
39227
39548
  title?: string | undefined;
39228
- /** URL link */
39549
+ /** relevant URL of the Ad element in SERP */
39229
39550
  url?: string | undefined;
39230
39551
  [key: string]: any;
39231
39552
  constructor(data?: IMapDataforseoLabsSerpElementItem);
@@ -39246,9 +39567,9 @@ left, right */
39246
39567
  position?: string | undefined;
39247
39568
  /** the XPath of the element */
39248
39569
  xpath?: string | undefined;
39249
- /** title of the item */
39570
+ /** title of the result in SERP */
39250
39571
  title?: string | undefined;
39251
- /** URL link */
39572
+ /** relevant URL of the Ad element in SERP */
39252
39573
  url?: string | undefined;
39253
39574
  [key: string]: any;
39254
39575
  }
@@ -39267,13 +39588,13 @@ left, right */
39267
39588
  xpath?: string | undefined;
39268
39589
  /** domain where a link points */
39269
39590
  domain?: string | undefined;
39270
- /** title of the item */
39591
+ /** title of the result in SERP */
39271
39592
  title?: string | undefined;
39272
- /** title of a given element */
39593
+ /** title */
39273
39594
  featured_title?: string | undefined;
39274
39595
  /** description of the results element in SERP */
39275
39596
  description?: string | undefined;
39276
- /** URL link */
39597
+ /** relevant URL of the Ad element in SERP */
39277
39598
  url?: string | undefined;
39278
39599
  /** results table
39279
39600
  if there are none, equals null */
@@ -39321,13 +39642,13 @@ left, right */
39321
39642
  xpath?: string | undefined;
39322
39643
  /** domain where a link points */
39323
39644
  domain?: string | undefined;
39324
- /** title of the item */
39645
+ /** title of the result in SERP */
39325
39646
  title?: string | undefined;
39326
- /** title of a given element */
39647
+ /** title */
39327
39648
  featured_title?: string | undefined;
39328
39649
  /** description of the results element in SERP */
39329
39650
  description?: string | undefined;
39330
- /** URL link */
39651
+ /** relevant URL of the Ad element in SERP */
39331
39652
  url?: string | undefined;
39332
39653
  /** results table
39333
39654
  if there are none, equals null */
@@ -39369,7 +39690,7 @@ left, right */
39369
39690
  position?: string | undefined;
39370
39691
  /** the XPath of the element */
39371
39692
  xpath?: string | undefined;
39372
- /** title of the item */
39693
+ /** title of the result in SERP */
39373
39694
  title?: string | undefined;
39374
39695
  /** description of the results element in SERP */
39375
39696
  description?: string | undefined;
@@ -39377,7 +39698,7 @@ left, right */
39377
39698
  domain?: string | undefined;
39378
39699
  /** phone number */
39379
39700
  phone?: string | undefined;
39380
- /** URL link */
39701
+ /** relevant URL of the Ad element in SERP */
39381
39702
  url?: string | undefined;
39382
39703
  /** indicates whether the element is an ad */
39383
39704
  is_paid?: boolean | undefined;
@@ -39426,7 +39747,7 @@ left, right */
39426
39747
  position?: string | undefined;
39427
39748
  /** the XPath of the element */
39428
39749
  xpath?: string | undefined;
39429
- /** title of the item */
39750
+ /** title of the result in SERP */
39430
39751
  title?: string | undefined;
39431
39752
  /** description of the results element in SERP */
39432
39753
  description?: string | undefined;
@@ -39434,7 +39755,7 @@ left, right */
39434
39755
  domain?: string | undefined;
39435
39756
  /** phone number */
39436
39757
  phone?: string | undefined;
39437
- /** URL link */
39758
+ /** relevant URL of the Ad element in SERP */
39438
39759
  url?: string | undefined;
39439
39760
  /** indicates whether the element is an ad */
39440
39761
  is_paid?: boolean | undefined;
@@ -39479,7 +39800,7 @@ left, right */
39479
39800
  position?: string | undefined;
39480
39801
  /** the XPath of the element */
39481
39802
  xpath?: string | undefined;
39482
- /** title of the item */
39803
+ /** title of the result in SERP */
39483
39804
  title?: string | undefined;
39484
39805
  /** starting date of stay
39485
39806
  in the format “year-month-date”
@@ -39491,8 +39812,7 @@ in the format “year-month-date”
39491
39812
  example:
39492
39813
  2019-11-17 */
39493
39814
  date_to?: string | undefined;
39494
- /** additional items present in the element
39495
- if there are none, equals null */
39815
+ /** elements of search results found in SERP */
39496
39816
  items?: (HotelsPackElement | undefined)[] | undefined;
39497
39817
  [key: string]: any;
39498
39818
  constructor(data?: IHotelsPackDataforseoLabsSerpElementItem);
@@ -39513,7 +39833,7 @@ left, right */
39513
39833
  position?: string | undefined;
39514
39834
  /** the XPath of the element */
39515
39835
  xpath?: string | undefined;
39516
- /** title of the item */
39836
+ /** title of the result in SERP */
39517
39837
  title?: string | undefined;
39518
39838
  /** starting date of stay
39519
39839
  in the format “year-month-date”
@@ -39525,8 +39845,7 @@ in the format “year-month-date”
39525
39845
  example:
39526
39846
  2019-11-17 */
39527
39847
  date_to?: string | undefined;
39528
- /** additional items present in the element
39529
- if there are none, equals null */
39848
+ /** elements of search results found in SERP */
39530
39849
  items?: (HotelsPackElement | undefined)[] | undefined;
39531
39850
  [key: string]: any;
39532
39851
  }
@@ -39707,14 +40026,13 @@ left, right */
39707
40026
  position?: string | undefined;
39708
40027
  /** the XPath of the element */
39709
40028
  xpath?: string | undefined;
39710
- /** title of the item */
40029
+ /** title of the result in SERP */
39711
40030
  title?: string | undefined;
39712
40031
  /** google defined data attribute ID
39713
40032
  example:
39714
40033
  kc:/shopping/gpc:organic-offers */
39715
40034
  data_attrid?: string | undefined;
39716
- /** additional items present in the element
39717
- if there are none, equals null */
40035
+ /** elements of search results found in SERP */
39718
40036
  items?: (KnowledgeGraphShoppingElement | undefined)[] | undefined;
39719
40037
  [key: string]: any;
39720
40038
  constructor(data?: IKnowledgeGraphShoppingItemDataforseoLabsSerpElementItem);
@@ -39735,14 +40053,13 @@ left, right */
39735
40053
  position?: string | undefined;
39736
40054
  /** the XPath of the element */
39737
40055
  xpath?: string | undefined;
39738
- /** title of the item */
40056
+ /** title of the result in SERP */
39739
40057
  title?: string | undefined;
39740
40058
  /** google defined data attribute ID
39741
40059
  example:
39742
40060
  kc:/shopping/gpc:organic-offers */
39743
40061
  data_attrid?: string | undefined;
39744
- /** additional items present in the element
39745
- if there are none, equals null */
40062
+ /** elements of search results found in SERP */
39746
40063
  items?: (KnowledgeGraphShoppingElement | undefined)[] | undefined;
39747
40064
  [key: string]: any;
39748
40065
  }
@@ -39768,9 +40085,7 @@ the popularity rate based on reviews and displayed in SERP */
39768
40085
  place_id?: string | undefined;
39769
40086
  /** the additional feature of the review */
39770
40087
  feature?: string | undefined;
39771
- /** google-defined client id
39772
- unique id of a local establishment;
39773
- can be used with Google Reviews API to get a full list of reviews */
40088
+ /** google-defined client id */
39774
40089
  cid?: string | undefined;
39775
40090
  [key: string]: any;
39776
40091
  constructor(data?: IGoogleReviewsDataforseoLabsSerpElementItem);
@@ -39800,9 +40115,7 @@ the popularity rate based on reviews and displayed in SERP */
39800
40115
  place_id?: string | undefined;
39801
40116
  /** the additional feature of the review */
39802
40117
  feature?: string | undefined;
39803
- /** google-defined client id
39804
- unique id of a local establishment;
39805
- can be used with Google Reviews API to get a full list of reviews */
40118
+ /** google-defined client id */
39806
40119
  cid?: string | undefined;
39807
40120
  [key: string]: any;
39808
40121
  }
@@ -39823,9 +40136,7 @@ left, right */
39823
40136
  posts_id?: string | undefined;
39824
40137
  /** the additional feature of the review */
39825
40138
  feature?: string | undefined;
39826
- /** google-defined client id
39827
- unique id of a local establishment;
39828
- can be used with Google Reviews API to get a full list of reviews */
40139
+ /** google-defined client id */
39829
40140
  cid?: string | undefined;
39830
40141
  [key: string]: any;
39831
40142
  constructor(data?: IGooglePostsDataforseoLabsSerpElementItem);
@@ -39850,9 +40161,7 @@ left, right */
39850
40161
  posts_id?: string | undefined;
39851
40162
  /** the additional feature of the review */
39852
40163
  feature?: string | undefined;
39853
- /** google-defined client id
39854
- unique id of a local establishment;
39855
- can be used with Google Reviews API to get a full list of reviews */
40164
+ /** google-defined client id */
39856
40165
  cid?: string | undefined;
39857
40166
  [key: string]: any;
39858
40167
  }
@@ -39869,12 +40178,11 @@ left, right */
39869
40178
  position?: string | undefined;
39870
40179
  /** the XPath of the element */
39871
40180
  xpath?: string | undefined;
39872
- /** title of the item */
40181
+ /** title of the result in SERP */
39873
40182
  title?: string | undefined;
39874
- /** URL link */
40183
+ /** relevant URL of the Ad element in SERP */
39875
40184
  url?: string | undefined;
39876
- /** additional items present in the element
39877
- if there are none, equals null */
40185
+ /** elements of search results found in SERP */
39878
40186
  items?: (GoogleFlightsElement | undefined)[] | undefined;
39879
40187
  [key: string]: any;
39880
40188
  constructor(data?: IGoogleFlightsDataforseoLabsSerpElementItem);
@@ -39895,12 +40203,11 @@ left, right */
39895
40203
  position?: string | undefined;
39896
40204
  /** the XPath of the element */
39897
40205
  xpath?: string | undefined;
39898
- /** title of the item */
40206
+ /** title of the result in SERP */
39899
40207
  title?: string | undefined;
39900
- /** URL link */
40208
+ /** relevant URL of the Ad element in SERP */
39901
40209
  url?: string | undefined;
39902
- /** additional items present in the element
39903
- if there are none, equals null */
40210
+ /** elements of search results found in SERP */
39904
40211
  items?: (GoogleFlightsElement | undefined)[] | undefined;
39905
40212
  [key: string]: any;
39906
40213
  }
@@ -39917,12 +40224,11 @@ left, right */
39917
40224
  position?: string | undefined;
39918
40225
  /** the XPath of the element */
39919
40226
  xpath?: string | undefined;
39920
- /** title of the item */
40227
+ /** title of the result in SERP */
39921
40228
  title?: string | undefined;
39922
- /** URL link */
40229
+ /** relevant URL of the Ad element in SERP */
39923
40230
  url?: string | undefined;
39924
- /** additional items present in the element
39925
- if there are none, equals null */
40231
+ /** elements of search results found in SERP */
39926
40232
  items?: (ImagesElement | undefined)[] | undefined;
39927
40233
  /** contains keywords and images related to the specified search term
39928
40234
  if there are none, equals null */
@@ -39946,12 +40252,11 @@ left, right */
39946
40252
  position?: string | undefined;
39947
40253
  /** the XPath of the element */
39948
40254
  xpath?: string | undefined;
39949
- /** title of the item */
40255
+ /** title of the result in SERP */
39950
40256
  title?: string | undefined;
39951
- /** URL link */
40257
+ /** relevant URL of the Ad element in SERP */
39952
40258
  url?: string | undefined;
39953
- /** additional items present in the element
39954
- if there are none, equals null */
40259
+ /** elements of search results found in SERP */
39955
40260
  items?: (ImagesElement | undefined)[] | undefined;
39956
40261
  /** contains keywords and images related to the specified search term
39957
40262
  if there are none, equals null */
@@ -39971,10 +40276,9 @@ left, right */
39971
40276
  position?: string | undefined;
39972
40277
  /** the XPath of the element */
39973
40278
  xpath?: string | undefined;
39974
- /** title of the item */
40279
+ /** title of the result in SERP */
39975
40280
  title?: string | undefined;
39976
- /** additional items present in the element
39977
- if there are none, equals null */
40281
+ /** elements of search results found in SERP */
39978
40282
  items?: (ShoppingElement | undefined)[] | undefined;
39979
40283
  [key: string]: any;
39980
40284
  constructor(data?: IShoppingDataforseoLabsSerpElementItem);
@@ -39995,10 +40299,9 @@ left, right */
39995
40299
  position?: string | undefined;
39996
40300
  /** the XPath of the element */
39997
40301
  xpath?: string | undefined;
39998
- /** title of the item */
40302
+ /** title of the result in SERP */
39999
40303
  title?: string | undefined;
40000
- /** additional items present in the element
40001
- if there are none, equals null */
40304
+ /** elements of search results found in SERP */
40002
40305
  items?: (ShoppingElement | undefined)[] | undefined;
40003
40306
  [key: string]: any;
40004
40307
  }
@@ -40015,12 +40318,11 @@ left, right */
40015
40318
  position?: string | undefined;
40016
40319
  /** the XPath of the element */
40017
40320
  xpath?: string | undefined;
40018
- /** title of the item */
40321
+ /** title of the result in SERP */
40019
40322
  title?: string | undefined;
40020
- /** URL link */
40323
+ /** relevant URL of the Ad element in SERP */
40021
40324
  url?: string | undefined;
40022
- /** additional items present in the element
40023
- if there are none, equals null */
40325
+ /** elements of search results found in SERP */
40024
40326
  items?: (JobsElement | undefined)[] | undefined;
40025
40327
  [key: string]: any;
40026
40328
  constructor(data?: IJobsDataforseoLabsSerpElementItem);
@@ -40041,12 +40343,11 @@ left, right */
40041
40343
  position?: string | undefined;
40042
40344
  /** the XPath of the element */
40043
40345
  xpath?: string | undefined;
40044
- /** title of the item */
40346
+ /** title of the result in SERP */
40045
40347
  title?: string | undefined;
40046
- /** URL link */
40348
+ /** relevant URL of the Ad element in SERP */
40047
40349
  url?: string | undefined;
40048
- /** additional items present in the element
40049
- if there are none, equals null */
40350
+ /** elements of search results found in SERP */
40050
40351
  items?: (JobsElement | undefined)[] | undefined;
40051
40352
  [key: string]: any;
40052
40353
  }
@@ -40063,12 +40364,11 @@ left, right */
40063
40364
  position?: string | undefined;
40064
40365
  /** the XPath of the element */
40065
40366
  xpath?: string | undefined;
40066
- /** title of the item */
40367
+ /** title of the result in SERP */
40067
40368
  title?: string | undefined;
40068
- /** URL link */
40369
+ /** relevant URL of the Ad element in SERP */
40069
40370
  url?: string | undefined;
40070
- /** additional items present in the element
40071
- if there are none, equals null */
40371
+ /** elements of search results found in SERP */
40072
40372
  items?: (EventsElement | undefined)[] | undefined;
40073
40373
  [key: string]: any;
40074
40374
  constructor(data?: IEventsDataforseoLabsSerpElementItem);
@@ -40089,12 +40389,11 @@ left, right */
40089
40389
  position?: string | undefined;
40090
40390
  /** the XPath of the element */
40091
40391
  xpath?: string | undefined;
40092
- /** title of the item */
40392
+ /** title of the result in SERP */
40093
40393
  title?: string | undefined;
40094
- /** URL link */
40394
+ /** relevant URL of the Ad element in SERP */
40095
40395
  url?: string | undefined;
40096
- /** additional items present in the element
40097
- if there are none, equals null */
40396
+ /** elements of search results found in SERP */
40098
40397
  items?: (EventsElement | undefined)[] | undefined;
40099
40398
  [key: string]: any;
40100
40399
  }
@@ -40111,10 +40410,9 @@ left, right */
40111
40410
  position?: string | undefined;
40112
40411
  /** the XPath of the element */
40113
40412
  xpath?: string | undefined;
40114
- /** title of the item */
40413
+ /** title of the result in SERP */
40115
40414
  title?: string | undefined;
40116
- /** additional items present in the element
40117
- if there are none, equals null */
40415
+ /** elements of search results found in SERP */
40118
40416
  items?: (MentionCarouselElement | undefined)[] | undefined;
40119
40417
  [key: string]: any;
40120
40418
  constructor(data?: IMentionCarouselDataforseoLabsSerpElementItem);
@@ -40135,10 +40433,9 @@ left, right */
40135
40433
  position?: string | undefined;
40136
40434
  /** the XPath of the element */
40137
40435
  xpath?: string | undefined;
40138
- /** title of the item */
40436
+ /** title of the result in SERP */
40139
40437
  title?: string | undefined;
40140
- /** additional items present in the element
40141
- if there are none, equals null */
40438
+ /** elements of search results found in SERP */
40142
40439
  items?: (MentionCarouselElement | undefined)[] | undefined;
40143
40440
  [key: string]: any;
40144
40441
  }
@@ -40155,8 +40452,7 @@ left, right */
40155
40452
  position?: string | undefined;
40156
40453
  /** the XPath of the element */
40157
40454
  xpath?: string | undefined;
40158
- /** additional items present in the element
40159
- if there are none, equals null */
40455
+ /** elements of search results found in SERP */
40160
40456
  items?: (RecipesElement | undefined)[] | undefined;
40161
40457
  [key: string]: any;
40162
40458
  constructor(data?: IRecipesDataforseoLabsSerpElementItem);
@@ -40177,8 +40473,7 @@ left, right */
40177
40473
  position?: string | undefined;
40178
40474
  /** the XPath of the element */
40179
40475
  xpath?: string | undefined;
40180
- /** additional items present in the element
40181
- if there are none, equals null */
40476
+ /** elements of search results found in SERP */
40182
40477
  items?: (RecipesElement | undefined)[] | undefined;
40183
40478
  [key: string]: any;
40184
40479
  }
@@ -40195,10 +40490,9 @@ left, right */
40195
40490
  position?: string | undefined;
40196
40491
  /** the XPath of the element */
40197
40492
  xpath?: string | undefined;
40198
- /** title of the item */
40493
+ /** title of the result in SERP */
40199
40494
  title?: string | undefined;
40200
- /** additional items present in the element
40201
- if there are none, equals null */
40495
+ /** elements of search results found in SERP */
40202
40496
  items?: (TopSightsElement | undefined)[] | undefined;
40203
40497
  [key: string]: any;
40204
40498
  constructor(data?: ITopSightsDataforseoLabsSerpElementItem);
@@ -40219,10 +40513,9 @@ left, right */
40219
40513
  position?: string | undefined;
40220
40514
  /** the XPath of the element */
40221
40515
  xpath?: string | undefined;
40222
- /** title of the item */
40516
+ /** title of the result in SERP */
40223
40517
  title?: string | undefined;
40224
- /** additional items present in the element
40225
- if there are none, equals null */
40518
+ /** elements of search results found in SERP */
40226
40519
  items?: (TopSightsElement | undefined)[] | undefined;
40227
40520
  [key: string]: any;
40228
40521
  }
@@ -40239,12 +40532,11 @@ left, right */
40239
40532
  position?: string | undefined;
40240
40533
  /** the XPath of the element */
40241
40534
  xpath?: string | undefined;
40242
- /** title of the item */
40535
+ /** title of the result in SERP */
40243
40536
  title?: string | undefined;
40244
- /** URL link */
40537
+ /** relevant URL of the Ad element in SERP */
40245
40538
  url?: string | undefined;
40246
- /** additional items present in the element
40247
- if there are none, equals null */
40539
+ /** elements of search results found in SERP */
40248
40540
  items?: (ScholarlyArticlesElement | undefined)[] | undefined;
40249
40541
  [key: string]: any;
40250
40542
  constructor(data?: IScholarlyArticlesDataforseoLabsSerpElementItem);
@@ -40265,12 +40557,11 @@ left, right */
40265
40557
  position?: string | undefined;
40266
40558
  /** the XPath of the element */
40267
40559
  xpath?: string | undefined;
40268
- /** title of the item */
40560
+ /** title of the result in SERP */
40269
40561
  title?: string | undefined;
40270
- /** URL link */
40562
+ /** relevant URL of the Ad element in SERP */
40271
40563
  url?: string | undefined;
40272
- /** additional items present in the element
40273
- if there are none, equals null */
40564
+ /** elements of search results found in SERP */
40274
40565
  items?: (ScholarlyArticlesElement | undefined)[] | undefined;
40275
40566
  [key: string]: any;
40276
40567
  }
@@ -40287,8 +40578,7 @@ left, right */
40287
40578
  position?: string | undefined;
40288
40579
  /** the XPath of the element */
40289
40580
  xpath?: string | undefined;
40290
- /** additional items present in the element
40291
- if there are none, equals null */
40581
+ /** elements of search results found in SERP */
40292
40582
  items?: (PopularProductsElement | undefined)[] | undefined;
40293
40583
  [key: string]: any;
40294
40584
  constructor(data?: IPopularProductsDataforseoLabsSerpElementItem);
@@ -40309,8 +40599,7 @@ left, right */
40309
40599
  position?: string | undefined;
40310
40600
  /** the XPath of the element */
40311
40601
  xpath?: string | undefined;
40312
- /** additional items present in the element
40313
- if there are none, equals null */
40602
+ /** elements of search results found in SERP */
40314
40603
  items?: (PopularProductsElement | undefined)[] | undefined;
40315
40604
  [key: string]: any;
40316
40605
  }
@@ -40327,8 +40616,7 @@ left, right */
40327
40616
  position?: string | undefined;
40328
40617
  /** the XPath of the element */
40329
40618
  xpath?: string | undefined;
40330
- /** additional items present in the element
40331
- if there are none, equals null */
40619
+ /** elements of search results found in SERP */
40332
40620
  items?: (PodcastsElement | undefined)[] | undefined;
40333
40621
  [key: string]: any;
40334
40622
  constructor(data?: IPodcastsDataforseoLabsSerpElementItem);
@@ -40349,8 +40637,7 @@ left, right */
40349
40637
  position?: string | undefined;
40350
40638
  /** the XPath of the element */
40351
40639
  xpath?: string | undefined;
40352
- /** additional items present in the element
40353
- if there are none, equals null */
40640
+ /** elements of search results found in SERP */
40354
40641
  items?: (PodcastsElement | undefined)[] | undefined;
40355
40642
  [key: string]: any;
40356
40643
  }
@@ -40367,8 +40654,7 @@ left, right */
40367
40654
  position?: string | undefined;
40368
40655
  /** the XPath of the element */
40369
40656
  xpath?: string | undefined;
40370
- /** additional items present in the element
40371
- if there are none, equals null */
40657
+ /** elements of search results found in SERP */
40372
40658
  items?: (QuestionsAndAnswersElement | undefined)[] | undefined;
40373
40659
  [key: string]: any;
40374
40660
  constructor(data?: IQuestionsAndAnswersDataforseoLabsSerpElementItem);
@@ -40389,8 +40675,7 @@ left, right */
40389
40675
  position?: string | undefined;
40390
40676
  /** the XPath of the element */
40391
40677
  xpath?: string | undefined;
40392
- /** additional items present in the element
40393
- if there are none, equals null */
40678
+ /** elements of search results found in SERP */
40394
40679
  items?: (QuestionsAndAnswersElement | undefined)[] | undefined;
40395
40680
  [key: string]: any;
40396
40681
  }
@@ -40407,8 +40692,7 @@ left, right */
40407
40692
  position?: string | undefined;
40408
40693
  /** the XPath of the element */
40409
40694
  xpath?: string | undefined;
40410
- /** additional items present in the element
40411
- if there are none, equals null */
40695
+ /** elements of search results found in SERP */
40412
40696
  items?: (ShortVideosElement | undefined)[] | undefined;
40413
40697
  [key: string]: any;
40414
40698
  constructor(data?: IFindResultsOnDataforseoLabsSerpElementItem);
@@ -40429,8 +40713,7 @@ left, right */
40429
40713
  position?: string | undefined;
40430
40714
  /** the XPath of the element */
40431
40715
  xpath?: string | undefined;
40432
- /** additional items present in the element
40433
- if there are none, equals null */
40716
+ /** elements of search results found in SERP */
40434
40717
  items?: (ShortVideosElement | undefined)[] | undefined;
40435
40718
  [key: string]: any;
40436
40719
  }
@@ -40447,7 +40730,7 @@ left, right */
40447
40730
  position?: string | undefined;
40448
40731
  /** the XPath of the element */
40449
40732
  xpath?: string | undefined;
40450
- /** title of the item */
40733
+ /** title of the result in SERP */
40451
40734
  title?: string | undefined;
40452
40735
  /** source of the element
40453
40736
  indicates the source of information included in the shopping_element */
@@ -40455,8 +40738,8 @@ indicates the source of information included in the shopping_element */
40455
40738
  /** text alongside the link title */
40456
40739
  snippet?: string | undefined;
40457
40740
  /** price of the shopping element */
40458
- price?: PriceInfo | undefined;
40459
- /** URL link */
40741
+ price?: Price | undefined;
40742
+ /** relevant URL of the Ad element in SERP */
40460
40743
  url?: string | undefined;
40461
40744
  /** domain where a link points */
40462
40745
  domain?: string | undefined;
@@ -40484,7 +40767,7 @@ left, right */
40484
40767
  position?: string | undefined;
40485
40768
  /** the XPath of the element */
40486
40769
  xpath?: string | undefined;
40487
- /** title of the item */
40770
+ /** title of the result in SERP */
40488
40771
  title?: string | undefined;
40489
40772
  /** source of the element
40490
40773
  indicates the source of information included in the shopping_element */
@@ -40492,8 +40775,8 @@ indicates the source of information included in the shopping_element */
40492
40775
  /** text alongside the link title */
40493
40776
  snippet?: string | undefined;
40494
40777
  /** price of the shopping element */
40495
- price?: PriceInfo | undefined;
40496
- /** URL link */
40778
+ price?: Price | undefined;
40779
+ /** relevant URL of the Ad element in SERP */
40497
40780
  url?: string | undefined;
40498
40781
  /** domain where a link points */
40499
40782
  domain?: string | undefined;
@@ -40517,8 +40800,7 @@ left, right */
40517
40800
  position?: string | undefined;
40518
40801
  /** the XPath of the element */
40519
40802
  xpath?: string | undefined;
40520
- /** additional items present in the element
40521
- if there are none, equals null */
40803
+ /** elements of search results found in SERP */
40522
40804
  items?: (LicensesElement | undefined)[] | undefined;
40523
40805
  [key: string]: any;
40524
40806
  constructor(data?: IVisualStoriesDataforseoLabsSerpElementItem);
@@ -40539,8 +40821,7 @@ left, right */
40539
40821
  position?: string | undefined;
40540
40822
  /** the XPath of the element */
40541
40823
  xpath?: string | undefined;
40542
- /** additional items present in the element
40543
- if there are none, equals null */
40824
+ /** elements of search results found in SERP */
40544
40825
  items?: (LicensesElement | undefined)[] | undefined;
40545
40826
  [key: string]: any;
40546
40827
  }
@@ -40557,10 +40838,9 @@ left, right */
40557
40838
  position?: string | undefined;
40558
40839
  /** the XPath of the element */
40559
40840
  xpath?: string | undefined;
40560
- /** title of the item */
40841
+ /** title of the result in SERP */
40561
40842
  title?: string | undefined;
40562
- /** additional items present in the element
40563
- if there are none, equals null */
40843
+ /** elements of search results found in SERP */
40564
40844
  items?: (CommercialUnitsElement | undefined)[] | undefined;
40565
40845
  [key: string]: any;
40566
40846
  constructor(data?: ICommercialUnitsDataforseoLabsSerpElementItem);
@@ -40581,10 +40861,9 @@ left, right */
40581
40861
  position?: string | undefined;
40582
40862
  /** the XPath of the element */
40583
40863
  xpath?: string | undefined;
40584
- /** title of the item */
40864
+ /** title of the result in SERP */
40585
40865
  title?: string | undefined;
40586
- /** additional items present in the element
40587
- if there are none, equals null */
40866
+ /** elements of search results found in SERP */
40588
40867
  items?: (CommercialUnitsElement | undefined)[] | undefined;
40589
40868
  [key: string]: any;
40590
40869
  }
@@ -40601,14 +40880,13 @@ left, right */
40601
40880
  position?: string | undefined;
40602
40881
  /** the XPath of the element */
40603
40882
  xpath?: string | undefined;
40604
- /** title of the item */
40883
+ /** title of the result in SERP */
40605
40884
  title?: string | undefined;
40606
- /** URL link */
40885
+ /** relevant URL of the Ad element in SERP */
40607
40886
  url?: string | undefined;
40608
40887
  /** domain where a link points */
40609
40888
  domain?: string | undefined;
40610
- /** additional items present in the element
40611
- if there are none, equals null */
40889
+ /** elements of search results found in SERP */
40612
40890
  items?: (LocalServicesElement | undefined)[] | undefined;
40613
40891
  [key: string]: any;
40614
40892
  constructor(data?: ILocalServicesDataforseoLabsSerpElementItem);
@@ -40629,14 +40907,13 @@ left, right */
40629
40907
  position?: string | undefined;
40630
40908
  /** the XPath of the element */
40631
40909
  xpath?: string | undefined;
40632
- /** title of the item */
40910
+ /** title of the result in SERP */
40633
40911
  title?: string | undefined;
40634
- /** URL link */
40912
+ /** relevant URL of the Ad element in SERP */
40635
40913
  url?: string | undefined;
40636
40914
  /** domain where a link points */
40637
40915
  domain?: string | undefined;
40638
- /** additional items present in the element
40639
- if there are none, equals null */
40916
+ /** elements of search results found in SERP */
40640
40917
  items?: (LocalServicesElement | undefined)[] | undefined;
40641
40918
  [key: string]: any;
40642
40919
  }
@@ -40657,7 +40934,7 @@ left, right */
40657
40934
  unique hotel identifier assigned by Google;
40658
40935
  example: "CgoIjaeSlI6CnNpVEAE" */
40659
40936
  hotel_identifier?: string | undefined;
40660
- /** URL link */
40937
+ /** relevant URL of the Ad element in SERP */
40661
40938
  url?: string | undefined;
40662
40939
  [key: string]: any;
40663
40940
  constructor(data?: IGoogleHotelsDataforseoLabsSerpElementItem);
@@ -40682,7 +40959,7 @@ left, right */
40682
40959
  unique hotel identifier assigned by Google;
40683
40960
  example: "CgoIjaeSlI6CnNpVEAE" */
40684
40961
  hotel_identifier?: string | undefined;
40685
- /** URL link */
40962
+ /** relevant URL of the Ad element in SERP */
40686
40963
  url?: string | undefined;
40687
40964
  [key: string]: any;
40688
40965
  }
@@ -42304,7 +42581,7 @@ you will find the specified tag value in the data object of the response */
42304
42581
  tag?: string | undefined;
42305
42582
  [key: string]: any;
42306
42583
  }
42307
- export declare class KeywordDataKeywordDataInfo implements IKeywordDataKeywordDataInfo {
42584
+ export declare class KeywordData implements IKeywordData {
42308
42585
  /** search engine type
42309
42586
  search engine type specified in a POST request;
42310
42587
  for this endpoint, the field equals bing */
@@ -42326,12 +42603,12 @@ the value will be null if you didn’t set the field include_serp_info to true i
42326
42603
  this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
42327
42604
  avg_backlinks_info?: AvgBacklinksInfo | undefined;
42328
42605
  [key: string]: any;
42329
- constructor(data?: IKeywordDataKeywordDataInfo);
42606
+ constructor(data?: IKeywordData);
42330
42607
  init(_data?: any): void;
42331
- static fromJS(data: any): KeywordDataKeywordDataInfo;
42608
+ static fromJS(data: any): KeywordData;
42332
42609
  toJSON(data?: any): any;
42333
42610
  }
42334
- export interface IKeywordDataKeywordDataInfo {
42611
+ export interface IKeywordData {
42335
42612
  /** search engine type
42336
42613
  search engine type specified in a POST request;
42337
42614
  for this endpoint, the field equals bing */
@@ -42826,7 +43103,7 @@ export declare class DataforseoLabsAmazonRankedKeywordsLiveItem implements IData
42826
43103
  /** search engine type */
42827
43104
  se_type?: string | undefined;
42828
43105
  /** keyword data for the returned keyword */
42829
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
43106
+ keyword_data?: KeywordData | undefined;
42830
43107
  /** contains data on the products’s SERP element found for the returned keyword */
42831
43108
  ranked_serp_element?: AmazonRankedSerpElement | undefined;
42832
43109
  [key: string]: any;
@@ -42839,7 +43116,7 @@ export interface IDataforseoLabsAmazonRankedKeywordsLiveItem {
42839
43116
  /** search engine type */
42840
43117
  se_type?: string | undefined;
42841
43118
  /** keyword data for the returned keyword */
42842
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
43119
+ keyword_data?: KeywordData | undefined;
42843
43120
  /** contains data on the products’s SERP element found for the returned keyword */
42844
43121
  ranked_serp_element?: AmazonRankedSerpElement | undefined;
42845
43122
  [key: string]: any;
@@ -44656,7 +44933,7 @@ search engine type specified in a POST request;
44656
44933
  for this endpoint, the field equals bing */
44657
44934
  se_type?: string | undefined;
44658
44935
  /** keyword data for the returned keyword */
44659
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
44936
+ keyword_data?: KeywordData | undefined;
44660
44937
  /** contains data on the first domain’s SERP element found for the returned keyword
44661
44938
  the list of supported SERP elements can be found below */
44662
44939
  first_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
@@ -44675,7 +44952,7 @@ search engine type specified in a POST request;
44675
44952
  for this endpoint, the field equals bing */
44676
44953
  se_type?: string | undefined;
44677
44954
  /** keyword data for the returned keyword */
44678
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
44955
+ keyword_data?: KeywordData | undefined;
44679
44956
  /** contains data on the first domain’s SERP element found for the returned keyword
44680
44957
  the list of supported SERP elements can be found below */
44681
44958
  first_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
@@ -45272,7 +45549,7 @@ search engine type specified in a POST request;
45272
45549
  for this endpoint, the field equals bing */
45273
45550
  se_type?: string | undefined;
45274
45551
  /** keyword data for the returned keyword */
45275
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
45552
+ keyword_data?: KeywordData | undefined;
45276
45553
  /** contains data on the SERP elements found for the returned keyword
45277
45554
  data will be provided in separate arrays for each URL you specified in the pages object when setting a task;
45278
45555
  depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively */
@@ -45291,7 +45568,7 @@ search engine type specified in a POST request;
45291
45568
  for this endpoint, the field equals bing */
45292
45569
  se_type?: string | undefined;
45293
45570
  /** keyword data for the returned keyword */
45294
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
45571
+ keyword_data?: KeywordData | undefined;
45295
45572
  /** contains data on the SERP elements found for the returned keyword
45296
45573
  data will be provided in separate arrays for each URL you specified in the pages object when setting a task;
45297
45574
  depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively */
@@ -45644,24 +45921,24 @@ you will find the specified tag value in the data object of the response */
45644
45921
  tag?: string | undefined;
45645
45922
  [key: string]: any;
45646
45923
  }
45647
- export declare class DataforseoLabsLiveItem implements IDataforseoLabsLiveItem {
45924
+ export declare class DataforseoLabsBingRankedKeywordsLiveItem implements IDataforseoLabsBingRankedKeywordsLiveItem {
45648
45925
  /** search engine type */
45649
45926
  se_type?: string | undefined;
45650
45927
  /** keyword data for the returned keyword */
45651
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
45928
+ keyword_data?: KeywordData | undefined;
45652
45929
  /** contains data on the domain’s SERP element found for the returned keyword */
45653
45930
  ranked_serp_element?: RankedSerpElement | undefined;
45654
45931
  [key: string]: any;
45655
- constructor(data?: IDataforseoLabsLiveItem);
45932
+ constructor(data?: IDataforseoLabsBingRankedKeywordsLiveItem);
45656
45933
  init(_data?: any): void;
45657
- static fromJS(data: any): DataforseoLabsLiveItem;
45934
+ static fromJS(data: any): DataforseoLabsBingRankedKeywordsLiveItem;
45658
45935
  toJSON(data?: any): any;
45659
45936
  }
45660
- export interface IDataforseoLabsLiveItem {
45937
+ export interface IDataforseoLabsBingRankedKeywordsLiveItem {
45661
45938
  /** search engine type */
45662
45939
  se_type?: string | undefined;
45663
45940
  /** keyword data for the returned keyword */
45664
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
45941
+ keyword_data?: KeywordData | undefined;
45665
45942
  /** contains data on the domain’s SERP element found for the returned keyword */
45666
45943
  ranked_serp_element?: RankedSerpElement | undefined;
45667
45944
  [key: string]: any;
@@ -45692,7 +45969,7 @@ ranking data is provided by the rank_absolute parameters that indicate the resul
45692
45969
  [key: string]: DataforseoLabsMetricsInfo;
45693
45970
  } | undefined;
45694
45971
  /** contains ranked keywords and related data */
45695
- items?: (DataforseoLabsLiveItem | undefined)[] | undefined;
45972
+ items?: (DataforseoLabsBingRankedKeywordsLiveItem | undefined)[] | undefined;
45696
45973
  [key: string]: any;
45697
45974
  constructor(data?: IDataforseoLabsBingRankedKeywordsLiveResultInfo);
45698
45975
  init(_data?: any): void;
@@ -45725,7 +46002,7 @@ ranking data is provided by the rank_absolute parameters that indicate the resul
45725
46002
  [key: string]: DataforseoLabsMetricsInfo;
45726
46003
  } | undefined;
45727
46004
  /** contains ranked keywords and related data */
45728
- items?: (DataforseoLabsLiveItem | undefined)[] | undefined;
46005
+ items?: (DataforseoLabsBingRankedKeywordsLiveItem | undefined)[] | undefined;
45729
46006
  [key: string]: any;
45730
46007
  }
45731
46008
  export declare class DataforseoLabsBingRankedKeywordsLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsBingRankedKeywordsLiveTaskInfo {
@@ -46004,7 +46281,7 @@ export declare class DataforseoLabsBingRelatedKeywordsLiveItem implements IDataf
46004
46281
  /** search engine type */
46005
46282
  se_type?: string | undefined;
46006
46283
  /** keyword data for the returned keyword */
46007
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
46284
+ keyword_data?: KeywordData | undefined;
46008
46285
  /** keyword search depth */
46009
46286
  depth?: number | undefined;
46010
46287
  /** list of related keywords
@@ -46020,7 +46297,7 @@ export interface IDataforseoLabsBingRelatedKeywordsLiveItem {
46020
46297
  /** search engine type */
46021
46298
  se_type?: string | undefined;
46022
46299
  /** keyword data for the returned keyword */
46023
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
46300
+ keyword_data?: KeywordData | undefined;
46024
46301
  /** keyword search depth */
46025
46302
  depth?: number | undefined;
46026
46303
  /** list of related keywords
@@ -46035,7 +46312,7 @@ export declare class DataforseoLabsBingRelatedKeywordsLiveResultInfo implements
46035
46312
  seed_keyword?: string | undefined;
46036
46313
  /** keyword data for the seed keyword
46037
46314
  fields in the array are identical to that of keyword_data */
46038
- seed_keyword_data?: KeywordDataKeywordDataInfo | undefined;
46315
+ seed_keyword_data?: KeywordData | undefined;
46039
46316
  /** location code in a POST array */
46040
46317
  location_code?: number | undefined;
46041
46318
  /** language code in a POST array */
@@ -46059,7 +46336,7 @@ export interface IDataforseoLabsBingRelatedKeywordsLiveResultInfo {
46059
46336
  seed_keyword?: string | undefined;
46060
46337
  /** keyword data for the seed keyword
46061
46338
  fields in the array are identical to that of keyword_data */
46062
- seed_keyword_data?: KeywordDataKeywordDataInfo | undefined;
46339
+ seed_keyword_data?: KeywordData | undefined;
46063
46340
  /** location code in a POST array */
46064
46341
  location_code?: number | undefined;
46065
46342
  /** language code in a POST array */
@@ -47388,7 +47665,7 @@ left, right */
47388
47665
  /** indicates whether the app is free */
47389
47666
  is_free?: boolean | undefined;
47390
47667
  /** price of the app */
47391
- price?: PriceInfo | undefined;
47668
+ price?: Price | undefined;
47392
47669
  /** name of the app developer */
47393
47670
  developer?: string | undefined;
47394
47671
  /** URL to the developer page on Google Play */
@@ -47425,7 +47702,7 @@ left, right */
47425
47702
  /** indicates whether the app is free */
47426
47703
  is_free?: boolean | undefined;
47427
47704
  /** price of the app */
47428
- price?: PriceInfo | undefined;
47705
+ price?: Price | undefined;
47429
47706
  /** name of the app developer */
47430
47707
  developer?: string | undefined;
47431
47708
  /** URL to the developer page on Google Play */
@@ -47488,7 +47765,7 @@ export declare class DataforseoLabsGoogleKeywordsForAppLiveItem implements IData
47488
47765
  /** search engine type */
47489
47766
  se_type?: string | undefined;
47490
47767
  /** keyword data for the returned keyword */
47491
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
47768
+ keyword_data?: KeywordData | undefined;
47492
47769
  /** contains data on the domain’s SERP element found for the returned keyword */
47493
47770
  ranked_serp_element?: AppRankedSerpElementInfo | undefined;
47494
47771
  [key: string]: any;
@@ -47501,7 +47778,7 @@ export interface IDataforseoLabsGoogleKeywordsForAppLiveItem {
47501
47778
  /** search engine type */
47502
47779
  se_type?: string | undefined;
47503
47780
  /** keyword data for the returned keyword */
47504
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
47781
+ keyword_data?: KeywordData | undefined;
47505
47782
  /** contains data on the domain’s SERP element found for the returned keyword */
47506
47783
  ranked_serp_element?: AppRankedSerpElementInfo | undefined;
47507
47784
  [key: string]: any;
@@ -48104,7 +48381,7 @@ export declare class DataforseoLabsGoogleAppIntersectionLiveItem implements IDat
48104
48381
  /** search engine type */
48105
48382
  se_type?: string | undefined;
48106
48383
  /** keyword data for the returned keyword */
48107
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
48384
+ keyword_data?: KeywordData | undefined;
48108
48385
  /** contains SERP data for the returned keyword
48109
48386
  data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task;
48110
48387
  depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively */
@@ -48121,7 +48398,7 @@ export interface IDataforseoLabsGoogleAppIntersectionLiveItem {
48121
48398
  /** search engine type */
48122
48399
  se_type?: string | undefined;
48123
48400
  /** keyword data for the returned keyword */
48124
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
48401
+ keyword_data?: KeywordData | undefined;
48125
48402
  /** contains SERP data for the returned keyword
48126
48403
  data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task;
48127
48404
  depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively */
@@ -48586,7 +48863,7 @@ left, right */
48586
48863
  /** indicates whether the app is free */
48587
48864
  is_free?: boolean | undefined;
48588
48865
  /** price of the app */
48589
- price?: PriceInfo | undefined;
48866
+ price?: Price | undefined;
48590
48867
  [key: string]: any;
48591
48868
  constructor(data?: IAppDataAppStoreSearchOrganicSerpElementItem);
48592
48869
  init(_data?: any): void;
@@ -48619,7 +48896,81 @@ left, right */
48619
48896
  /** indicates whether the app is free */
48620
48897
  is_free?: boolean | undefined;
48621
48898
  /** price of the app */
48622
- price?: PriceInfo | undefined;
48899
+ price?: Price | undefined;
48900
+ [key: string]: any;
48901
+ }
48902
+ export declare class ItemsRankedSerpElement implements IItemsRankedSerpElement {
48903
+ /** search engine type */
48904
+ se_type?: string | undefined;
48905
+ /** contains data on the SERP element
48906
+ the list of supported SERP elements can be found below */
48907
+ serp_item?: AppDataAppStoreSearchOrganicSerpElementItem | undefined;
48908
+ /** direct URL to search engine results
48909
+ you can use it to make sure that we provided accurate results */
48910
+ check_url?: string | undefined;
48911
+ /** number of search results for the returned keyword */
48912
+ se_results_count?: string | undefined;
48913
+ /** date and time when SERP data was updated
48914
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
48915
+ example:
48916
+ 2019-11-15 12:57:46 +00:00 */
48917
+ last_updated_time?: string | undefined;
48918
+ /** previous to the most recent date and time when SERP data was updated
48919
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
48920
+ example:
48921
+ 2019-10-15 12:57:46 +00:00;
48922
+ in this case, will equal null */
48923
+ previous_updated_time?: string | undefined;
48924
+ [key: string]: any;
48925
+ constructor(data?: IItemsRankedSerpElement);
48926
+ init(_data?: any): void;
48927
+ static fromJS(data: any): ItemsRankedSerpElement;
48928
+ toJSON(data?: any): any;
48929
+ }
48930
+ export interface IItemsRankedSerpElement {
48931
+ /** search engine type */
48932
+ se_type?: string | undefined;
48933
+ /** contains data on the SERP element
48934
+ the list of supported SERP elements can be found below */
48935
+ serp_item?: AppDataAppStoreSearchOrganicSerpElementItem | undefined;
48936
+ /** direct URL to search engine results
48937
+ you can use it to make sure that we provided accurate results */
48938
+ check_url?: string | undefined;
48939
+ /** number of search results for the returned keyword */
48940
+ se_results_count?: string | undefined;
48941
+ /** date and time when SERP data was updated
48942
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
48943
+ example:
48944
+ 2019-11-15 12:57:46 +00:00 */
48945
+ last_updated_time?: string | undefined;
48946
+ /** previous to the most recent date and time when SERP data was updated
48947
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
48948
+ example:
48949
+ 2019-10-15 12:57:46 +00:00;
48950
+ in this case, will equal null */
48951
+ previous_updated_time?: string | undefined;
48952
+ [key: string]: any;
48953
+ }
48954
+ export declare class DataforseoLabsAppleKeywordsForAppLiveItem implements IDataforseoLabsAppleKeywordsForAppLiveItem {
48955
+ /** search engine type */
48956
+ se_type?: string | undefined;
48957
+ /** keyword data for the returned keyword */
48958
+ keyword_data?: KeywordData | undefined;
48959
+ /** contains data on the domain’s SERP element found for the returned keyword */
48960
+ ranked_serp_element?: ItemsRankedSerpElement | undefined;
48961
+ [key: string]: any;
48962
+ constructor(data?: IDataforseoLabsAppleKeywordsForAppLiveItem);
48963
+ init(_data?: any): void;
48964
+ static fromJS(data: any): DataforseoLabsAppleKeywordsForAppLiveItem;
48965
+ toJSON(data?: any): any;
48966
+ }
48967
+ export interface IDataforseoLabsAppleKeywordsForAppLiveItem {
48968
+ /** search engine type */
48969
+ se_type?: string | undefined;
48970
+ /** keyword data for the returned keyword */
48971
+ keyword_data?: KeywordData | undefined;
48972
+ /** contains data on the domain’s SERP element found for the returned keyword */
48973
+ ranked_serp_element?: ItemsRankedSerpElement | undefined;
48623
48974
  [key: string]: any;
48624
48975
  }
48625
48976
  export declare class DataforseoLabsAppleKeywordsForAppLiveResultInfo implements IDataforseoLabsAppleKeywordsForAppLiveResultInfo {
@@ -48636,7 +48987,7 @@ export declare class DataforseoLabsAppleKeywordsForAppLiveResultInfo implements
48636
48987
  /** the number of results returned in the items array */
48637
48988
  items_count?: number | undefined;
48638
48989
  /** contains data related to the ranking keywords for the app specified in the app_id field */
48639
- items?: (DataforseoLabsLiveItem | undefined)[] | undefined;
48990
+ items?: (DataforseoLabsAppleKeywordsForAppLiveItem | undefined)[] | undefined;
48640
48991
  [key: string]: any;
48641
48992
  constructor(data?: IDataforseoLabsAppleKeywordsForAppLiveResultInfo);
48642
48993
  init(_data?: any): void;
@@ -48657,7 +49008,7 @@ export interface IDataforseoLabsAppleKeywordsForAppLiveResultInfo {
48657
49008
  /** the number of results returned in the items array */
48658
49009
  items_count?: number | undefined;
48659
49010
  /** contains data related to the ranking keywords for the app specified in the app_id field */
48660
- items?: (DataforseoLabsLiveItem | undefined)[] | undefined;
49011
+ items?: (DataforseoLabsAppleKeywordsForAppLiveItem | undefined)[] | undefined;
48661
49012
  [key: string]: any;
48662
49013
  }
48663
49014
  export declare class DataforseoLabsAppleKeywordsForAppLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsAppleKeywordsForAppLiveTaskInfo {
@@ -49220,7 +49571,7 @@ export declare class DataforseoLabsAppleAppIntersectionLiveItem implements IData
49220
49571
  /** search engine type */
49221
49572
  se_type?: string | undefined;
49222
49573
  /** keyword data for the returned keyword */
49223
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
49574
+ keyword_data?: KeywordData | undefined;
49224
49575
  /** contains SERP data for the returned keyword
49225
49576
  data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task;
49226
49577
  depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively */
@@ -49237,7 +49588,7 @@ export interface IDataforseoLabsAppleAppIntersectionLiveItem {
49237
49588
  /** search engine type */
49238
49589
  se_type?: string | undefined;
49239
49590
  /** keyword data for the returned keyword */
49240
- keyword_data?: KeywordDataKeywordDataInfo | undefined;
49591
+ keyword_data?: KeywordData | undefined;
49241
49592
  /** contains SERP data for the returned keyword
49242
49593
  data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task;
49243
49594
  depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively */
@@ -53550,36 +53901,186 @@ the data included in the google_trends_graph element is based on the keywords li
53550
53901
  averages?: (number | undefined)[];
53551
53902
  [key: string]: any;
53552
53903
  }
53553
- export declare class KeywordsDataGoogleTrendsExploreTaskGetResultInfo implements IKeywordsDataGoogleTrendsExploreTaskGetResultInfo {
53554
- /** keywords in a POST array */
53555
- keywords?: (string | undefined)[] | undefined;
53556
- /** type of element */
53557
- type?: string | undefined;
53558
- /** location code in a POST array
53559
- if there is no data, then the value is null */
53560
- location_code?: number | undefined;
53561
- /** language code in a POST array
53562
- if there is no data, then the value is null */
53563
- language_code?: string | undefined;
53564
- /** direct URL to the Google Trends results
53565
- you can use it to make sure that we provided accurate results */
53566
- check_url?: string | undefined;
53567
- /** date and time when the result was received
53568
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
53904
+ export declare class TrendsMapDataInfo implements ITrendsMapDataInfo {
53905
+ /** Google Trends location identifier
53906
+ you can use this field for matching obtained results with location parameters specified in the request
53569
53907
  example:
53570
- 2019-11-15 12:57:46 +00:00 */
53571
- datetime?: string | undefined;
53572
- /** the number of results returned in the items array */
53573
- items_count?: number | undefined;
53574
- /** items on the Google Trends page */
53575
- items?: (BaseGoogleTrendsItem | undefined)[] | undefined;
53908
+ US-NY */
53909
+ geo_id?: string | undefined;
53910
+ /** Google Trends location name
53911
+ you can use this field for matching obtained results with location parameters specified in the request */
53912
+ geo_name?: string | undefined;
53913
+ /** relative keyword popularity rate in a given location
53914
+ represents the location-specific keyword popularity rate over the given time range
53915
+ if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords
53916
+ a value of 100 is the peak popularity for the term
53917
+ a value of 50 means that the term is half as popular
53918
+ a value of 0 means there was not enough data for this term */
53919
+ values?: (any | undefined)[] | undefined;
53920
+ /** max value among comparable terms
53921
+ represents the maximum value if you specified more than two keywords in a POST array
53922
+ if you specified only one keyword, the value will be null */
53923
+ max_value_index?: number | undefined;
53576
53924
  [key: string]: any;
53577
- constructor(data?: IKeywordsDataGoogleTrendsExploreTaskGetResultInfo);
53925
+ constructor(data?: ITrendsMapDataInfo);
53578
53926
  init(_data?: any): void;
53579
- static fromJS(data: any): KeywordsDataGoogleTrendsExploreTaskGetResultInfo;
53927
+ static fromJS(data: any): TrendsMapDataInfo;
53580
53928
  toJSON(data?: any): any;
53581
53929
  }
53582
- export interface IKeywordsDataGoogleTrendsExploreTaskGetResultInfo {
53930
+ export interface ITrendsMapDataInfo {
53931
+ /** Google Trends location identifier
53932
+ you can use this field for matching obtained results with location parameters specified in the request
53933
+ example:
53934
+ US-NY */
53935
+ geo_id?: string | undefined;
53936
+ /** Google Trends location name
53937
+ you can use this field for matching obtained results with location parameters specified in the request */
53938
+ geo_name?: string | undefined;
53939
+ /** relative keyword popularity rate in a given location
53940
+ represents the location-specific keyword popularity rate over the given time range
53941
+ if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords
53942
+ a value of 100 is the peak popularity for the term
53943
+ a value of 50 means that the term is half as popular
53944
+ a value of 0 means there was not enough data for this term */
53945
+ values?: (any | undefined)[] | undefined;
53946
+ /** max value among comparable terms
53947
+ represents the maximum value if you specified more than two keywords in a POST array
53948
+ if you specified only one keyword, the value will be null */
53949
+ max_value_index?: number | undefined;
53950
+ [key: string]: any;
53951
+ }
53952
+ export declare class GoogleTrendsMapElementItem extends BaseGoogleTrendsItem implements IGoogleTrendsMapElementItem {
53953
+ /** the alignment of the element in Google Trends
53954
+ can take the following values: 1, 2, 3, 4, etc. */
53955
+ position?: number | undefined;
53956
+ /** title of the element in Google Trends */
53957
+ title?: string | undefined;
53958
+ /** relevant keywords
53959
+ the data included in the google_trends_map element is based on the keywords listed in this array */
53960
+ keywords?: (string | undefined)[] | undefined;
53961
+ /** Google Trends data from the corresponding item */
53962
+ data?: (TrendsMapDataInfo | undefined)[] | undefined;
53963
+ [key: string]: any;
53964
+ constructor(data?: IGoogleTrendsMapElementItem);
53965
+ init(_data?: any): void;
53966
+ static fromJS(data: any): GoogleTrendsMapElementItem;
53967
+ toJSON(data?: any): any;
53968
+ }
53969
+ export interface IGoogleTrendsMapElementItem extends IBaseGoogleTrendsItem {
53970
+ /** the alignment of the element in Google Trends
53971
+ can take the following values: 1, 2, 3, 4, etc. */
53972
+ position?: number | undefined;
53973
+ /** title of the element in Google Trends */
53974
+ title?: string | undefined;
53975
+ /** relevant keywords
53976
+ the data included in the google_trends_map element is based on the keywords listed in this array */
53977
+ keywords?: (string | undefined)[] | undefined;
53978
+ /** Google Trends data from the corresponding item */
53979
+ data?: (TrendsMapDataInfo | undefined)[] | undefined;
53980
+ [key: string]: any;
53981
+ }
53982
+ export declare class QueriesListDataItemInfo implements IQueriesListDataItemInfo {
53983
+ /** related query */
53984
+ query?: string | undefined;
53985
+ /** search term popularity
53986
+ represents the popularity of the topic. Scoring is on a relative scale where a value of 100 is the most commonly searched topic and a value of 50 is a topic searched half as often as the most popular term, and so on. */
53987
+ value?: string | undefined;
53988
+ [key: string]: any;
53989
+ constructor(data?: IQueriesListDataItemInfo);
53990
+ init(_data?: any): void;
53991
+ static fromJS(data: any): QueriesListDataItemInfo;
53992
+ toJSON(data?: any): any;
53993
+ }
53994
+ export interface IQueriesListDataItemInfo {
53995
+ /** related query */
53996
+ query?: string | undefined;
53997
+ /** search term popularity
53998
+ represents the popularity of the topic. Scoring is on a relative scale where a value of 100 is the most commonly searched topic and a value of 50 is a topic searched half as often as the most popular term, and so on. */
53999
+ value?: string | undefined;
54000
+ [key: string]: any;
54001
+ }
54002
+ export declare class QueriesListDataInfo implements IQueriesListDataInfo {
54003
+ /** the most popular related topics
54004
+ represents the list of the most popular related topics */
54005
+ top?: (QueriesListDataItemInfo | undefined)[] | undefined;
54006
+ /** emerging related topics
54007
+ represents the list of related topics with the biggest increase in search frequency since the last time period */
54008
+ rising?: (QueriesListDataItemInfo | undefined)[] | undefined;
54009
+ [key: string]: any;
54010
+ constructor(data?: IQueriesListDataInfo);
54011
+ init(_data?: any): void;
54012
+ static fromJS(data: any): QueriesListDataInfo;
54013
+ toJSON(data?: any): any;
54014
+ }
54015
+ export interface IQueriesListDataInfo {
54016
+ /** the most popular related topics
54017
+ represents the list of the most popular related topics */
54018
+ top?: (QueriesListDataItemInfo | undefined)[] | undefined;
54019
+ /** emerging related topics
54020
+ represents the list of related topics with the biggest increase in search frequency since the last time period */
54021
+ rising?: (QueriesListDataItemInfo | undefined)[] | undefined;
54022
+ [key: string]: any;
54023
+ }
54024
+ export declare class GoogleTrendsQueriesListElementItem extends BaseGoogleTrendsItem implements IGoogleTrendsQueriesListElementItem {
54025
+ /** the alignment of the element in Google Trends
54026
+ can take the following values: 1, 2, 3, 4, etc. */
54027
+ position?: number | undefined;
54028
+ /** title of the element in Google Trends */
54029
+ title?: string | undefined;
54030
+ /** relevant keywords
54031
+ the data included in the google_trends_topics_list element is based on the keywords listed in this array */
54032
+ keywords?: (string | undefined)[] | undefined;
54033
+ /** Google Trends data from the corresponding item */
54034
+ data?: QueriesListDataInfo | undefined;
54035
+ [key: string]: any;
54036
+ constructor(data?: IGoogleTrendsQueriesListElementItem);
54037
+ init(_data?: any): void;
54038
+ static fromJS(data: any): GoogleTrendsQueriesListElementItem;
54039
+ toJSON(data?: any): any;
54040
+ }
54041
+ export interface IGoogleTrendsQueriesListElementItem extends IBaseGoogleTrendsItem {
54042
+ /** the alignment of the element in Google Trends
54043
+ can take the following values: 1, 2, 3, 4, etc. */
54044
+ position?: number | undefined;
54045
+ /** title of the element in Google Trends */
54046
+ title?: string | undefined;
54047
+ /** relevant keywords
54048
+ the data included in the google_trends_topics_list element is based on the keywords listed in this array */
54049
+ keywords?: (string | undefined)[] | undefined;
54050
+ /** Google Trends data from the corresponding item */
54051
+ data?: QueriesListDataInfo | undefined;
54052
+ [key: string]: any;
54053
+ }
54054
+ export declare class KeywordsDataGoogleTrendsExploreTaskGetResultInfo implements IKeywordsDataGoogleTrendsExploreTaskGetResultInfo {
54055
+ /** keywords in a POST array */
54056
+ keywords?: (string | undefined)[] | undefined;
54057
+ /** type of element */
54058
+ type?: string | undefined;
54059
+ /** location code in a POST array
54060
+ if there is no data, then the value is null */
54061
+ location_code?: number | undefined;
54062
+ /** language code in a POST array
54063
+ if there is no data, then the value is null */
54064
+ language_code?: string | undefined;
54065
+ /** direct URL to the Google Trends results
54066
+ you can use it to make sure that we provided accurate results */
54067
+ check_url?: string | undefined;
54068
+ /** date and time when the result was received
54069
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
54070
+ example:
54071
+ 2019-11-15 12:57:46 +00:00 */
54072
+ datetime?: string | undefined;
54073
+ /** the number of results returned in the items array */
54074
+ items_count?: number | undefined;
54075
+ /** items on the Google Trends page */
54076
+ items?: (BaseGoogleTrendsItem | undefined)[] | undefined;
54077
+ [key: string]: any;
54078
+ constructor(data?: IKeywordsDataGoogleTrendsExploreTaskGetResultInfo);
54079
+ init(_data?: any): void;
54080
+ static fromJS(data: any): KeywordsDataGoogleTrendsExploreTaskGetResultInfo;
54081
+ toJSON(data?: any): any;
54082
+ }
54083
+ export interface IKeywordsDataGoogleTrendsExploreTaskGetResultInfo {
53583
54084
  /** keywords in a POST array */
53584
54085
  keywords?: (string | undefined)[] | undefined;
53585
54086
  /** type of element */
@@ -53618,156 +54119,6 @@ export interface IKeywordsDataGoogleTrendsExploreTaskGetTaskInfo extends IBaseRe
53618
54119
  result?: (KeywordsDataGoogleTrendsExploreTaskGetResultInfo | undefined)[] | undefined;
53619
54120
  [key: string]: any;
53620
54121
  }
53621
- export declare class TrendsMapDataInfo implements ITrendsMapDataInfo {
53622
- /** Google Trends location identifier
53623
- you can use this field for matching obtained results with location parameters specified in the request
53624
- example:
53625
- US-NY */
53626
- geo_id?: string | undefined;
53627
- /** Google Trends location name
53628
- you can use this field for matching obtained results with location parameters specified in the request */
53629
- geo_name?: string | undefined;
53630
- /** relative keyword popularity rate in a given location
53631
- represents the location-specific keyword popularity rate over the given time range
53632
- if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords
53633
- a value of 100 is the peak popularity for the term
53634
- a value of 50 means that the term is half as popular
53635
- a value of 0 means there was not enough data for this term */
53636
- values?: (any | undefined)[] | undefined;
53637
- /** max value among comparable terms
53638
- represents the maximum value if you specified more than two keywords in a POST array
53639
- if you specified only one keyword, the value will be null */
53640
- max_value_index?: number | undefined;
53641
- [key: string]: any;
53642
- constructor(data?: ITrendsMapDataInfo);
53643
- init(_data?: any): void;
53644
- static fromJS(data: any): TrendsMapDataInfo;
53645
- toJSON(data?: any): any;
53646
- }
53647
- export interface ITrendsMapDataInfo {
53648
- /** Google Trends location identifier
53649
- you can use this field for matching obtained results with location parameters specified in the request
53650
- example:
53651
- US-NY */
53652
- geo_id?: string | undefined;
53653
- /** Google Trends location name
53654
- you can use this field for matching obtained results with location parameters specified in the request */
53655
- geo_name?: string | undefined;
53656
- /** relative keyword popularity rate in a given location
53657
- represents the location-specific keyword popularity rate over the given time range
53658
- if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords
53659
- a value of 100 is the peak popularity for the term
53660
- a value of 50 means that the term is half as popular
53661
- a value of 0 means there was not enough data for this term */
53662
- values?: (any | undefined)[] | undefined;
53663
- /** max value among comparable terms
53664
- represents the maximum value if you specified more than two keywords in a POST array
53665
- if you specified only one keyword, the value will be null */
53666
- max_value_index?: number | undefined;
53667
- [key: string]: any;
53668
- }
53669
- export declare class GoogleTrendsMapElementItem extends BaseGoogleTrendsItem implements IGoogleTrendsMapElementItem {
53670
- /** the alignment of the element in Google Trends
53671
- can take the following values: 1, 2, 3, 4, etc. */
53672
- position?: number | undefined;
53673
- /** title of the element in Google Trends */
53674
- title?: string | undefined;
53675
- /** relevant keywords
53676
- the data included in the google_trends_map element is based on the keywords listed in this array */
53677
- keywords?: (string | undefined)[] | undefined;
53678
- /** Google Trends data from the corresponding item */
53679
- data?: (TrendsMapDataInfo | undefined)[] | undefined;
53680
- [key: string]: any;
53681
- constructor(data?: IGoogleTrendsMapElementItem);
53682
- init(_data?: any): void;
53683
- static fromJS(data: any): GoogleTrendsMapElementItem;
53684
- toJSON(data?: any): any;
53685
- }
53686
- export interface IGoogleTrendsMapElementItem extends IBaseGoogleTrendsItem {
53687
- /** the alignment of the element in Google Trends
53688
- can take the following values: 1, 2, 3, 4, etc. */
53689
- position?: number | undefined;
53690
- /** title of the element in Google Trends */
53691
- title?: string | undefined;
53692
- /** relevant keywords
53693
- the data included in the google_trends_map element is based on the keywords listed in this array */
53694
- keywords?: (string | undefined)[] | undefined;
53695
- /** Google Trends data from the corresponding item */
53696
- data?: (TrendsMapDataInfo | undefined)[] | undefined;
53697
- [key: string]: any;
53698
- }
53699
- export declare class QueriesListDataItemInfo implements IQueriesListDataItemInfo {
53700
- /** related query */
53701
- query?: string | undefined;
53702
- /** search term popularity
53703
- represents the popularity of the topic. Scoring is on a relative scale where a value of 100 is the most commonly searched topic and a value of 50 is a topic searched half as often as the most popular term, and so on. */
53704
- value?: string | undefined;
53705
- [key: string]: any;
53706
- constructor(data?: IQueriesListDataItemInfo);
53707
- init(_data?: any): void;
53708
- static fromJS(data: any): QueriesListDataItemInfo;
53709
- toJSON(data?: any): any;
53710
- }
53711
- export interface IQueriesListDataItemInfo {
53712
- /** related query */
53713
- query?: string | undefined;
53714
- /** search term popularity
53715
- represents the popularity of the topic. Scoring is on a relative scale where a value of 100 is the most commonly searched topic and a value of 50 is a topic searched half as often as the most popular term, and so on. */
53716
- value?: string | undefined;
53717
- [key: string]: any;
53718
- }
53719
- export declare class QueriesListDataInfo implements IQueriesListDataInfo {
53720
- /** the most popular related topics
53721
- represents the list of the most popular related topics */
53722
- top?: (QueriesListDataItemInfo | undefined)[] | undefined;
53723
- /** emerging related topics
53724
- represents the list of related topics with the biggest increase in search frequency since the last time period */
53725
- rising?: (QueriesListDataItemInfo | undefined)[] | undefined;
53726
- [key: string]: any;
53727
- constructor(data?: IQueriesListDataInfo);
53728
- init(_data?: any): void;
53729
- static fromJS(data: any): QueriesListDataInfo;
53730
- toJSON(data?: any): any;
53731
- }
53732
- export interface IQueriesListDataInfo {
53733
- /** the most popular related topics
53734
- represents the list of the most popular related topics */
53735
- top?: (QueriesListDataItemInfo | undefined)[] | undefined;
53736
- /** emerging related topics
53737
- represents the list of related topics with the biggest increase in search frequency since the last time period */
53738
- rising?: (QueriesListDataItemInfo | undefined)[] | undefined;
53739
- [key: string]: any;
53740
- }
53741
- export declare class GoogleTrendsQueriesListElementItem extends BaseGoogleTrendsItem implements IGoogleTrendsQueriesListElementItem {
53742
- /** the alignment of the element in Google Trends
53743
- can take the following values: 1, 2, 3, 4, etc. */
53744
- position?: number | undefined;
53745
- /** title of the element in Google Trends */
53746
- title?: string | undefined;
53747
- /** relevant keywords
53748
- the data included in the google_trends_topics_list element is based on the keywords listed in this array */
53749
- keywords?: (string | undefined)[] | undefined;
53750
- /** Google Trends data from the corresponding item */
53751
- data?: QueriesListDataInfo | undefined;
53752
- [key: string]: any;
53753
- constructor(data?: IGoogleTrendsQueriesListElementItem);
53754
- init(_data?: any): void;
53755
- static fromJS(data: any): GoogleTrendsQueriesListElementItem;
53756
- toJSON(data?: any): any;
53757
- }
53758
- export interface IGoogleTrendsQueriesListElementItem extends IBaseGoogleTrendsItem {
53759
- /** the alignment of the element in Google Trends
53760
- can take the following values: 1, 2, 3, 4, etc. */
53761
- position?: number | undefined;
53762
- /** title of the element in Google Trends */
53763
- title?: string | undefined;
53764
- /** relevant keywords
53765
- the data included in the google_trends_topics_list element is based on the keywords listed in this array */
53766
- keywords?: (string | undefined)[] | undefined;
53767
- /** Google Trends data from the corresponding item */
53768
- data?: QueriesListDataInfo | undefined;
53769
- [key: string]: any;
53770
- }
53771
54122
  export declare class KeywordsDataGoogleTrendsExploreTaskGetResponseInfo extends BaseResponseInfo implements IKeywordsDataGoogleTrendsExploreTaskGetResponseInfo {
53772
54123
  /** array of tasks */
53773
54124
  tasks?: (KeywordsDataGoogleTrendsExploreTaskGetTaskInfo | undefined)[] | undefined;
@@ -55589,7 +55940,8 @@ if you don’t specify this field, data will be provided for the last 12 months
55589
55940
  minimum value: two years back from today’s date
55590
55941
  date format: "yyyy-mm-dd"
55591
55942
  example:
55592
- "2020-01-01" */
55943
+ "2020-01-01"
55944
+ Note: we do not recommend using a custom time range for the past year’s dates */
55593
55945
  date_from?: string | undefined;
55594
55946
  /** ending date of the time range
55595
55947
  optional field
@@ -55599,7 +55951,8 @@ maximum value: one month from today’s date;
55599
55951
  note: we do not recommend using a custom time range for the past year’s dates;
55600
55952
  date format: "yyyy-mm-dd"
55601
55953
  example:
55602
- "2020-03-15" */
55954
+ "2020-03-15"
55955
+ Note: we do not recommend using a custom time range for the past year’s dates */
55603
55956
  date_to?: string | undefined;
55604
55957
  /** return URL for sending task results
55605
55958
  optional field
@@ -55695,7 +56048,8 @@ if you don’t specify this field, data will be provided for the last 12 months
55695
56048
  minimum value: two years back from today’s date
55696
56049
  date format: "yyyy-mm-dd"
55697
56050
  example:
55698
- "2020-01-01" */
56051
+ "2020-01-01"
56052
+ Note: we do not recommend using a custom time range for the past year’s dates */
55699
56053
  date_from?: string | undefined;
55700
56054
  /** ending date of the time range
55701
56055
  optional field
@@ -55705,7 +56059,8 @@ maximum value: one month from today’s date;
55705
56059
  note: we do not recommend using a custom time range for the past year’s dates;
55706
56060
  date format: "yyyy-mm-dd"
55707
56061
  example:
55708
- "2020-03-15" */
56062
+ "2020-03-15"
56063
+ Note: we do not recommend using a custom time range for the past year’s dates */
55709
56064
  date_to?: string | undefined;
55710
56065
  /** return URL for sending task results
55711
56066
  optional field
@@ -55999,7 +56354,8 @@ if you don’t specify this field, data will be provided for the last 12 months
55999
56354
  minimum value: two years back from today’s date
56000
56355
  date format: "yyyy-mm-dd"
56001
56356
  example:
56002
- "2020-01-01" */
56357
+ "2020-01-01"
56358
+ Note: we do not recommend using a custom time range for the past year’s dates */
56003
56359
  date_from?: string | undefined;
56004
56360
  /** ending date of the time range
56005
56361
  optional field
@@ -56009,7 +56365,8 @@ maximum value: one month from today’s date;
56009
56365
  note: we do not recommend using a custom time range for the past year’s dates;
56010
56366
  date format: "yyyy-mm-dd"
56011
56367
  example:
56012
- "2020-03-15" */
56368
+ "2020-03-15"
56369
+ Note: we do not recommend using a custom time range for the past year’s dates */
56013
56370
  date_to?: string | undefined;
56014
56371
  /** Bing search partners type
56015
56372
  optional field
@@ -56085,7 +56442,8 @@ if you don’t specify this field, data will be provided for the last 12 months
56085
56442
  minimum value: two years back from today’s date
56086
56443
  date format: "yyyy-mm-dd"
56087
56444
  example:
56088
- "2020-01-01" */
56445
+ "2020-01-01"
56446
+ Note: we do not recommend using a custom time range for the past year’s dates */
56089
56447
  date_from?: string | undefined;
56090
56448
  /** ending date of the time range
56091
56449
  optional field
@@ -56095,7 +56453,8 @@ maximum value: one month from today’s date;
56095
56453
  note: we do not recommend using a custom time range for the past year’s dates;
56096
56454
  date format: "yyyy-mm-dd"
56097
56455
  example:
56098
- "2020-03-15" */
56456
+ "2020-03-15"
56457
+ Note: we do not recommend using a custom time range for the past year’s dates */
56099
56458
  date_to?: string | undefined;
56100
56459
  /** Bing search partners type
56101
56460
  optional field
@@ -56281,17 +56640,18 @@ optional field
56281
56640
  if you don’t specify this field, data will be provided for the last 12 months
56282
56641
  date format: "yyyy-mm-dd"
56283
56642
  example:
56284
- "2020-01-01" */
56643
+ "2020-01-01"
56644
+ Note: we do not recommend using a custom time range for the past year’s dates */
56285
56645
  date_from?: string | undefined;
56286
56646
  /** ending date of the time range
56287
56647
  optional field
56288
56648
  if you don’t specify this field, data will be provided for the last 12 months;
56289
56649
  minimum value: two years back from today’s date;
56290
56650
  maximum value: one month from today’s date;
56291
- note: we do not recommend using a custom time range for the past year’s dates;
56292
56651
  date format: "yyyy-mm-dd"
56293
56652
  example:
56294
- "2020-03-15" */
56653
+ "2020-03-15"
56654
+ Note: we do not recommend using a custom time range for the past year’s dates */
56295
56655
  date_to?: string | undefined;
56296
56656
  /** return URL for sending task results
56297
56657
  optional field
@@ -56391,17 +56751,18 @@ optional field
56391
56751
  if you don’t specify this field, data will be provided for the last 12 months
56392
56752
  date format: "yyyy-mm-dd"
56393
56753
  example:
56394
- "2020-01-01" */
56754
+ "2020-01-01"
56755
+ Note: we do not recommend using a custom time range for the past year’s dates */
56395
56756
  date_from?: string | undefined;
56396
56757
  /** ending date of the time range
56397
56758
  optional field
56398
56759
  if you don’t specify this field, data will be provided for the last 12 months;
56399
56760
  minimum value: two years back from today’s date;
56400
56761
  maximum value: one month from today’s date;
56401
- note: we do not recommend using a custom time range for the past year’s dates;
56402
56762
  date format: "yyyy-mm-dd"
56403
56763
  example:
56404
- "2020-03-15" */
56764
+ "2020-03-15"
56765
+ Note: we do not recommend using a custom time range for the past year’s dates */
56405
56766
  date_to?: string | undefined;
56406
56767
  /** return URL for sending task results
56407
56768
  optional field
@@ -56697,7 +57058,8 @@ optional field
56697
57058
  if you don’t specify this field, data will be provided for the last 12 months
56698
57059
  date format: "yyyy-mm-dd"
56699
57060
  example:
56700
- "2020-01-01" */
57061
+ "2020-01-01"
57062
+ Note: we do not recommend using a custom time range for the past year’s dates */
56701
57063
  date_from?: string | undefined;
56702
57064
  /** ending date of the time range
56703
57065
  optional field
@@ -56707,7 +57069,8 @@ maximum value: one month from today’s date;
56707
57069
  note: we do not recommend using a custom time range for the past year’s dates;
56708
57070
  date format: "yyyy-mm-dd"
56709
57071
  example:
56710
- "2020-03-15" */
57072
+ "2020-03-15"
57073
+ Note: we do not recommend using a custom time range for the past year’s dates */
56711
57074
  date_to?: string | undefined;
56712
57075
  /** results sorting parameters
56713
57076
  optional field
@@ -56786,7 +57149,8 @@ optional field
56786
57149
  if you don’t specify this field, data will be provided for the last 12 months
56787
57150
  date format: "yyyy-mm-dd"
56788
57151
  example:
56789
- "2020-01-01" */
57152
+ "2020-01-01"
57153
+ Note: we do not recommend using a custom time range for the past year’s dates */
56790
57154
  date_from?: string | undefined;
56791
57155
  /** ending date of the time range
56792
57156
  optional field
@@ -56796,7 +57160,8 @@ maximum value: one month from today’s date;
56796
57160
  note: we do not recommend using a custom time range for the past year’s dates;
56797
57161
  date format: "yyyy-mm-dd"
56798
57162
  example:
56799
- "2020-03-15" */
57163
+ "2020-03-15"
57164
+ Note: we do not recommend using a custom time range for the past year’s dates */
56800
57165
  date_to?: string | undefined;
56801
57166
  /** results sorting parameters
56802
57167
  optional field
@@ -56981,17 +57346,18 @@ you can specify a date from the past 24 months
56981
57346
  if you don’t specify this field, data will be provided for the last 12 months
56982
57347
  date format: "yyyy-mm-dd"
56983
57348
  example:
56984
- "2020-01-01" */
57349
+ "2020-01-01"
57350
+ Note: we do not recommend using a custom time range for the past year’s dates */
56985
57351
  date_from?: string | undefined;
56986
57352
  /** ending date of the time range
56987
57353
  optional field
56988
57354
  if you don’t specify this field, data will be provided for the last 12 months;
56989
57355
  minimum value: two years back from today’s date;
56990
57356
  maximum value: one month from today’s date;
56991
- note: we do not recommend using a custom time range for the past year’s dates;
56992
57357
  date format: "yyyy-mm-dd"
56993
57358
  example:
56994
- "2020-03-15" */
57359
+ "2020-03-15"
57360
+ Note: we do not recommend using a custom time range for the past year’s dates */
56995
57361
  date_to?: string | undefined;
56996
57362
  /** Bing search partners type
56997
57363
  optional field
@@ -57093,17 +57459,18 @@ you can specify a date from the past 24 months
57093
57459
  if you don’t specify this field, data will be provided for the last 12 months
57094
57460
  date format: "yyyy-mm-dd"
57095
57461
  example:
57096
- "2020-01-01" */
57462
+ "2020-01-01"
57463
+ Note: we do not recommend using a custom time range for the past year’s dates */
57097
57464
  date_from?: string | undefined;
57098
57465
  /** ending date of the time range
57099
57466
  optional field
57100
57467
  if you don’t specify this field, data will be provided for the last 12 months;
57101
57468
  minimum value: two years back from today’s date;
57102
57469
  maximum value: one month from today’s date;
57103
- note: we do not recommend using a custom time range for the past year’s dates;
57104
57470
  date format: "yyyy-mm-dd"
57105
57471
  example:
57106
- "2020-03-15" */
57472
+ "2020-03-15"
57473
+ Note: we do not recommend using a custom time range for the past year’s dates */
57107
57474
  date_to?: string | undefined;
57108
57475
  /** Bing search partners type
57109
57476
  optional field
@@ -57405,17 +57772,18 @@ you can specify a date from the past 24 months
57405
57772
  if you don’t specify this field, data will be provided for the last 12 months
57406
57773
  date format: "yyyy-mm-dd"
57407
57774
  example:
57408
- "2020-01-01" */
57775
+ "2020-01-01"
57776
+ Note: we do not recommend using a custom time range for the past year’s dates */
57409
57777
  date_from?: string | undefined;
57410
57778
  /** ending date of the time range
57411
57779
  optional field
57412
57780
  if you don’t specify this field, data will be provided for the last 12 months;
57413
57781
  minimum value: two years back from today’s date;
57414
57782
  maximum value: one month from today’s date;
57415
- note: we do not recommend using a custom time range for the past year’s dates;
57416
57783
  date format: "yyyy-mm-dd"
57417
57784
  example:
57418
- "2020-03-15" */
57785
+ "2020-03-15"
57786
+ Note: we do not recommend using a custom time range for the past year’s dates */
57419
57787
  date_to?: string | undefined;
57420
57788
  /** Bing search partners type
57421
57789
  optional field
@@ -57497,17 +57865,18 @@ you can specify a date from the past 24 months
57497
57865
  if you don’t specify this field, data will be provided for the last 12 months
57498
57866
  date format: "yyyy-mm-dd"
57499
57867
  example:
57500
- "2020-01-01" */
57868
+ "2020-01-01"
57869
+ Note: we do not recommend using a custom time range for the past year’s dates */
57501
57870
  date_from?: string | undefined;
57502
57871
  /** ending date of the time range
57503
57872
  optional field
57504
57873
  if you don’t specify this field, data will be provided for the last 12 months;
57505
57874
  minimum value: two years back from today’s date;
57506
57875
  maximum value: one month from today’s date;
57507
- note: we do not recommend using a custom time range for the past year’s dates;
57508
57876
  date format: "yyyy-mm-dd"
57509
57877
  example:
57510
- "2020-03-15" */
57878
+ "2020-03-15"
57879
+ Note: we do not recommend using a custom time range for the past year’s dates */
57511
57880
  date_to?: string | undefined;
57512
57881
  /** Bing search partners type
57513
57882
  optional field
@@ -58370,6 +58739,752 @@ export interface IKeywordsDataBingKeywordPerformanceLiveResponseInfo extends IBa
58370
58739
  tasks?: (KeywordsDataBingKeywordPerformanceLiveTaskInfo | undefined)[] | undefined;
58371
58740
  [key: string]: any;
58372
58741
  }
58742
+ export declare class KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo implements IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo {
58743
+ /** language name */
58744
+ language_name?: string | undefined;
58745
+ /** language code according to ISO 639-1 */
58746
+ language_code?: string | undefined;
58747
+ /** array of available locations for a certain language */
58748
+ available_locations?: (AvailableLocations | undefined)[] | undefined;
58749
+ [key: string]: any;
58750
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo);
58751
+ init(_data?: any): void;
58752
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo;
58753
+ toJSON(data?: any): any;
58754
+ }
58755
+ export interface IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo {
58756
+ /** language name */
58757
+ language_name?: string | undefined;
58758
+ /** language code according to ISO 639-1 */
58759
+ language_code?: string | undefined;
58760
+ /** array of available locations for a certain language */
58761
+ available_locations?: (AvailableLocations | undefined)[] | undefined;
58762
+ [key: string]: any;
58763
+ }
58764
+ export declare class KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo {
58765
+ /** array of results */
58766
+ result?: (KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo | undefined)[] | undefined;
58767
+ [key: string]: any;
58768
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo);
58769
+ init(_data?: any): void;
58770
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo;
58771
+ toJSON(data?: any): any;
58772
+ }
58773
+ export interface IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo extends IBaseResponseTaskInfo {
58774
+ /** array of results */
58775
+ result?: (KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo | undefined)[] | undefined;
58776
+ [key: string]: any;
58777
+ }
58778
+ export declare class KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo extends BaseResponseInfo implements IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo {
58779
+ /** array of tasks */
58780
+ tasks?: (KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo | undefined)[] | undefined;
58781
+ [key: string]: any;
58782
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo);
58783
+ init(_data?: any): void;
58784
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo;
58785
+ toJSON(data?: any): any;
58786
+ }
58787
+ export interface IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo extends IBaseResponseInfo {
58788
+ /** array of tasks */
58789
+ tasks?: (KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo | undefined)[] | undefined;
58790
+ [key: string]: any;
58791
+ }
58792
+ export declare class KeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo implements IKeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo {
58793
+ /** keywords
58794
+ required field
58795
+ The maximum number of keywords you can specify: 1000
58796
+ The maximum number of characters for each keyword: 100
58797
+ the specified keywords will be converted to lowercase, data will be provided in a separate array */
58798
+ keywords?: string[];
58799
+ /** full name of search engine location
58800
+ required field if you don’t specify location_code or location_coordinate
58801
+ if you use this field, you don’t need to specify location_code or location_coordinate
58802
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
58803
+ example:
58804
+ London,England,United Kingdom */
58805
+ location_name?: string | undefined;
58806
+ /** search engine location code
58807
+ required field if you don’t specify location_name or location_coordinate
58808
+ if you use this field, you don’t need to specify location_name or location_coordinate
58809
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
58810
+ example:
58811
+ 2840 */
58812
+ location_code?: number | undefined;
58813
+ /** GPS coordinates of a location
58814
+ required field if you don’t specify location_name or location_code
58815
+ if you use this field, you don’t need to specify location_name or location_code
58816
+ location_coordinate parameter should be specified in the “latitude,longitude” format
58817
+ the data will be provided for the country the specified coordinates belong to
58818
+ example:
58819
+ 52.6178549,-155.352142 */
58820
+ location_coordinate?: string | undefined;
58821
+ /** full name of search engine language
58822
+ required field if you don’t specify language_code
58823
+ if you use this field, you don’t need to specify language_code
58824
+ you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
58825
+ language_name?: string | undefined;
58826
+ /** search engine language code
58827
+ required field if you don’t specify language_name
58828
+ if you use this field, you don’t need to specify language_name
58829
+ you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
58830
+ language_code?: string | undefined;
58831
+ /** device type
58832
+ optional field
58833
+ specify this field if you want to get the data for a particular device type
58834
+ possible values: mobile, desktop, tablet, non_smartphones
58835
+ default value: mobile, desktop, tablet, non_smartphones */
58836
+ device?: string | undefined;
58837
+ /** aggregates the returned data to a certain time period
58838
+ optional field
58839
+ specify this field if you want to get the data in monthly, weekly or daily format
58840
+ possible values: monthly, weekly, daily
58841
+ monthly – returns data up to past 24 months
58842
+ weekly – returns data up to past 15 weeks
58843
+ daily – returns data up to past 45 days
58844
+ default value: monthly */
58845
+ period?: string | undefined;
58846
+ /** starting date of the time range
58847
+ optional field
58848
+ minimum value: two years back from today’s date
58849
+ maximum value: one day from today’s date
58850
+ date format: "yyyy-mm-dd"
58851
+ example:
58852
+ "2020-01-01"
58853
+ Note: we do not recommend using a custom time range
58854
+ Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
58855
+ if you specify the period parameter:
58856
+ with value weekly, you will get results for the past 15 weeks
58857
+ with value daily, you will get results for the past 45 days */
58858
+ date_from?: string | undefined;
58859
+ /** ending date of the time range
58860
+ optional field
58861
+ minimum value: two years back from today’s date;
58862
+ maximum value: one day from today’s date;
58863
+ date format: "yyyy-mm-dd"
58864
+ example:
58865
+ "2020-03-15"
58866
+ Note: we do not recommend using a custom time range
58867
+ Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
58868
+ if you specify the period parameter:
58869
+ with value weekly, you will get results for the past 15 weeks
58870
+ with value daily, you will get results for the past 45 days */
58871
+ date_to?: string | undefined;
58872
+ /** return URL for sending task results
58873
+ optional field
58874
+ once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
58875
+ you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
58876
+ example:
58877
+ http://your-server.com/postbackscript?id=$id
58878
+ http://your-server.com/postbackscript?id=$id&tag=$tag
58879
+ Note: special symbols in postback_url will be urlencoded;
58880
+ i.a., the # symbol will be encoded into %23 */
58881
+ postback_url?: string | undefined;
58882
+ /** notification URL of a completed task
58883
+ optional field
58884
+ when a task is completed we will notify you by GET request sent to the URL you have specified
58885
+ you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
58886
+ example:
58887
+ http://your-server.com/pingscript?id=$id
58888
+ http://your-server.com/pingscript?id=$id&tag=$tag
58889
+ Note: special symbols in pingback_url will be urlencoded;
58890
+ i.a., the # symbol will be encoded into %23 */
58891
+ pingback_url?: string | undefined;
58892
+ /** user-defined task identifier
58893
+ optional field
58894
+ the character limit is 255
58895
+ you can use this parameter to identify the task and match it with the result
58896
+ you will find the specified tag value in the data object of the response */
58897
+ tag?: string | undefined;
58898
+ [key: string]: any;
58899
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo);
58900
+ init(_data?: any): void;
58901
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo;
58902
+ toJSON(data?: any): any;
58903
+ }
58904
+ export interface IKeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo {
58905
+ /** keywords
58906
+ required field
58907
+ The maximum number of keywords you can specify: 1000
58908
+ The maximum number of characters for each keyword: 100
58909
+ the specified keywords will be converted to lowercase, data will be provided in a separate array */
58910
+ keywords?: string[];
58911
+ /** full name of search engine location
58912
+ required field if you don’t specify location_code or location_coordinate
58913
+ if you use this field, you don’t need to specify location_code or location_coordinate
58914
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
58915
+ example:
58916
+ London,England,United Kingdom */
58917
+ location_name?: string | undefined;
58918
+ /** search engine location code
58919
+ required field if you don’t specify location_name or location_coordinate
58920
+ if you use this field, you don’t need to specify location_name or location_coordinate
58921
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
58922
+ example:
58923
+ 2840 */
58924
+ location_code?: number | undefined;
58925
+ /** GPS coordinates of a location
58926
+ required field if you don’t specify location_name or location_code
58927
+ if you use this field, you don’t need to specify location_name or location_code
58928
+ location_coordinate parameter should be specified in the “latitude,longitude” format
58929
+ the data will be provided for the country the specified coordinates belong to
58930
+ example:
58931
+ 52.6178549,-155.352142 */
58932
+ location_coordinate?: string | undefined;
58933
+ /** full name of search engine language
58934
+ required field if you don’t specify language_code
58935
+ if you use this field, you don’t need to specify language_code
58936
+ you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
58937
+ language_name?: string | undefined;
58938
+ /** search engine language code
58939
+ required field if you don’t specify language_name
58940
+ if you use this field, you don’t need to specify language_name
58941
+ you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
58942
+ language_code?: string | undefined;
58943
+ /** device type
58944
+ optional field
58945
+ specify this field if you want to get the data for a particular device type
58946
+ possible values: mobile, desktop, tablet, non_smartphones
58947
+ default value: mobile, desktop, tablet, non_smartphones */
58948
+ device?: string | undefined;
58949
+ /** aggregates the returned data to a certain time period
58950
+ optional field
58951
+ specify this field if you want to get the data in monthly, weekly or daily format
58952
+ possible values: monthly, weekly, daily
58953
+ monthly – returns data up to past 24 months
58954
+ weekly – returns data up to past 15 weeks
58955
+ daily – returns data up to past 45 days
58956
+ default value: monthly */
58957
+ period?: string | undefined;
58958
+ /** starting date of the time range
58959
+ optional field
58960
+ minimum value: two years back from today’s date
58961
+ maximum value: one day from today’s date
58962
+ date format: "yyyy-mm-dd"
58963
+ example:
58964
+ "2020-01-01"
58965
+ Note: we do not recommend using a custom time range
58966
+ Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
58967
+ if you specify the period parameter:
58968
+ with value weekly, you will get results for the past 15 weeks
58969
+ with value daily, you will get results for the past 45 days */
58970
+ date_from?: string | undefined;
58971
+ /** ending date of the time range
58972
+ optional field
58973
+ minimum value: two years back from today’s date;
58974
+ maximum value: one day from today’s date;
58975
+ date format: "yyyy-mm-dd"
58976
+ example:
58977
+ "2020-03-15"
58978
+ Note: we do not recommend using a custom time range
58979
+ Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
58980
+ if you specify the period parameter:
58981
+ with value weekly, you will get results for the past 15 weeks
58982
+ with value daily, you will get results for the past 45 days */
58983
+ date_to?: string | undefined;
58984
+ /** return URL for sending task results
58985
+ optional field
58986
+ once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
58987
+ you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
58988
+ example:
58989
+ http://your-server.com/postbackscript?id=$id
58990
+ http://your-server.com/postbackscript?id=$id&tag=$tag
58991
+ Note: special symbols in postback_url will be urlencoded;
58992
+ i.a., the # symbol will be encoded into %23 */
58993
+ postback_url?: string | undefined;
58994
+ /** notification URL of a completed task
58995
+ optional field
58996
+ when a task is completed we will notify you by GET request sent to the URL you have specified
58997
+ you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
58998
+ example:
58999
+ http://your-server.com/pingscript?id=$id
59000
+ http://your-server.com/pingscript?id=$id&tag=$tag
59001
+ Note: special symbols in pingback_url will be urlencoded;
59002
+ i.a., the # symbol will be encoded into %23 */
59003
+ pingback_url?: string | undefined;
59004
+ /** user-defined task identifier
59005
+ optional field
59006
+ the character limit is 255
59007
+ you can use this parameter to identify the task and match it with the result
59008
+ you will find the specified tag value in the data object of the response */
59009
+ tag?: string | undefined;
59010
+ [key: string]: any;
59011
+ }
59012
+ export declare class KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo {
59013
+ /** array of results
59014
+ in this case, the value will be null */
59015
+ result?: any | undefined;
59016
+ [key: string]: any;
59017
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo);
59018
+ init(_data?: any): void;
59019
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo;
59020
+ toJSON(data?: any): any;
59021
+ }
59022
+ export interface IKeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo extends IBaseResponseTaskInfo {
59023
+ /** array of results
59024
+ in this case, the value will be null */
59025
+ result?: any | undefined;
59026
+ [key: string]: any;
59027
+ }
59028
+ export declare class KeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo extends BaseResponseInfo implements IKeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo {
59029
+ /** array of tasks */
59030
+ tasks?: (KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo | undefined)[] | undefined;
59031
+ [key: string]: any;
59032
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo);
59033
+ init(_data?: any): void;
59034
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo;
59035
+ toJSON(data?: any): any;
59036
+ }
59037
+ export interface IKeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo extends IBaseResponseInfo {
59038
+ /** array of tasks */
59039
+ tasks?: (KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo | undefined)[] | undefined;
59040
+ [key: string]: any;
59041
+ }
59042
+ export declare class KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo implements IKeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo {
59043
+ /** task identifier of the completed task
59044
+ unique task identifier in our system in the UUID format */
59045
+ id?: string | undefined;
59046
+ /** search engine specified when setting the task */
59047
+ se?: string | undefined;
59048
+ /** type of the task */
59049
+ function?: string | undefined;
59050
+ /** date when the task was posted (in the UTC format) */
59051
+ date_posted?: string | undefined;
59052
+ /** user-defined task identifier */
59053
+ tag?: string | undefined;
59054
+ /** URL for collecting the results of the task */
59055
+ endpoint?: string | undefined;
59056
+ [key: string]: any;
59057
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo);
59058
+ init(_data?: any): void;
59059
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo;
59060
+ toJSON(data?: any): any;
59061
+ }
59062
+ export interface IKeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo {
59063
+ /** task identifier of the completed task
59064
+ unique task identifier in our system in the UUID format */
59065
+ id?: string | undefined;
59066
+ /** search engine specified when setting the task */
59067
+ se?: string | undefined;
59068
+ /** type of the task */
59069
+ function?: string | undefined;
59070
+ /** date when the task was posted (in the UTC format) */
59071
+ date_posted?: string | undefined;
59072
+ /** user-defined task identifier */
59073
+ tag?: string | undefined;
59074
+ /** URL for collecting the results of the task */
59075
+ endpoint?: string | undefined;
59076
+ [key: string]: any;
59077
+ }
59078
+ export declare class KeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo {
59079
+ /** array of results */
59080
+ result?: (KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo | undefined)[] | undefined;
59081
+ [key: string]: any;
59082
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo);
59083
+ init(_data?: any): void;
59084
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo;
59085
+ toJSON(data?: any): any;
59086
+ }
59087
+ export interface IKeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo extends IBaseResponseTaskInfo {
59088
+ /** array of results */
59089
+ result?: (KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo | undefined)[] | undefined;
59090
+ [key: string]: any;
59091
+ }
59092
+ export declare class KeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo extends BaseResponseInfo implements IKeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo {
59093
+ /** array of tasks */
59094
+ tasks?: (KeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo | undefined)[] | undefined;
59095
+ [key: string]: any;
59096
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo);
59097
+ init(_data?: any): void;
59098
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo;
59099
+ toJSON(data?: any): any;
59100
+ }
59101
+ export interface IKeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo extends IBaseResponseInfo {
59102
+ /** array of tasks */
59103
+ tasks?: (KeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo | undefined)[] | undefined;
59104
+ [key: string]: any;
59105
+ }
59106
+ /** device type = desktop contains historical search volume data for searches made from desktop devices */
59107
+ export declare class SearchVolumeHistoryItemInfo implements ISearchVolumeHistoryItemInfo {
59108
+ /** year */
59109
+ year?: number | undefined;
59110
+ /** month */
59111
+ month?: number | undefined;
59112
+ /** day of the month */
59113
+ day?: number | undefined;
59114
+ /** search volume rate */
59115
+ search_volume?: number | undefined;
59116
+ [key: string]: any;
59117
+ constructor(data?: ISearchVolumeHistoryItemInfo);
59118
+ init(_data?: any): void;
59119
+ static fromJS(data: any): SearchVolumeHistoryItemInfo;
59120
+ toJSON(data?: any): any;
59121
+ }
59122
+ /** device type = desktop contains historical search volume data for searches made from desktop devices */
59123
+ export interface ISearchVolumeHistoryItemInfo {
59124
+ /** year */
59125
+ year?: number | undefined;
59126
+ /** month */
59127
+ month?: number | undefined;
59128
+ /** day of the month */
59129
+ day?: number | undefined;
59130
+ /** search volume rate */
59131
+ search_volume?: number | undefined;
59132
+ [key: string]: any;
59133
+ }
59134
+ export declare class SearchVolumeHistorySearchInfo implements ISearchVolumeHistorySearchInfo {
59135
+ /** device type = desktop
59136
+ contains historical search volume data for searches made from desktop devices */
59137
+ desktop?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
59138
+ /** device type = non-smartphones
59139
+ contains historical search volume data for searches made from feature phones (non-smartphone mobile devices) */
59140
+ non_smartphones?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
59141
+ /** device type = mobile
59142
+ contains historical search volume data for searches made from mobile devices */
59143
+ mobile?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
59144
+ /** device type = tablet
59145
+ contains historical search volume data for searches made from tablets */
59146
+ tablet?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
59147
+ [key: string]: any;
59148
+ constructor(data?: ISearchVolumeHistorySearchInfo);
59149
+ init(_data?: any): void;
59150
+ static fromJS(data: any): SearchVolumeHistorySearchInfo;
59151
+ toJSON(data?: any): any;
59152
+ }
59153
+ export interface ISearchVolumeHistorySearchInfo {
59154
+ /** device type = desktop
59155
+ contains historical search volume data for searches made from desktop devices */
59156
+ desktop?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
59157
+ /** device type = non-smartphones
59158
+ contains historical search volume data for searches made from feature phones (non-smartphone mobile devices) */
59159
+ non_smartphones?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
59160
+ /** device type = mobile
59161
+ contains historical search volume data for searches made from mobile devices */
59162
+ mobile?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
59163
+ /** device type = tablet
59164
+ contains historical search volume data for searches made from tablets */
59165
+ tablet?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
59166
+ [key: string]: any;
59167
+ }
59168
+ export declare class KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo implements IKeywordsDataBingSearchVolumeHistoryTaskGetResultInfo {
59169
+ /** keyword in a POST array */
59170
+ keyword?: string | undefined;
59171
+ /** location code in a POST array
59172
+ if there is no data, then the value is null */
59173
+ location_code?: number | undefined;
59174
+ /** language code in a POST array
59175
+ if there is no data, then the value is null */
59176
+ language_code?: string | undefined;
59177
+ device?: (string | undefined)[] | undefined;
59178
+ /** time period
59179
+ indicates if returned data is aggregated to a certain time period
59180
+ default value monthly */
59181
+ period?: string | undefined;
59182
+ /** contains results distributed by device type
59183
+ if the device parameter is not specified, the data will be returned for all available device types */
59184
+ searches?: SearchVolumeHistorySearchInfo | undefined;
59185
+ [key: string]: any;
59186
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryTaskGetResultInfo);
59187
+ init(_data?: any): void;
59188
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo;
59189
+ toJSON(data?: any): any;
59190
+ }
59191
+ export interface IKeywordsDataBingSearchVolumeHistoryTaskGetResultInfo {
59192
+ /** keyword in a POST array */
59193
+ keyword?: string | undefined;
59194
+ /** location code in a POST array
59195
+ if there is no data, then the value is null */
59196
+ location_code?: number | undefined;
59197
+ /** language code in a POST array
59198
+ if there is no data, then the value is null */
59199
+ language_code?: string | undefined;
59200
+ device?: (string | undefined)[] | undefined;
59201
+ /** time period
59202
+ indicates if returned data is aggregated to a certain time period
59203
+ default value monthly */
59204
+ period?: string | undefined;
59205
+ /** contains results distributed by device type
59206
+ if the device parameter is not specified, the data will be returned for all available device types */
59207
+ searches?: SearchVolumeHistorySearchInfo | undefined;
59208
+ [key: string]: any;
59209
+ }
59210
+ export declare class KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo {
59211
+ /** array of results */
59212
+ result?: (KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo | undefined)[] | undefined;
59213
+ [key: string]: any;
59214
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo);
59215
+ init(_data?: any): void;
59216
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo;
59217
+ toJSON(data?: any): any;
59218
+ }
59219
+ export interface IKeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo extends IBaseResponseTaskInfo {
59220
+ /** array of results */
59221
+ result?: (KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo | undefined)[] | undefined;
59222
+ [key: string]: any;
59223
+ }
59224
+ export declare class KeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo extends BaseResponseInfo implements IKeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo {
59225
+ /** array of tasks */
59226
+ tasks?: (KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo | undefined)[] | undefined;
59227
+ [key: string]: any;
59228
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo);
59229
+ init(_data?: any): void;
59230
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo;
59231
+ toJSON(data?: any): any;
59232
+ }
59233
+ export interface IKeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo extends IBaseResponseInfo {
59234
+ /** array of tasks */
59235
+ tasks?: (KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo | undefined)[] | undefined;
59236
+ [key: string]: any;
59237
+ }
59238
+ export declare class KeywordsDataBingSearchVolumeHistoryLiveRequestInfo implements IKeywordsDataBingSearchVolumeHistoryLiveRequestInfo {
59239
+ /** keywords
59240
+ required field
59241
+ The maximum number of keywords you can specify: 1000
59242
+ The maximum number of characters for each keyword: 100
59243
+ the specified keywords will be converted to lowercase, data will be provided in a separate array */
59244
+ keywords?: string[];
59245
+ /** full name of search engine location
59246
+ required field if you don’t specify location_code or location_coordinate
59247
+ if you use this field, you don’t need to specify location_code or location_coordinate
59248
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
59249
+ example:
59250
+ London,England,United Kingdom */
59251
+ location_name?: string | undefined;
59252
+ /** search engine location code
59253
+ required field if you don’t specify location_name or location_coordinate
59254
+ if you use this field, you don’t need to specify location_name or location_coordinate
59255
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
59256
+ example:
59257
+ 2840 */
59258
+ location_code?: number | undefined;
59259
+ /** GPS coordinates of a location
59260
+ required field if you don’t specify location_name or location_code
59261
+ if you use this field, you don’t need to specify location_name or location_code
59262
+ location_coordinate parameter should be specified in the “latitude,longitude” format
59263
+ the data will be provided for the country the specified coordinates belong to
59264
+ example:
59265
+ 52.6178549,-155.352142 */
59266
+ location_coordinate?: string | undefined;
59267
+ /** full name of search engine language
59268
+ required field if you don’t specify language_code
59269
+ if you use this field, you don’t need to specify language_code
59270
+ you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
59271
+ language_name?: string | undefined;
59272
+ /** search engine language code
59273
+ required field if you don’t specify language_name
59274
+ if you use this field, you don’t need to specify language_name
59275
+ you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
59276
+ language_code?: string | undefined;
59277
+ /** device type
59278
+ optional field
59279
+ specify this field if you want to get the data for a particular device type
59280
+ possible values: mobile, desktop, tablet, non_smartphones
59281
+ default value: mobile, desktop, tablet, non_smartphones */
59282
+ device?: string | undefined;
59283
+ /** aggregates the returned data to a certain time period
59284
+ optional field
59285
+ specify this field if you want to get the data in monthly, weekly or daily format
59286
+ possible values: monthly, weekly, daily
59287
+ monthly – returns data up to past 24 months
59288
+ weekly – returns data up to past 15 weeks
59289
+ daily – returns data up to past 45 days
59290
+ default value: monthly */
59291
+ period?: string | undefined;
59292
+ /** starting date of the time range
59293
+ optional field
59294
+ minimum value: two years back from today’s date
59295
+ maximum value: one day from today’s date
59296
+ date format: "yyyy-mm-dd"
59297
+ example:
59298
+ "2020-01-01"
59299
+ Note: we do not recommend using a custom time range
59300
+ Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
59301
+ if you specify the period parameter:
59302
+ with value weekly, you will get results for the past 15 weeks
59303
+ with value daily, you will get results for the past 45 days */
59304
+ date_from?: string | undefined;
59305
+ /** ending date of the time range
59306
+ optional field
59307
+ minimum value: two years back from today’s date;
59308
+ maximum value: one day from today’s date;
59309
+ date format: "yyyy-mm-dd"
59310
+ example:
59311
+ "2020-03-15"
59312
+ Note: we do not recommend using a custom time range
59313
+ Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
59314
+ if you specify the period parameter:
59315
+ with value weekly, you will get results for the past 15 weeks
59316
+ with value daily, you will get results for the past 45 days */
59317
+ date_to?: string | undefined;
59318
+ /** user-defined task identifier
59319
+ optional field
59320
+ the character limit is 255
59321
+ you can use this parameter to identify the task and match it with the result
59322
+ you will find the specified tag value in the data object of the response */
59323
+ tag?: string | undefined;
59324
+ [key: string]: any;
59325
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryLiveRequestInfo);
59326
+ init(_data?: any): void;
59327
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLiveRequestInfo;
59328
+ toJSON(data?: any): any;
59329
+ }
59330
+ export interface IKeywordsDataBingSearchVolumeHistoryLiveRequestInfo {
59331
+ /** keywords
59332
+ required field
59333
+ The maximum number of keywords you can specify: 1000
59334
+ The maximum number of characters for each keyword: 100
59335
+ the specified keywords will be converted to lowercase, data will be provided in a separate array */
59336
+ keywords?: string[];
59337
+ /** full name of search engine location
59338
+ required field if you don’t specify location_code or location_coordinate
59339
+ if you use this field, you don’t need to specify location_code or location_coordinate
59340
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
59341
+ example:
59342
+ London,England,United Kingdom */
59343
+ location_name?: string | undefined;
59344
+ /** search engine location code
59345
+ required field if you don’t specify location_name or location_coordinate
59346
+ if you use this field, you don’t need to specify location_name or location_coordinate
59347
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
59348
+ example:
59349
+ 2840 */
59350
+ location_code?: number | undefined;
59351
+ /** GPS coordinates of a location
59352
+ required field if you don’t specify location_name or location_code
59353
+ if you use this field, you don’t need to specify location_name or location_code
59354
+ location_coordinate parameter should be specified in the “latitude,longitude” format
59355
+ the data will be provided for the country the specified coordinates belong to
59356
+ example:
59357
+ 52.6178549,-155.352142 */
59358
+ location_coordinate?: string | undefined;
59359
+ /** full name of search engine language
59360
+ required field if you don’t specify language_code
59361
+ if you use this field, you don’t need to specify language_code
59362
+ you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
59363
+ language_name?: string | undefined;
59364
+ /** search engine language code
59365
+ required field if you don’t specify language_name
59366
+ if you use this field, you don’t need to specify language_name
59367
+ you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
59368
+ language_code?: string | undefined;
59369
+ /** device type
59370
+ optional field
59371
+ specify this field if you want to get the data for a particular device type
59372
+ possible values: mobile, desktop, tablet, non_smartphones
59373
+ default value: mobile, desktop, tablet, non_smartphones */
59374
+ device?: string | undefined;
59375
+ /** aggregates the returned data to a certain time period
59376
+ optional field
59377
+ specify this field if you want to get the data in monthly, weekly or daily format
59378
+ possible values: monthly, weekly, daily
59379
+ monthly – returns data up to past 24 months
59380
+ weekly – returns data up to past 15 weeks
59381
+ daily – returns data up to past 45 days
59382
+ default value: monthly */
59383
+ period?: string | undefined;
59384
+ /** starting date of the time range
59385
+ optional field
59386
+ minimum value: two years back from today’s date
59387
+ maximum value: one day from today’s date
59388
+ date format: "yyyy-mm-dd"
59389
+ example:
59390
+ "2020-01-01"
59391
+ Note: we do not recommend using a custom time range
59392
+ Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
59393
+ if you specify the period parameter:
59394
+ with value weekly, you will get results for the past 15 weeks
59395
+ with value daily, you will get results for the past 45 days */
59396
+ date_from?: string | undefined;
59397
+ /** ending date of the time range
59398
+ optional field
59399
+ minimum value: two years back from today’s date;
59400
+ maximum value: one day from today’s date;
59401
+ date format: "yyyy-mm-dd"
59402
+ example:
59403
+ "2020-03-15"
59404
+ Note: we do not recommend using a custom time range
59405
+ Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
59406
+ if you specify the period parameter:
59407
+ with value weekly, you will get results for the past 15 weeks
59408
+ with value daily, you will get results for the past 45 days */
59409
+ date_to?: string | undefined;
59410
+ /** user-defined task identifier
59411
+ optional field
59412
+ the character limit is 255
59413
+ you can use this parameter to identify the task and match it with the result
59414
+ you will find the specified tag value in the data object of the response */
59415
+ tag?: string | undefined;
59416
+ [key: string]: any;
59417
+ }
59418
+ export declare class KeywordsDataBingSearchVolumeHistoryLiveResultInfo implements IKeywordsDataBingSearchVolumeHistoryLiveResultInfo {
59419
+ /** keyword in a POST array */
59420
+ keyword?: string | undefined;
59421
+ /** location code in a POST array
59422
+ if there is no data, then the value is null */
59423
+ location_code?: number | undefined;
59424
+ /** language code in a POST array
59425
+ if there is no data, then the value is null */
59426
+ language_code?: string | undefined;
59427
+ device?: (string | undefined)[] | undefined;
59428
+ /** time period
59429
+ indicates if returned data is aggregated to a certain time period
59430
+ default value monthly */
59431
+ period?: string | undefined;
59432
+ /** contains results distributed by device type
59433
+ if the device parameter is not specified, the data will be returned for all available device types */
59434
+ searches?: SearchVolumeHistorySearchInfo | undefined;
59435
+ [key: string]: any;
59436
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryLiveResultInfo);
59437
+ init(_data?: any): void;
59438
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLiveResultInfo;
59439
+ toJSON(data?: any): any;
59440
+ }
59441
+ export interface IKeywordsDataBingSearchVolumeHistoryLiveResultInfo {
59442
+ /** keyword in a POST array */
59443
+ keyword?: string | undefined;
59444
+ /** location code in a POST array
59445
+ if there is no data, then the value is null */
59446
+ location_code?: number | undefined;
59447
+ /** language code in a POST array
59448
+ if there is no data, then the value is null */
59449
+ language_code?: string | undefined;
59450
+ device?: (string | undefined)[] | undefined;
59451
+ /** time period
59452
+ indicates if returned data is aggregated to a certain time period
59453
+ default value monthly */
59454
+ period?: string | undefined;
59455
+ /** contains results distributed by device type
59456
+ if the device parameter is not specified, the data will be returned for all available device types */
59457
+ searches?: SearchVolumeHistorySearchInfo | undefined;
59458
+ [key: string]: any;
59459
+ }
59460
+ export declare class KeywordsDataBingSearchVolumeHistoryLiveTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataBingSearchVolumeHistoryLiveTaskInfo {
59461
+ /** array of results */
59462
+ result?: (KeywordsDataBingSearchVolumeHistoryLiveResultInfo | undefined)[] | undefined;
59463
+ [key: string]: any;
59464
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryLiveTaskInfo);
59465
+ init(_data?: any): void;
59466
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLiveTaskInfo;
59467
+ toJSON(data?: any): any;
59468
+ }
59469
+ export interface IKeywordsDataBingSearchVolumeHistoryLiveTaskInfo extends IBaseResponseTaskInfo {
59470
+ /** array of results */
59471
+ result?: (KeywordsDataBingSearchVolumeHistoryLiveResultInfo | undefined)[] | undefined;
59472
+ [key: string]: any;
59473
+ }
59474
+ export declare class KeywordsDataBingSearchVolumeHistoryLiveResponseInfo extends BaseResponseInfo implements IKeywordsDataBingSearchVolumeHistoryLiveResponseInfo {
59475
+ /** array of tasks */
59476
+ tasks?: (KeywordsDataBingSearchVolumeHistoryLiveTaskInfo | undefined)[] | undefined;
59477
+ [key: string]: any;
59478
+ constructor(data?: IKeywordsDataBingSearchVolumeHistoryLiveResponseInfo);
59479
+ init(_data?: any): void;
59480
+ static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLiveResponseInfo;
59481
+ toJSON(data?: any): any;
59482
+ }
59483
+ export interface IKeywordsDataBingSearchVolumeHistoryLiveResponseInfo extends IBaseResponseInfo {
59484
+ /** array of tasks */
59485
+ tasks?: (KeywordsDataBingSearchVolumeHistoryLiveTaskInfo | undefined)[] | undefined;
59486
+ [key: string]: any;
59487
+ }
58373
59488
  export declare class BacklinksIdListRequestInfo implements IBacklinksIdListRequestInfo {
58374
59489
  /** start time for filtering results
58375
59490
  required field
@@ -58891,6 +60006,12 @@ if set to true, the results will include data on indirect links pointing to a pa
58891
60006
  if set to false, indirect links will be ignored
58892
60007
  default value: true */
58893
60008
  include_indirect_links?: boolean | undefined;
60009
+ /** indicates if internal backlinks from subdomains to the target will be excluded from the results
60010
+ optional field
60011
+ if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
60012
+ if set to false, internal links will be included in the results
60013
+ default value: true */
60014
+ exclude_internal_backlinks?: boolean | undefined;
58894
60015
  /** maximum number of elements within internal arrays
58895
60016
  optional field
58896
60017
  you can use this field to limit the number of elements within the following arrays:
@@ -58948,6 +60069,12 @@ if set to true, the results will include data on indirect links pointing to a pa
58948
60069
  if set to false, indirect links will be ignored
58949
60070
  default value: true */
58950
60071
  include_indirect_links?: boolean | undefined;
60072
+ /** indicates if internal backlinks from subdomains to the target will be excluded from the results
60073
+ optional field
60074
+ if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
60075
+ if set to false, internal links will be included in the results
60076
+ default value: true */
60077
+ exclude_internal_backlinks?: boolean | undefined;
58951
60078
  /** maximum number of elements within internal arrays
58952
60079
  optional field
58953
60080
  you can use this field to limit the number of elements within the following arrays:
@@ -59714,6 +60841,12 @@ if set to true, the results will include data on indirect links pointing to a pa
59714
60841
  if set to false, indirect links will be ignored
59715
60842
  default value: true */
59716
60843
  include_indirect_links?: boolean | undefined;
60844
+ /** indicates if internal backlinks from subdomains to the target will be excluded from the results
60845
+ optional field
60846
+ if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
60847
+ if set to false, internal links will be included in the results
60848
+ default value: true */
60849
+ exclude_internal_backlinks?: boolean | undefined;
59717
60850
  /** user-defined task identifier
59718
60851
  optional field
59719
60852
  the character limit is 255
@@ -59836,6 +60969,12 @@ if set to true, the results will include data on indirect links pointing to a pa
59836
60969
  if set to false, indirect links will be ignored
59837
60970
  default value: true */
59838
60971
  include_indirect_links?: boolean | undefined;
60972
+ /** indicates if internal backlinks from subdomains to the target will be excluded from the results
60973
+ optional field
60974
+ if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
60975
+ if set to false, internal links will be included in the results
60976
+ default value: true */
60977
+ exclude_internal_backlinks?: boolean | undefined;
59839
60978
  /** user-defined task identifier
59840
60979
  optional field
59841
60980
  the character limit is 255
@@ -60781,99 +61920,111 @@ optional field
60781
61920
  if set to false, the subdomains will be ignored
60782
61921
  default value: true */
60783
61922
  include_subdomains?: boolean | undefined;
60784
- /** user-defined task identifier
60785
- optional field
60786
- the character limit is 255
60787
- you can use this parameter to identify the task and match it with the result
60788
- you will find the specified tag value in the data object of the response */
60789
- tag?: string | undefined;
60790
- [key: string]: any;
60791
- constructor(data?: IBacklinksDomainPagesLiveRequestInfo);
60792
- init(_data?: any): void;
60793
- static fromJS(data: any): BacklinksDomainPagesLiveRequestInfo;
60794
- toJSON(data?: any): any;
60795
- }
60796
- export interface IBacklinksDomainPagesLiveRequestInfo {
60797
- /** domain or subdomain
60798
- required field
60799
- a domain or a subdomain should be specified without https:// and www.
60800
- example:
60801
- forbes.com */
60802
- target?: string;
60803
- /** the maximum number of returned pages
60804
- optional field
60805
- default value: 100
60806
- maximum value: 1000 */
60807
- limit?: number | undefined;
60808
- /** offset in the results array of returned pages
60809
- optional field
60810
- default value: 0
60811
- if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
60812
- offset?: number | undefined;
60813
- /** maximum number of elements within internal arrays
60814
- optional field
60815
- you can use this field to limit the number of elements within the following arrays:
60816
- referring_links_tld
60817
- referring_links_types
60818
- referring_links_attributes
60819
- referring_links_platform_types
60820
- referring_links_semantic_locations
60821
- default value: 10
60822
- maximum value: 1000 */
60823
- internal_list_limit?: number | undefined;
60824
- /** set what backlinks to return and count
60825
- optional field
60826
- you can use this field to choose what backlinks will be returned and used for aggregated metrics;
60827
- possible values:
60828
- all all backlinks will be returned and counted;
60829
- live backlinks found during the last check will be returned and counted;
60830
- lost lost backlinks will be returned and counted;
60831
- default value: live */
60832
- backlinks_status_type?: string | undefined;
60833
- /** array of results filtering parameters
61923
+ /** indicates if internal backlinks from subdomains to the target will be excluded from the results
61924
+ optional field
61925
+ if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
61926
+ if set to false, internal links will be included in the results
61927
+ default value: true */
61928
+ exclude_internal_backlinks?: boolean | undefined;
61929
+ /** user-defined task identifier
61930
+ optional field
61931
+ the character limit is 255
61932
+ you can use this parameter to identify the task and match it with the result
61933
+ you will find the specified tag value in the data object of the response */
61934
+ tag?: string | undefined;
61935
+ [key: string]: any;
61936
+ constructor(data?: IBacklinksDomainPagesLiveRequestInfo);
61937
+ init(_data?: any): void;
61938
+ static fromJS(data: any): BacklinksDomainPagesLiveRequestInfo;
61939
+ toJSON(data?: any): any;
61940
+ }
61941
+ export interface IBacklinksDomainPagesLiveRequestInfo {
61942
+ /** domain or subdomain
61943
+ required field
61944
+ a domain or a subdomain should be specified without https:// and www.
61945
+ example:
61946
+ forbes.com */
61947
+ target?: string;
61948
+ /** the maximum number of returned pages
61949
+ optional field
61950
+ default value: 100
61951
+ maximum value: 1000 */
61952
+ limit?: number | undefined;
61953
+ /** offset in the results array of returned pages
61954
+ optional field
61955
+ default value: 0
61956
+ if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
61957
+ offset?: number | undefined;
61958
+ /** maximum number of elements within internal arrays
61959
+ optional field
61960
+ you can use this field to limit the number of elements within the following arrays:
61961
+ referring_links_tld
61962
+ referring_links_types
61963
+ referring_links_attributes
61964
+ referring_links_platform_types
61965
+ referring_links_semantic_locations
61966
+ default value: 10
61967
+ maximum value: 1000 */
61968
+ internal_list_limit?: number | undefined;
61969
+ /** set what backlinks to return and count
61970
+ optional field
61971
+ you can use this field to choose what backlinks will be returned and used for aggregated metrics;
61972
+ possible values:
61973
+ all – all backlinks will be returned and counted;
61974
+ live – backlinks found during the last check will be returned and counted;
61975
+ lost – lost backlinks will be returned and counted;
61976
+ default value: live */
61977
+ backlinks_status_type?: string | undefined;
61978
+ /** array of results filtering parameters
61979
+ optional field
61980
+ you can add several filters at once (8 filters maximum)
61981
+ you should set a logical operator and, or between the conditions
61982
+ the following operators are supported:
61983
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
61984
+ you can use the % operator with like and not_like to match any string of zero or more characters
61985
+ example:
61986
+ ["meta.internal_links_count",">","1"]
61987
+ [["meta.external_links_count",">","2"],
61988
+ "and",
61989
+ ["backlinks",">","10"]]
61990
+ [["first_visited",">","2017-10-23 11:31:45 +00:00"],
61991
+ "and",
61992
+ [["title","like","%seo%"],"or",["referring_domains",">","10"]]]
61993
+ The full list of possible filters is available here. */
61994
+ filters?: (any | undefined)[] | undefined;
61995
+ /** results sorting rules
61996
+ optional field
61997
+ you can use the same values as in the filters array to sort the results
61998
+ possible sorting types:
61999
+ asc – results will be sorted in the ascending order
62000
+ desc – results will be sorted in the descending order
62001
+ you should use a comma to set up a sorting type
62002
+ example:
62003
+ ["page_summary.backlinks,desc"]
62004
+ note that you can set no more than three sorting rules in a single request
62005
+ you should use a comma to separate several sorting rules
62006
+ example:
62007
+ ["page_summary.backlinks,desc","page_summary.rank,asc"] */
62008
+ order_by?: string[] | undefined;
62009
+ /** filter the backlinks of your target
62010
+ optional field
62011
+ you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
62012
+ you can filter the backlinks by all fields available in the response of this endpoint
62013
+ using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
62014
+ example:
62015
+ "backlinks_filters": ["dofollow", "=", true] */
62016
+ backlinks_filters?: (any | undefined)[] | undefined;
62017
+ /** indicates if the subdomains of the target will be included in the search
62018
+ optional field
62019
+ if set to false, the subdomains will be ignored
62020
+ default value: true */
62021
+ include_subdomains?: boolean | undefined;
62022
+ /** indicates if internal backlinks from subdomains to the target will be excluded from the results
60834
62023
  optional field
60835
- you can add several filters at once (8 filters maximum)
60836
- you should set a logical operator and, or between the conditions
60837
- the following operators are supported:
60838
- regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
60839
- you can use the % operator with like and not_like to match any string of zero or more characters
60840
- example:
60841
- ["meta.internal_links_count",">","1"]
60842
- [["meta.external_links_count",">","2"],
60843
- "and",
60844
- ["backlinks",">","10"]]
60845
- [["first_visited",">","2017-10-23 11:31:45 +00:00"],
60846
- "and",
60847
- [["title","like","%seo%"],"or",["referring_domains",">","10"]]]
60848
- The full list of possible filters is available here. */
60849
- filters?: (any | undefined)[] | undefined;
60850
- /** results sorting rules
60851
- optional field
60852
- you can use the same values as in the filters array to sort the results
60853
- possible sorting types:
60854
- asc – results will be sorted in the ascending order
60855
- desc – results will be sorted in the descending order
60856
- you should use a comma to set up a sorting type
60857
- example:
60858
- ["page_summary.backlinks,desc"]
60859
- note that you can set no more than three sorting rules in a single request
60860
- you should use a comma to separate several sorting rules
60861
- example:
60862
- ["page_summary.backlinks,desc","page_summary.rank,asc"] */
60863
- order_by?: string[] | undefined;
60864
- /** filter the backlinks of your target
60865
- optional field
60866
- you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
60867
- you can filter the backlinks by all fields available in the response of this endpoint
60868
- using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
60869
- example:
60870
- "backlinks_filters": ["dofollow", "=", true] */
60871
- backlinks_filters?: (any | undefined)[] | undefined;
60872
- /** indicates if the subdomains of the target will be included in the search
60873
- optional field
60874
- if set to false, the subdomains will be ignored
62024
+ if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
62025
+ if set to false, internal links will be included in the results
60875
62026
  default value: true */
60876
- include_subdomains?: boolean | undefined;
62027
+ exclude_internal_backlinks?: boolean | undefined;
60877
62028
  /** user-defined task identifier
60878
62029
  optional field
60879
62030
  the character limit is 255
@@ -62688,6 +63839,12 @@ optional field
62688
63839
  if set to true, the results from the large domain (google.com, amazon.com, etc.) will be omitted;
62689
63840
  default value: true */
62690
63841
  exclude_large_domains?: boolean | undefined;
63842
+ /** indicates if internal backlinks from subdomains to the target will be excluded from the results
63843
+ optional field
63844
+ if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
63845
+ if set to false, internal links will be included in the results
63846
+ default value: true */
63847
+ exclude_internal_backlinks?: boolean | undefined;
62691
63848
  /** user-defined task identifier
62692
63849
  optional field
62693
63850
  the character limit is 255
@@ -62754,6 +63911,12 @@ optional field
62754
63911
  if set to true, the results from the large domain (google.com, amazon.com, etc.) will be omitted;
62755
63912
  default value: true */
62756
63913
  exclude_large_domains?: boolean | undefined;
63914
+ /** indicates if internal backlinks from subdomains to the target will be excluded from the results
63915
+ optional field
63916
+ if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
63917
+ if set to false, internal links will be included in the results
63918
+ default value: true */
63919
+ exclude_internal_backlinks?: boolean | undefined;
62757
63920
  /** user-defined task identifier
62758
63921
  optional field
62759
63922
  the character limit is 255
@@ -63103,7 +64266,8 @@ export declare class BacklinksDomainIntersectionInfo implements IBacklinksDomain
63103
64266
  type?: string | undefined;
63104
64267
  /** domain that links to the corresponding target from the POST array */
63105
64268
  target?: string | undefined;
63106
- /** rank of the target
64269
+ /** rank referred to the target from the POST array
64270
+ indicates the rank that the referring domain (target above) refers to your target from the POST array;
63107
64271
  rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
63108
64272
  learn more about the metric and how it is calculated in this help center article */
63109
64273
  rank?: number | undefined;
@@ -63187,7 +64351,8 @@ export interface IBacklinksDomainIntersectionInfo {
63187
64351
  type?: string | undefined;
63188
64352
  /** domain that links to the corresponding target from the POST array */
63189
64353
  target?: string | undefined;
63190
- /** rank of the target
64354
+ /** rank referred to the target from the POST array
64355
+ indicates the rank that the referring domain (target above) refers to your target from the POST array;
63191
64356
  rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
63192
64357
  learn more about the metric and how it is calculated in this help center article */
63193
64358
  rank?: number | undefined;
@@ -63451,6 +64616,12 @@ if set to true, the results will include data on indirect links pointing to a pa
63451
64616
  if set to false, indirect links will be ignored
63452
64617
  default value: true */
63453
64618
  include_indirect_links?: boolean | undefined;
64619
+ /** indicates if internal backlinks from subdomains to the target will be excluded from the results
64620
+ optional field
64621
+ if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
64622
+ if set to false, internal links will be included in the result
64623
+ default value: true */
64624
+ exclude_internal_backlinks?: boolean | undefined;
63454
64625
  /** indicates whether to intersect backlinks
63455
64626
  optional field
63456
64627
  use this field to intersect or merge results for the specified URLs
@@ -63564,6 +64735,12 @@ if set to true, the results will include data on indirect links pointing to a pa
63564
64735
  if set to false, indirect links will be ignored
63565
64736
  default value: true */
63566
64737
  include_indirect_links?: boolean | undefined;
64738
+ /** indicates if internal backlinks from subdomains to the target will be excluded from the results
64739
+ optional field
64740
+ if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
64741
+ if set to false, internal links will be included in the result
64742
+ default value: true */
64743
+ exclude_internal_backlinks?: boolean | undefined;
63567
64744
  /** indicates whether to intersect backlinks
63568
64745
  optional field
63569
64746
  use this field to intersect or merge results for the specified URLs
@@ -63617,6 +64794,7 @@ page_from_rank is calculated based on the method for node ranking in a linked da
63617
64794
  learn more about the metric and how it is calculated in this help center article */
63618
64795
  page_from_rank?: number | undefined;
63619
64796
  /** domain rank of the referring domain
64797
+ indicates the rank of the domain at the time our crawler last saw the backlink;
63620
64798
  domain_from_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
63621
64799
  learn more about the metric and how it is calculated in this help center article */
63622
64800
  domain_from_rank?: number | undefined;
@@ -63766,6 +64944,7 @@ page_from_rank is calculated based on the method for node ranking in a linked da
63766
64944
  learn more about the metric and how it is calculated in this help center article */
63767
64945
  page_from_rank?: number | undefined;
63768
64946
  /** domain rank of the referring domain
64947
+ indicates the rank of the domain at the time our crawler last saw the backlink;
63769
64948
  domain_from_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
63770
64949
  learn more about the metric and how it is calculated in this help center article */
63771
64950
  domain_from_rank?: number | undefined;
@@ -64518,6 +65697,7 @@ export declare class BacklinksBulkRanksLiveItem implements IBacklinksBulkRanksLi
64518
65697
  /** domain, subdomain or webpage from a POST array */
64519
65698
  target?: string | undefined;
64520
65699
  /** rank of the target
65700
+ values represent real-time data for the date of the request
64521
65701
  rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
64522
65702
  learn more about the metric and how it is calculated in this help center article */
64523
65703
  rank?: number | undefined;
@@ -64531,6 +65711,7 @@ export interface IBacklinksBulkRanksLiveItem {
64531
65711
  /** domain, subdomain or webpage from a POST array */
64532
65712
  target?: string | undefined;
64533
65713
  /** rank of the target
65714
+ values represent real-time data for the date of the request
64534
65715
  rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
64535
65716
  learn more about the metric and how it is calculated in this help center article */
64536
65717
  rank?: number | undefined;
@@ -70744,7 +71925,7 @@ export interface ITableContent {
70744
71925
  footer?: (TableContentItemInfo | undefined)[] | undefined;
70745
71926
  [key: string]: any;
70746
71927
  }
70747
- export declare class MainTopic implements IMainTopic {
71928
+ export declare class TopicInfo implements ITopicInfo {
70748
71929
  /** meta title */
70749
71930
  h_title?: string | undefined;
70750
71931
  /** main title of the block */
@@ -70764,12 +71945,12 @@ you can find more information about content priority calculation in this help ce
70764
71945
  /** content of the table on the page */
70765
71946
  table_content?: (TableContent | undefined)[] | undefined;
70766
71947
  [key: string]: any;
70767
- constructor(data?: IMainTopic);
71948
+ constructor(data?: ITopicInfo);
70768
71949
  init(_data?: any): void;
70769
- static fromJS(data: any): MainTopic;
71950
+ static fromJS(data: any): TopicInfo;
70770
71951
  toJSON(data?: any): any;
70771
71952
  }
70772
- export interface IMainTopic {
71953
+ export interface ITopicInfo {
70773
71954
  /** meta title */
70774
71955
  h_title?: string | undefined;
70775
71956
  /** main title of the block */
@@ -70790,52 +71971,6 @@ you can find more information about content priority calculation in this help ce
70790
71971
  table_content?: (TableContent | undefined)[] | undefined;
70791
71972
  [key: string]: any;
70792
71973
  }
70793
- export declare class SecondaryTopic implements ISecondaryTopic {
70794
- /** meta title */
70795
- h_title?: string | undefined;
70796
- /** main title of the block */
70797
- main_title?: string | undefined;
70798
- /** content author name */
70799
- author?: string | undefined;
70800
- /** content language */
70801
- language?: string | undefined;
70802
- /** HTML level */
70803
- level?: number | undefined;
70804
- /** primary content on the page
70805
- you can find more information about content priority calculation in this help center article */
70806
- primary_content?: string | undefined;
70807
- /** secondary content on the page
70808
- you can find more information about content priority calculation in this help center article */
70809
- secondary_content?: (ContentItemInfo | undefined)[] | undefined;
70810
- /** content of the table on the page */
70811
- table_content?: (TableContent | undefined)[] | undefined;
70812
- [key: string]: any;
70813
- constructor(data?: ISecondaryTopic);
70814
- init(_data?: any): void;
70815
- static fromJS(data: any): SecondaryTopic;
70816
- toJSON(data?: any): any;
70817
- }
70818
- export interface ISecondaryTopic {
70819
- /** meta title */
70820
- h_title?: string | undefined;
70821
- /** main title of the block */
70822
- main_title?: string | undefined;
70823
- /** content author name */
70824
- author?: string | undefined;
70825
- /** content language */
70826
- language?: string | undefined;
70827
- /** HTML level */
70828
- level?: number | undefined;
70829
- /** primary content on the page
70830
- you can find more information about content priority calculation in this help center article */
70831
- primary_content?: string | undefined;
70832
- /** secondary content on the page
70833
- you can find more information about content priority calculation in this help center article */
70834
- secondary_content?: (ContentItemInfo | undefined)[] | undefined;
70835
- /** content of the table on the page */
70836
- table_content?: (TableContent | undefined)[] | undefined;
70837
- [key: string]: any;
70838
- }
70839
71974
  export declare class PageContentInfo implements IPageContentInfo {
70840
71975
  /** content of the header of the table */
70841
71976
  header?: PageSectionContentInfo | undefined;
@@ -70843,10 +71978,10 @@ export declare class PageContentInfo implements IPageContentInfo {
70843
71978
  footer?: PageSectionContentInfo | undefined;
70844
71979
  /** main topic on the page
70845
71980
  you can find more information about topic priority calculation in this help center article */
70846
- main_topic?: (MainTopic | undefined)[] | undefined;
71981
+ main_topic?: (TopicInfo | undefined)[] | undefined;
70847
71982
  /** secondary topic on the page
70848
71983
  you can find more information about topic priority calculation in this help center article */
70849
- secondary_topic?: (SecondaryTopic | undefined)[] | undefined;
71984
+ secondary_topic?: (TopicInfo | undefined)[] | undefined;
70850
71985
  [key: string]: any;
70851
71986
  constructor(data?: IPageContentInfo);
70852
71987
  init(_data?: any): void;
@@ -70860,10 +71995,10 @@ export interface IPageContentInfo {
70860
71995
  footer?: PageSectionContentInfo | undefined;
70861
71996
  /** main topic on the page
70862
71997
  you can find more information about topic priority calculation in this help center article */
70863
- main_topic?: (MainTopic | undefined)[] | undefined;
71998
+ main_topic?: (TopicInfo | undefined)[] | undefined;
70864
71999
  /** secondary topic on the page
70865
72000
  you can find more information about topic priority calculation in this help center article */
70866
- secondary_topic?: (SecondaryTopic | undefined)[] | undefined;
72001
+ secondary_topic?: (TopicInfo | undefined)[] | undefined;
70867
72002
  [key: string]: any;
70868
72003
  }
70869
72004
  export declare class OnPageContentParsingItem implements IOnPageContentParsingItem {
@@ -71196,28 +72331,6 @@ possible values: us, de */
71196
72331
  ip_pool_for_scan?: string | undefined;
71197
72332
  [key: string]: any;
71198
72333
  }
71199
- export declare class RowCells implements IRowCells {
71200
- /** content text */
71201
- text?: string | undefined;
71202
- /** contains other URLs and anchors found in the content element */
71203
- urls?: any | undefined;
71204
- /** indicates if the text belongs to the header */
71205
- is_header?: boolean | undefined;
71206
- [key: string]: any;
71207
- constructor(data?: IRowCells);
71208
- init(_data?: any): void;
71209
- static fromJS(data: any): RowCells;
71210
- toJSON(data?: any): any;
71211
- }
71212
- export interface IRowCells {
71213
- /** content text */
71214
- text?: string | undefined;
71215
- /** contains other URLs and anchors found in the content element */
71216
- urls?: any | undefined;
71217
- /** indicates if the text belongs to the header */
71218
- is_header?: boolean | undefined;
71219
- [key: string]: any;
71220
- }
71221
72334
  export declare class OnPageContentParsingLiveResultInfo implements IOnPageContentParsingLiveResultInfo {
71222
72335
  /** status of the crawling session
71223
72336
  possible values: in_progress, finished */
@@ -78755,7 +79868,7 @@ number of reviews on the product seller’s account */
78755
79868
  seller_review_count?: number | undefined;
78756
79869
  /** product price
78757
79870
  product price details on the seller’s website */
78758
- price?: PriceInfo | undefined;
79871
+ price?: Price | undefined;
78759
79872
  /** delivery information
78760
79873
  product delivery information */
78761
79874
  delivery_info?: DeliveryInfo | undefined;
@@ -78780,7 +79893,7 @@ number of reviews on the product seller’s account */
78780
79893
  seller_review_count?: number | undefined;
78781
79894
  /** product price
78782
79895
  product price details on the seller’s website */
78783
- price?: PriceInfo | undefined;
79896
+ price?: Price | undefined;
78784
79897
  /** delivery information
78785
79898
  product delivery information */
78786
79899
  delivery_info?: DeliveryInfo | undefined;
@@ -80929,7 +82042,7 @@ left, right */
80929
82042
  ships_from?: string | undefined;
80930
82043
  /** product pricing details
80931
82044
  if there are no details, the value will be null */
80932
- price?: PriceInfo | undefined;
82045
+ price?: Price | undefined;
80933
82046
  /** seller rating details
80934
82047
  seller popularity rate based on customer reviews */
80935
82048
  rating?: RatingElement | undefined;
@@ -80969,7 +82082,7 @@ left, right */
80969
82082
  ships_from?: string | undefined;
80970
82083
  /** product pricing details
80971
82084
  if there are no details, the value will be null */
80972
- price?: PriceInfo | undefined;
82085
+ price?: Price | undefined;
80973
82086
  /** seller rating details
80974
82087
  seller popularity rate based on customer reviews */
80975
82088
  rating?: RatingElement | undefined;
@@ -81005,7 +82118,7 @@ left, right */
81005
82118
  ships_from?: string | undefined;
81006
82119
  /** product pricing details
81007
82120
  if there are no details, the value will be null */
81008
- price?: PriceInfo | undefined;
82121
+ price?: Price | undefined;
81009
82122
  /** seller rating details
81010
82123
  seller popularity rate based on customer reviews */
81011
82124
  rating?: RatingElement | undefined;
@@ -81045,7 +82158,7 @@ left, right */
81045
82158
  ships_from?: string | undefined;
81046
82159
  /** product pricing details
81047
82160
  if there are no details, the value will be null */
81048
- price?: PriceInfo | undefined;
82161
+ price?: Price | undefined;
81049
82162
  /** seller rating details
81050
82163
  seller popularity rate based on customer reviews */
81051
82164
  rating?: RatingElement | undefined;
@@ -83623,7 +84736,7 @@ can take the following values: left */
83623
84736
  /** average rating of the app */
83624
84737
  rating?: RatingInfo | undefined;
83625
84738
  /** price of the app */
83626
- price?: PriceInfo | undefined;
84739
+ price?: Price | undefined;
83627
84740
  /** indicates whether the app is free */
83628
84741
  is_free?: boolean | undefined;
83629
84742
  /** main category of the app */
@@ -83714,7 +84827,7 @@ can take the following values: left */
83714
84827
  /** average rating of the app */
83715
84828
  rating?: RatingInfo | undefined;
83716
84829
  /** price of the app */
83717
- price?: PriceInfo | undefined;
84830
+ price?: Price | undefined;
83718
84831
  /** indicates whether the app is free */
83719
84832
  is_free?: boolean | undefined;
83720
84833
  /** main category of the app */
@@ -85659,7 +86772,7 @@ can take the following values: left */
85659
86772
  /** average rating of the app */
85660
86773
  rating?: RatingInfo | undefined;
85661
86774
  /** price of the app */
85662
- price?: PriceInfo | undefined;
86775
+ price?: Price | undefined;
85663
86776
  /** indicates whether the app is free */
85664
86777
  is_free?: boolean | undefined;
85665
86778
  /** main category/genre of the app */
@@ -85735,7 +86848,7 @@ can take the following values: left */
85735
86848
  /** average rating of the app */
85736
86849
  rating?: RatingInfo | undefined;
85737
86850
  /** price of the app */
85738
- price?: PriceInfo | undefined;
86851
+ price?: Price | undefined;
85739
86852
  /** indicates whether the app is free */
85740
86853
  is_free?: boolean | undefined;
85741
86854
  /** main category/genre of the app */
@@ -87484,6 +88597,7 @@ optional field */
87484
88597
  optional field
87485
88598
  location_coordinate parameter should be specified in the “latitude,longitude,radius” format
87486
88599
  the maximum number of decimal digits for “latitude” and “longitude”: 7
88600
+ the value of “radius” is specified in kilometres (km)
87487
88601
  the minimum value for “radius”: 1
87488
88602
  the maximum value for “radius”: 100000
87489
88603
  example:
@@ -87567,6 +88681,7 @@ optional field */
87567
88681
  optional field
87568
88682
  location_coordinate parameter should be specified in the “latitude,longitude,radius” format
87569
88683
  the maximum number of decimal digits for “latitude” and “longitude”: 7
88684
+ the value of “radius” is specified in kilometres (km)
87570
88685
  the minimum value for “radius”: 1
87571
88686
  the maximum value for “radius”: 100000
87572
88687
  example:
@@ -88955,7 +90070,7 @@ example:
88955
90070
  "birthday": 33
88956
90071
  } */
88957
90072
  place_topics?: {
88958
- [key: string]: string;
90073
+ [key: string]: number;
88959
90074
  } | undefined;
88960
90075
  /** the element’s rating
88961
90076
  the popularity rate based on reviews and displayed in SERP */
@@ -89075,7 +90190,7 @@ example:
89075
90190
  "birthday": 33
89076
90191
  } */
89077
90192
  place_topics?: {
89078
- [key: string]: string;
90193
+ [key: string]: number;
89079
90194
  } | undefined;
89080
90195
  /** the element’s rating
89081
90196
  the popularity rate based on reviews and displayed in SERP */
@@ -89212,6 +90327,108 @@ export interface IBusinessDataGoogleMyBusinessInfoTaskGetResponseInfo extends IB
89212
90327
  tasks?: (BusinessDataGoogleMyBusinessInfoTaskGetTaskInfo | undefined)[] | undefined;
89213
90328
  [key: string]: any;
89214
90329
  }
90330
+ export declare class BusinessDataGoogleMyBusinessInfoLiveResultInfo implements IBusinessDataGoogleMyBusinessInfoLiveResultInfo {
90331
+ /** keyword received in a POST array
90332
+ keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
90333
+ this field will contain the cid parameter if you specified it in the keyword field when setting a task;
90334
+ example:
90335
+ cid:2946633002421908862
90336
+ learn more about the parameter in this help center article */
90337
+ keyword?: string | undefined;
90338
+ /** search engine domain as specified in a POST array */
90339
+ se_domain?: string | undefined;
90340
+ /** location code in a POST array */
90341
+ location_code?: number | undefined;
90342
+ /** language code in a POST array */
90343
+ language_code?: string | undefined;
90344
+ /** direct URL to search engine results
90345
+ you can use it to make sure that we provided accurate results */
90346
+ check_url?: string | undefined;
90347
+ /** date and time when the result was received
90348
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
90349
+ example:
90350
+ 2019-11-15 12:57:46 +00:00 */
90351
+ datetime?: string | undefined;
90352
+ /** item types
90353
+ types of search engine results encountered in the items array;
90354
+ possible item types: google_business_info */
90355
+ item_types?: (string | undefined)[] | undefined;
90356
+ /** item types
90357
+ the number of items in the items array */
90358
+ items_count?: number | undefined;
90359
+ /** encountered item types
90360
+ types of search engine results encountered in the items array;
90361
+ possible item types: google_business_info */
90362
+ items?: (BaseBusinessDataSerpElementItem | undefined)[] | undefined;
90363
+ [key: string]: any;
90364
+ constructor(data?: IBusinessDataGoogleMyBusinessInfoLiveResultInfo);
90365
+ init(_data?: any): void;
90366
+ static fromJS(data: any): BusinessDataGoogleMyBusinessInfoLiveResultInfo;
90367
+ toJSON(data?: any): any;
90368
+ }
90369
+ export interface IBusinessDataGoogleMyBusinessInfoLiveResultInfo {
90370
+ /** keyword received in a POST array
90371
+ keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
90372
+ this field will contain the cid parameter if you specified it in the keyword field when setting a task;
90373
+ example:
90374
+ cid:2946633002421908862
90375
+ learn more about the parameter in this help center article */
90376
+ keyword?: string | undefined;
90377
+ /** search engine domain as specified in a POST array */
90378
+ se_domain?: string | undefined;
90379
+ /** location code in a POST array */
90380
+ location_code?: number | undefined;
90381
+ /** language code in a POST array */
90382
+ language_code?: string | undefined;
90383
+ /** direct URL to search engine results
90384
+ you can use it to make sure that we provided accurate results */
90385
+ check_url?: string | undefined;
90386
+ /** date and time when the result was received
90387
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
90388
+ example:
90389
+ 2019-11-15 12:57:46 +00:00 */
90390
+ datetime?: string | undefined;
90391
+ /** item types
90392
+ types of search engine results encountered in the items array;
90393
+ possible item types: google_business_info */
90394
+ item_types?: (string | undefined)[] | undefined;
90395
+ /** item types
90396
+ the number of items in the items array */
90397
+ items_count?: number | undefined;
90398
+ /** encountered item types
90399
+ types of search engine results encountered in the items array;
90400
+ possible item types: google_business_info */
90401
+ items?: (BaseBusinessDataSerpElementItem | undefined)[] | undefined;
90402
+ [key: string]: any;
90403
+ }
90404
+ export declare class BusinessDataGoogleMyBusinessInfoLiveTaskInfo extends BaseResponseTaskInfo implements IBusinessDataGoogleMyBusinessInfoLiveTaskInfo {
90405
+ /** array of results */
90406
+ result?: (BusinessDataGoogleMyBusinessInfoLiveResultInfo | undefined)[] | undefined;
90407
+ [key: string]: any;
90408
+ constructor(data?: IBusinessDataGoogleMyBusinessInfoLiveTaskInfo);
90409
+ init(_data?: any): void;
90410
+ static fromJS(data: any): BusinessDataGoogleMyBusinessInfoLiveTaskInfo;
90411
+ toJSON(data?: any): any;
90412
+ }
90413
+ export interface IBusinessDataGoogleMyBusinessInfoLiveTaskInfo extends IBaseResponseTaskInfo {
90414
+ /** array of results */
90415
+ result?: (BusinessDataGoogleMyBusinessInfoLiveResultInfo | undefined)[] | undefined;
90416
+ [key: string]: any;
90417
+ }
90418
+ export declare class BusinessDataGoogleMyBusinessInfoLiveResponseInfo extends BaseResponseInfo implements IBusinessDataGoogleMyBusinessInfoLiveResponseInfo {
90419
+ /** array of tasks */
90420
+ tasks?: (BusinessDataGoogleMyBusinessInfoLiveTaskInfo | undefined)[] | undefined;
90421
+ [key: string]: any;
90422
+ constructor(data?: IBusinessDataGoogleMyBusinessInfoLiveResponseInfo);
90423
+ init(_data?: any): void;
90424
+ static fromJS(data: any): BusinessDataGoogleMyBusinessInfoLiveResponseInfo;
90425
+ toJSON(data?: any): any;
90426
+ }
90427
+ export interface IBusinessDataGoogleMyBusinessInfoLiveResponseInfo extends IBaseResponseInfo {
90428
+ /** array of tasks */
90429
+ tasks?: (BusinessDataGoogleMyBusinessInfoLiveTaskInfo | undefined)[] | undefined;
90430
+ [key: string]: any;
90431
+ }
89215
90432
  export declare class BusinessDataGoogleMyBusinessUpdatesTaskPostRequestInfo extends BusinessDataTaskRequestInfo implements IBusinessDataGoogleMyBusinessUpdatesTaskPostRequestInfo {
89216
90433
  /** parsing depth
89217
90434
  optional field
@@ -94526,8 +95743,7 @@ export declare class BusinessDataTripadvisorReviewsTaskPostRequestInfo implement
94526
95743
  /** URL path of the business entity
94527
95744
  required field if you do not specify keyword
94528
95745
  URL path to the Tripadvisor page of the business entity;
94529
- can be found in the URL of the business entity on Tripadvisor
94530
- example:
95746
+ examples:
94531
95747
  Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html
94532
95748
  https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html */
94533
95749
  url_path?: string | undefined;
@@ -94609,6 +95825,12 @@ possible types of sorting:
94609
95825
  most_recent
94610
95826
  detailed_reviews */
94611
95827
  sort_by?: string | undefined;
95828
+ /** translate reviews according to the URL path
95829
+ optional field
95830
+ if set to true, returned reviews will be translated to the language matching the specified url_path;
95831
+ for example, if url_path contains tripadvisor.it and translate_reviews is true, reviews will be translated to the Italian language;
95832
+ default value: true */
95833
+ translate_reviews?: boolean | undefined;
94612
95834
  /** user-defined task identifier
94613
95835
  optional field
94614
95836
  the character limit is 255
@@ -94645,8 +95867,7 @@ export interface IBusinessDataTripadvisorReviewsTaskPostRequestInfo {
94645
95867
  /** URL path of the business entity
94646
95868
  required field if you do not specify keyword
94647
95869
  URL path to the Tripadvisor page of the business entity;
94648
- can be found in the URL of the business entity on Tripadvisor
94649
- example:
95870
+ examples:
94650
95871
  Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html
94651
95872
  https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html */
94652
95873
  url_path?: string | undefined;
@@ -94728,6 +95949,12 @@ possible types of sorting:
94728
95949
  most_recent
94729
95950
  detailed_reviews */
94730
95951
  sort_by?: string | undefined;
95952
+ /** translate reviews according to the URL path
95953
+ optional field
95954
+ if set to true, returned reviews will be translated to the language matching the specified url_path;
95955
+ for example, if url_path contains tripadvisor.it and translate_reviews is true, reviews will be translated to the Italian language;
95956
+ default value: true */
95957
+ translate_reviews?: boolean | undefined;
94731
95958
  /** user-defined task identifier
94732
95959
  optional field
94733
95960
  the character limit is 255
@@ -96760,8 +97987,8 @@ export interface IAppendixMerchantPriceData {
96760
97987
  }
96761
97988
  export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceDataInfo {
96762
97989
  regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
96763
- html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
96764
97990
  advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
97991
+ html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
96765
97992
  [key: string]: any;
96766
97993
  constructor(data?: IAppendixSerpPriceDataInfo);
96767
97994
  init(_data?: any): void;
@@ -96770,8 +97997,8 @@ export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceData
96770
97997
  }
96771
97998
  export interface IAppendixSerpPriceDataInfo {
96772
97999
  regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
96773
- html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
96774
98000
  advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
98001
+ html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
96775
98002
  [key: string]: any;
96776
98003
  }
96777
98004
  export declare class AppendixSerpPriceData implements IAppendixSerpPriceData {
@@ -97011,8 +98238,8 @@ export declare class AppendixBusinessDataPriceData implements IAppendixBusinessD
97011
98238
  google?: AppendixGoogleBusinessDataPriceData | undefined;
97012
98239
  languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
97013
98240
  locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
97014
- tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
97015
98241
  trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
98242
+ tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
97016
98243
  yelp?: AppendixTrBusinessDataPriceDataInfo | undefined;
97017
98244
  tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
97018
98245
  [key: string]: any;
@@ -97028,8 +98255,8 @@ export interface IAppendixBusinessDataPriceData {
97028
98255
  google?: AppendixGoogleBusinessDataPriceData | undefined;
97029
98256
  languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
97030
98257
  locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
97031
- tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
97032
98258
  trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
98259
+ tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
97033
98260
  yelp?: AppendixTrBusinessDataPriceDataInfo | undefined;
97034
98261
  tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
97035
98262
  [key: string]: any;