dataforseo-client 1.0.13 → 1.0.15

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 +2164 -729
  2. package/main.js +1732 -312
  3. package/main.js.map +1 -1
  4. package/main.ts +3472 -625
  5. package/package.json +1 -1
package/main.d.ts CHANGED
@@ -93,13 +93,13 @@ export declare class SerpApi {
93
93
  * @param body (optional)
94
94
  * @return Successful operation
95
95
  */
96
- googleOrganicLiveRegular(body: (SerpTaskRequestInfo | undefined)[] | undefined): Promise<SerpGoogleOrganicLiveRegularResponseInfo | null>;
96
+ googleOrganicLiveRegular(body: (SerpGoogleOrganicLiveRegularRequestInfo | undefined)[] | undefined): Promise<SerpGoogleOrganicLiveRegularResponseInfo | null>;
97
97
  protected processGoogleOrganicLiveRegular(response: Response): Promise<SerpGoogleOrganicLiveRegularResponseInfo | null>;
98
98
  /**
99
99
  * @param body (optional)
100
100
  * @return Successful operation
101
101
  */
102
- googleOrganicLiveAdvanced(body: (SerpTaskRequestInfo | undefined)[] | undefined): Promise<SerpGoogleOrganicLiveAdvancedResponseInfo | null>;
102
+ googleOrganicLiveAdvanced(body: (SerpGoogleOrganicLiveAdvancedRequestInfo | undefined)[] | undefined): Promise<SerpGoogleOrganicLiveAdvancedResponseInfo | null>;
103
103
  protected processGoogleOrganicLiveAdvanced(response: Response): Promise<SerpGoogleOrganicLiveAdvancedResponseInfo | null>;
104
104
  /**
105
105
  * @param body (optional)
@@ -2876,6 +2876,31 @@ export declare class BusinessDataApi {
2876
2876
  */
2877
2877
  googleReviewsTaskGet(id: string): Promise<BusinessDataGoogleReviewsTaskGetResponseInfo | null>;
2878
2878
  protected processGoogleReviewsTaskGet(response: Response): Promise<BusinessDataGoogleReviewsTaskGetResponseInfo | null>;
2879
+ /**
2880
+ * @param body (optional)
2881
+ * @return Successful operation
2882
+ */
2883
+ googleQuestionsAndAnswersTaskPost(body: (BusinessDataGoogleQuestionsAndAnswersTaskPostRequestInfo | undefined)[] | undefined): Promise<BusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo | null>;
2884
+ protected processGoogleQuestionsAndAnswersTaskPost(response: Response): Promise<BusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo | null>;
2885
+ /**
2886
+ * @return Successful operation
2887
+ */
2888
+ googleQuestionsAndAnswersTasksReady(): Promise<BusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo | null>;
2889
+ protected processGoogleQuestionsAndAnswersTasksReady(response: Response): Promise<BusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo | null>;
2890
+ /**
2891
+ * @param id task identifier
2892
+ unique task identifier in our system in the UUID format
2893
+ you will be able to use it within 30 days to request the results of the task at any time
2894
+ * @return Successful operation
2895
+ */
2896
+ googleQuestionsAndAnswersTaskGet(id: string): Promise<BusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo | null>;
2897
+ protected processGoogleQuestionsAndAnswersTaskGet(response: Response): Promise<BusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo | null>;
2898
+ /**
2899
+ * @param body (optional)
2900
+ * @return Successful operation
2901
+ */
2902
+ googleQuestionsAndAnswersLive(body: (BusinessDataGoogleQuestionsAndAnswersLiveRequestInfo | undefined)[] | undefined): Promise<BusinessDataGoogleQuestionsAndAnswersLiveResponseInfo | null>;
2903
+ protected processGoogleQuestionsAndAnswersLive(response: Response): Promise<BusinessDataGoogleQuestionsAndAnswersLiveResponseInfo | null>;
2879
2904
  /**
2880
2905
  * @param body (optional)
2881
2906
  * @return Successful operation
@@ -3111,6 +3136,32 @@ export declare class BaseMerchantSerpElementItem implements IBaseMerchantSerpEle
3111
3136
  export interface IBaseMerchantSerpElementItem {
3112
3137
  [key: string]: any;
3113
3138
  }
3139
+ export declare class DemographyComparisonInfo implements IDemographyComparisonInfo {
3140
+ /** type of element */
3141
+ age?: {
3142
+ [key: string]: (number | undefined)[];
3143
+ } | undefined;
3144
+ /** type of element */
3145
+ gender?: {
3146
+ [key: string]: (number | undefined)[];
3147
+ } | undefined;
3148
+ [key: string]: any;
3149
+ constructor(data?: IDemographyComparisonInfo);
3150
+ init(_data?: any): void;
3151
+ static fromJS(data: any): DemographyComparisonInfo;
3152
+ toJSON(data?: any): any;
3153
+ }
3154
+ export interface IDemographyComparisonInfo {
3155
+ /** type of element */
3156
+ age?: {
3157
+ [key: string]: (number | undefined)[];
3158
+ } | undefined;
3159
+ /** type of element */
3160
+ gender?: {
3161
+ [key: string]: (number | undefined)[];
3162
+ } | undefined;
3163
+ [key: string]: any;
3164
+ }
3114
3165
  export declare class RatingElement implements IRatingElement {
3115
3166
  /** type of element */
3116
3167
  type?: string | undefined;
@@ -10669,50 +10720,282 @@ export interface ISerpGoogleOrganicTaskGetHtmlResponseInfo extends IBaseResponse
10669
10720
  tasks?: (SerpGoogleOrganicTaskGetHtmlTaskInfo | undefined)[] | undefined;
10670
10721
  [key: string]: any;
10671
10722
  }
10672
- export declare class SerpGoogleOrganicLiveRegularResultInfo implements ISerpGoogleOrganicLiveRegularResultInfo {
10673
- /** keyword received in a POST array
10674
- keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character) */
10675
- keyword?: string | undefined;
10676
- /** type of element */
10677
- type?: string | undefined;
10678
- /** search engine domain in a POST array */
10679
- se_domain?: string | undefined;
10680
- /** location code in a POST array */
10723
+ export declare class SerpGoogleOrganicLiveRegularRequestInfo implements ISerpGoogleOrganicLiveRegularRequestInfo {
10724
+ /** direct URL of the search query
10725
+ optional field
10726
+ you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
10727
+ example:
10728
+ https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS */
10729
+ url?: string | undefined;
10730
+ /** keyword
10731
+ required field
10732
+ you can specify up to 700 symbols in the keyword field
10733
+ all %## will be decoded (plus symbol ‘+’ will be decoded to a space character)
10734
+ if you need to use the “%” symbol for your keyword, please specify it as “%25”;
10735
+ if you need to use the “+” symbol for your keyword, please specify it as “%2B”;
10736
+ if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5
10737
+ Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error */
10738
+ keyword?: string;
10739
+ /** full name of search engine location
10740
+ required field if you don’t specify location_code or location_coordinate
10741
+ if you use this field, you don’t need to specify location_code or location_coordinate
10742
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations
10743
+ example:
10744
+ London,England,United Kingdom */
10745
+ location_name?: string | undefined;
10746
+ /** search engine location code
10747
+ required field if you don’t specify location_name or location_coordinate
10748
+ if you use this field, you don’t need to specify location_name or location_coordinate
10749
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations
10750
+ example:
10751
+ 2840 */
10681
10752
  location_code?: number | undefined;
10682
- /** language code in a POST array */
10753
+ /** GPS coordinates of a location
10754
+ required field if you don’t specify location_name or location_code
10755
+ if you use this field, you don’t need to specify location_name or location_code
10756
+ location_coordinate parameter should be specified in the “latitude,longitude,radius” format
10757
+ the maximum number of decimal digits for “latitude” and “longitude”: 7
10758
+ the minimum value for “radius”: 199.9 (mm)
10759
+ the maximum value for “radius”: 199999 (mm)
10760
+ example:
10761
+ 53.476225,-2.243572,200 */
10762
+ location_coordinate?: string | undefined;
10763
+ /** full name of search engine language
10764
+ required field if you don’t specify language_code
10765
+ if you use this field, you don’t need to specify language_code
10766
+ you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
10767
+ example:
10768
+ English */
10769
+ language_name?: string | undefined;
10770
+ /** search engine language code
10771
+ required field if you don’t specify language_name
10772
+ if you use this field, you don’t need to specify language_name
10773
+ you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
10774
+ example:
10775
+ en */
10683
10776
  language_code?: string | undefined;
10684
- /** direct URL to search engine results
10685
- you can use it to make sure that we provided exact results */
10686
- check_url?: string | undefined;
10687
- /** date and time when the result was received
10688
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
10777
+ /** device type
10778
+ optional field
10779
+ can take the values:desktop, mobile
10780
+ default value: desktop */
10781
+ device?: string | undefined;
10782
+ /** device operating system
10783
+ optional field
10784
+ if you specify desktop in the device field, choose from the following values: windows, macos
10785
+ default value: windows
10786
+ if you specify mobile in the device field, choose from the following values: android, ios
10787
+ default value: android */
10788
+ os?: string | undefined;
10789
+ /** search engine domain
10790
+ optional field
10791
+ we choose the relevant search engine domain automatically according to the location and language you specify
10792
+ however, you can set a custom search engine domain in this field
10689
10793
  example:
10690
- 2019-11-15 12:57:46 +00:00 */
10691
- datetime?: string | undefined;
10692
- /** autocorrection of the search engine
10693
- 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 */
10694
- spell?: SpellInfo | undefined;
10695
- /** types of search results found in SERP
10696
- contains types of all search results (items) found in the returned SERP
10697
- possible item types:
10698
- answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, images, jobs, knowledge_graph, local_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel
10699
- note that this array contains all types of search results found in the returned SERP;
10700
- however, this endpoint provides data for featured_snippet, organic and paid types only
10701
- to get all items (inlcuding SERP features and rich snippets) found in the returned SERP, please refer to the Google Organiс Advanced SERP endpoint */
10702
- item_types?: (string | undefined)[] | undefined;
10703
- /** total number of results in SERP */
10704
- se_results_count?: number | undefined;
10705
- /** the number of results returned in the items array */
10706
- items_count?: number | undefined;
10707
- /** items in SERP */
10708
- items?: (BaseSerpElementItem | undefined)[] | undefined;
10794
+ google.co.uk, google.com.au, google.de, etc. */
10795
+ se_domain?: string | undefined;
10796
+ /** parsing depth
10797
+ optional field
10798
+ number of results in SERP
10799
+ default value: 100
10800
+ max value: 700
10801
+ Note: your account will be billed per each SERP containing up to 100 results;
10802
+ thus, setting a depth above 100 may result in additional charges if the search engine returns more than 100 results;
10803
+ if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
10804
+ depth?: number | undefined;
10805
+ /** target domain, subdomain, or webpage to get results for
10806
+ optional field
10807
+ a domain or a subdomain should be specified without https:// and www.
10808
+ note that the results of target-specific tasks will only include SERP elements that contain a url string;
10809
+ you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;
10810
+ examples:
10811
+ example.com – return results for the website’s home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;
10812
+ example.com* – returns results for the domain, including all its pages;
10813
+ *example.com* – returns results for the entire domain, including all its pages and subdomains;
10814
+ *example.com – returns results for the home page regardless of the subdomain, such as https://en.example.com;
10815
+ example.com/example-page – returns results for the exact URL;
10816
+ example.com/example-page* – returns results for all domain’s URLs that start with the specified string */
10817
+ target?: string | undefined;
10818
+ /** page crawl limit
10819
+ optional field
10820
+ number of search results pages to crawl
10821
+ max value: 100
10822
+ Note: the max_crawl_pages and depth parameters complement each other;
10823
+ learn more at our help center */
10824
+ max_crawl_pages?: number | undefined;
10825
+ /** additional parameters of the search query
10826
+ optional field
10827
+ get the list of available parameters and additional details here */
10828
+ search_param?: string | undefined;
10829
+ /** user-defined task identifier
10830
+ optional field
10831
+ the character limit is 255
10832
+ you can use this parameter to identify the task and match it with the result
10833
+ you will find the specified tag value in the data object of the response */
10834
+ tag?: string | undefined;
10709
10835
  [key: string]: any;
10710
- constructor(data?: ISerpGoogleOrganicLiveRegularResultInfo);
10836
+ constructor(data?: ISerpGoogleOrganicLiveRegularRequestInfo);
10711
10837
  init(_data?: any): void;
10712
- static fromJS(data: any): SerpGoogleOrganicLiveRegularResultInfo;
10838
+ static fromJS(data: any): SerpGoogleOrganicLiveRegularRequestInfo;
10713
10839
  toJSON(data?: any): any;
10714
10840
  }
10715
- export interface ISerpGoogleOrganicLiveRegularResultInfo {
10841
+ export interface ISerpGoogleOrganicLiveRegularRequestInfo {
10842
+ /** direct URL of the search query
10843
+ optional field
10844
+ you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
10845
+ example:
10846
+ https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS */
10847
+ url?: string | undefined;
10848
+ /** keyword
10849
+ required field
10850
+ you can specify up to 700 symbols in the keyword field
10851
+ all %## will be decoded (plus symbol ‘+’ will be decoded to a space character)
10852
+ if you need to use the “%” symbol for your keyword, please specify it as “%25”;
10853
+ if you need to use the “+” symbol for your keyword, please specify it as “%2B”;
10854
+ if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5
10855
+ Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error */
10856
+ keyword?: string;
10857
+ /** full name of search engine location
10858
+ required field if you don’t specify location_code or location_coordinate
10859
+ if you use this field, you don’t need to specify location_code or location_coordinate
10860
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations
10861
+ example:
10862
+ London,England,United Kingdom */
10863
+ location_name?: string | undefined;
10864
+ /** search engine location code
10865
+ required field if you don’t specify location_name or location_coordinate
10866
+ if you use this field, you don’t need to specify location_name or location_coordinate
10867
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations
10868
+ example:
10869
+ 2840 */
10870
+ location_code?: number | undefined;
10871
+ /** GPS coordinates of a location
10872
+ required field if you don’t specify location_name or location_code
10873
+ if you use this field, you don’t need to specify location_name or location_code
10874
+ location_coordinate parameter should be specified in the “latitude,longitude,radius” format
10875
+ the maximum number of decimal digits for “latitude” and “longitude”: 7
10876
+ the minimum value for “radius”: 199.9 (mm)
10877
+ the maximum value for “radius”: 199999 (mm)
10878
+ example:
10879
+ 53.476225,-2.243572,200 */
10880
+ location_coordinate?: string | undefined;
10881
+ /** full name of search engine language
10882
+ required field if you don’t specify language_code
10883
+ if you use this field, you don’t need to specify language_code
10884
+ you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
10885
+ example:
10886
+ English */
10887
+ language_name?: string | undefined;
10888
+ /** search engine language code
10889
+ required field if you don’t specify language_name
10890
+ if you use this field, you don’t need to specify language_name
10891
+ you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
10892
+ example:
10893
+ en */
10894
+ language_code?: string | undefined;
10895
+ /** device type
10896
+ optional field
10897
+ can take the values:desktop, mobile
10898
+ default value: desktop */
10899
+ device?: string | undefined;
10900
+ /** device operating system
10901
+ optional field
10902
+ if you specify desktop in the device field, choose from the following values: windows, macos
10903
+ default value: windows
10904
+ if you specify mobile in the device field, choose from the following values: android, ios
10905
+ default value: android */
10906
+ os?: string | undefined;
10907
+ /** search engine domain
10908
+ optional field
10909
+ we choose the relevant search engine domain automatically according to the location and language you specify
10910
+ however, you can set a custom search engine domain in this field
10911
+ example:
10912
+ google.co.uk, google.com.au, google.de, etc. */
10913
+ se_domain?: string | undefined;
10914
+ /** parsing depth
10915
+ optional field
10916
+ number of results in SERP
10917
+ default value: 100
10918
+ max value: 700
10919
+ Note: your account will be billed per each SERP containing up to 100 results;
10920
+ thus, setting a depth above 100 may result in additional charges if the search engine returns more than 100 results;
10921
+ if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
10922
+ depth?: number | undefined;
10923
+ /** target domain, subdomain, or webpage to get results for
10924
+ optional field
10925
+ a domain or a subdomain should be specified without https:// and www.
10926
+ note that the results of target-specific tasks will only include SERP elements that contain a url string;
10927
+ you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;
10928
+ examples:
10929
+ example.com – return results for the website’s home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;
10930
+ example.com* – returns results for the domain, including all its pages;
10931
+ *example.com* – returns results for the entire domain, including all its pages and subdomains;
10932
+ *example.com – returns results for the home page regardless of the subdomain, such as https://en.example.com;
10933
+ example.com/example-page – returns results for the exact URL;
10934
+ example.com/example-page* – returns results for all domain’s URLs that start with the specified string */
10935
+ target?: string | undefined;
10936
+ /** page crawl limit
10937
+ optional field
10938
+ number of search results pages to crawl
10939
+ max value: 100
10940
+ Note: the max_crawl_pages and depth parameters complement each other;
10941
+ learn more at our help center */
10942
+ max_crawl_pages?: number | undefined;
10943
+ /** additional parameters of the search query
10944
+ optional field
10945
+ get the list of available parameters and additional details here */
10946
+ search_param?: string | undefined;
10947
+ /** user-defined task identifier
10948
+ optional field
10949
+ the character limit is 255
10950
+ you can use this parameter to identify the task and match it with the result
10951
+ you will find the specified tag value in the data object of the response */
10952
+ tag?: string | undefined;
10953
+ [key: string]: any;
10954
+ }
10955
+ export declare class SerpGoogleOrganicLiveRegularResultInfo implements ISerpGoogleOrganicLiveRegularResultInfo {
10956
+ /** keyword received in a POST array
10957
+ keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character) */
10958
+ keyword?: string | undefined;
10959
+ /** type of element */
10960
+ type?: string | undefined;
10961
+ /** search engine domain in a POST array */
10962
+ se_domain?: string | undefined;
10963
+ /** location code in a POST array */
10964
+ location_code?: number | undefined;
10965
+ /** language code in a POST array */
10966
+ language_code?: string | undefined;
10967
+ /** direct URL to search engine results
10968
+ you can use it to make sure that we provided exact results */
10969
+ check_url?: string | undefined;
10970
+ /** date and time when the result was received
10971
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
10972
+ example:
10973
+ 2019-11-15 12:57:46 +00:00 */
10974
+ datetime?: string | undefined;
10975
+ /** autocorrection of the search engine
10976
+ 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 */
10977
+ spell?: SpellInfo | undefined;
10978
+ /** types of search results found in SERP
10979
+ contains types of all search results (items) found in the returned SERP
10980
+ possible item types:
10981
+ answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, images, jobs, knowledge_graph, local_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel
10982
+ note that this array contains all types of search results found in the returned SERP;
10983
+ however, this endpoint provides data for featured_snippet, organic and paid types only
10984
+ to get all items (inlcuding SERP features and rich snippets) found in the returned SERP, please refer to the Google Organiс Advanced SERP endpoint */
10985
+ item_types?: (string | undefined)[] | undefined;
10986
+ /** total number of results in SERP */
10987
+ se_results_count?: number | undefined;
10988
+ /** the number of results returned in the items array */
10989
+ items_count?: number | undefined;
10990
+ /** items in SERP */
10991
+ items?: (BaseSerpElementItem | undefined)[] | undefined;
10992
+ [key: string]: any;
10993
+ constructor(data?: ISerpGoogleOrganicLiveRegularResultInfo);
10994
+ init(_data?: any): void;
10995
+ static fromJS(data: any): SerpGoogleOrganicLiveRegularResultInfo;
10996
+ toJSON(data?: any): any;
10997
+ }
10998
+ export interface ISerpGoogleOrganicLiveRegularResultInfo {
10716
10999
  /** keyword received in a POST array
10717
11000
  keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character) */
10718
11001
  keyword?: string | undefined;
@@ -10779,6 +11062,332 @@ export interface ISerpGoogleOrganicLiveRegularResponseInfo extends IBaseResponse
10779
11062
  tasks?: (SerpGoogleOrganicLiveRegularTaskInfo | undefined)[] | undefined;
10780
11063
  [key: string]: any;
10781
11064
  }
11065
+ export declare class SerpGoogleOrganicLiveAdvancedRequestInfo implements ISerpGoogleOrganicLiveAdvancedRequestInfo {
11066
+ /** keyword
11067
+ required field
11068
+ you can specify up to 700 symbols in the keyword field
11069
+ all %## will be decoded (plus symbol ‘+’ will be decoded to a space character)
11070
+ if you need to use the “%” symbol for your keyword, please specify it as “%25”;
11071
+ if you need to use the “+” symbol for your keyword, please specify it as “%2B”;
11072
+ if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5
11073
+ Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error */
11074
+ keyword?: string;
11075
+ /** direct URL of the search query
11076
+ optional field
11077
+ you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
11078
+ example:
11079
+ https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS */
11080
+ url?: string | undefined;
11081
+ /** parsing depth
11082
+ optional field
11083
+ number of results in SERP
11084
+ default value: 100
11085
+ max value: 700
11086
+ Note: your account will be billed per each SERP containing up to 100 results;
11087
+ thus, setting a depth above 100 may result in additional charges if the search engine returns more than 100 results;
11088
+ if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
11089
+ depth?: number | undefined;
11090
+ /** page crawl limit
11091
+ optional field
11092
+ number of search results pages to crawl
11093
+ max value: 100
11094
+ Note: the max_crawl_pages and depth parameters complement each other;
11095
+ learn more at our help center */
11096
+ max_crawl_pages?: number | undefined;
11097
+ /** full name of search engine location
11098
+ required field if you don’t specify location_code or location_coordinate
11099
+ if you use this field, you don’t need to specify location_code or location_coordinate
11100
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations
11101
+ example:
11102
+ London,England,United Kingdom */
11103
+ location_name?: string | undefined;
11104
+ /** search engine location code
11105
+ required field if you don’t specify location_name or location_coordinate
11106
+ if you use this field, you don’t need to specify location_name or location_coordinate
11107
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations
11108
+ example:
11109
+ 2840 */
11110
+ location_code?: number | undefined;
11111
+ /** GPS coordinates of a location
11112
+ optional field if you specify location_name or location_code
11113
+ if you use this field, you don’t need to specify location_name or location_code
11114
+ location_coordinate parameter should be specified in the “latitude,longitude,radius” format
11115
+ the maximum number of decimal digits for “latitude” and “longitude”: 7
11116
+ the minimum value for “radius”: 199.9 (mm)
11117
+ the maximum value for “radius”: 199999 (mm)
11118
+ example:
11119
+ 53.476225,-2.243572,200 */
11120
+ location_coordinate?: string | undefined;
11121
+ /** full name of search engine language
11122
+ optional field if you specify language_code
11123
+ if you use this field, you don’t need to specify language_code
11124
+ you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
11125
+ example:
11126
+ English */
11127
+ language_name?: string | undefined;
11128
+ /** search engine language code
11129
+ optional field if you specify language_name
11130
+ if you use this field, you don’t need to specify language_name
11131
+ you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
11132
+ example:
11133
+ en */
11134
+ language_code?: string | undefined;
11135
+ /** search engine domain
11136
+ optional field
11137
+ we choose the relevant search engine domain automatically according to the location and language you specify
11138
+ however, you can set a custom search engine domain in this field
11139
+ example:
11140
+ google.co.uk, google.com.au, google.de, etc. */
11141
+ se_domain?: string | undefined;
11142
+ /** device type
11143
+ optional field
11144
+ can take the values:desktop, mobile
11145
+ default value: desktop */
11146
+ device?: string | undefined;
11147
+ /** device operating system
11148
+ optional field
11149
+ if you specify desktop in the device field, choose from the following values: windows, macos
11150
+ default value: windows
11151
+ if you specify mobile in the device field, choose from the following values: android, ios
11152
+ default value: android */
11153
+ os?: string | undefined;
11154
+ /** target domain, subdomain, or webpage to get results for
11155
+ optional field
11156
+ a domain or a subdomain should be specified without https:// and www.
11157
+ note that the results of target-specific tasks will only include SERP elements that contain a url string;
11158
+ you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;
11159
+ examples:
11160
+ example.com – return results for the website’s home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;
11161
+ example.com* – returns results for the domain, including all its pages;
11162
+ *example.com* – returns results for the entire domain, including all its pages and subdomains;
11163
+ *example.com – returns results for the home page regardless of the subdomain, such as https://en.example.com;
11164
+ example.com/example-page – returns results for the exact URL;
11165
+ example.com/example-page* – returns results for all domain’s URLs that start with the specified string */
11166
+ target?: string | undefined;
11167
+ /** display related results
11168
+ optional field
11169
+ if set to true, the related_result element in the response will be provided as a snippet of its parent organic result;
11170
+ if set to false, the related_result element will be provided as a separate organic result;
11171
+ default value: true */
11172
+ group_organic_results?: boolean | undefined;
11173
+ /** calcualte pixel rankings for SERP elements in advanced results
11174
+ optional field
11175
+ pixel ranking refers to the distance between the result snippet and top left corner of the screen;
11176
+ Visit Help Center to learn more>>
11177
+ by default, the parameter is set to false
11178
+ Note: if set to true, the charge per task will be multiplied by 2 */
11179
+ calculate_rectangles?: boolean | undefined;
11180
+ /** browser screen width
11181
+ optional field
11182
+ you can set a custom browser screen width to calculate pixel rankings for a particular device;
11183
+ by default, the parameter is set to:
11184
+ 1920 for desktop;
11185
+ 360 for mobile on android;
11186
+ 375 for mobile on iOS;
11187
+ Note: to use this parameter, set calculate_rectangles to true */
11188
+ browser_screen_width?: number | undefined;
11189
+ /** browser screen height
11190
+ optional field
11191
+ you can set a custom browser screen height to calculate pixel rankings for a particular device;
11192
+ by default, the parameter is set to:
11193
+ 1080 for desktop;
11194
+ 640 for mobile on android;
11195
+ 812 for mobile on iOS;
11196
+ Note: to use this parameter, set calculate_rectangles to true */
11197
+ browser_screen_height?: number | undefined;
11198
+ /** browser screen resolution ratio
11199
+ optional field
11200
+ you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;
11201
+ by default, the parameter is set to:
11202
+ 1 for desktop;
11203
+ 3 for mobile on android;
11204
+ 3 for mobile on iOS;
11205
+ Note: to use this parameter, set calculate_rectangles to true */
11206
+ browser_screen_resolution_ratio?: number | undefined;
11207
+ /** clicks on the corresponding element
11208
+ optional field
11209
+ specify the click depth on the people_also_ask element to get additional people_also_ask_element items;
11210
+ Note your account will be billed $0.00015 extra for each click;
11211
+ if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balance
11212
+ possible values: from 1 to 4 */
11213
+ people_also_ask_click_depth?: number | undefined;
11214
+ /** additional parameters of the search query
11215
+ optional field
11216
+ get the list of available parameters and additional details here */
11217
+ search_param?: string | undefined;
11218
+ /** user-defined task identifier
11219
+ optional field
11220
+ the character limit is 255
11221
+ you can use this parameter to identify the task and match it with the result
11222
+ you will find the specified tag value in the data object of the response */
11223
+ tag?: string | undefined;
11224
+ [key: string]: any;
11225
+ constructor(data?: ISerpGoogleOrganicLiveAdvancedRequestInfo);
11226
+ init(_data?: any): void;
11227
+ static fromJS(data: any): SerpGoogleOrganicLiveAdvancedRequestInfo;
11228
+ toJSON(data?: any): any;
11229
+ }
11230
+ export interface ISerpGoogleOrganicLiveAdvancedRequestInfo {
11231
+ /** keyword
11232
+ required field
11233
+ you can specify up to 700 symbols in the keyword field
11234
+ all %## will be decoded (plus symbol ‘+’ will be decoded to a space character)
11235
+ if you need to use the “%” symbol for your keyword, please specify it as “%25”;
11236
+ if you need to use the “+” symbol for your keyword, please specify it as “%2B”;
11237
+ if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5
11238
+ Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error */
11239
+ keyword?: string;
11240
+ /** direct URL of the search query
11241
+ optional field
11242
+ you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
11243
+ example:
11244
+ https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS */
11245
+ url?: string | undefined;
11246
+ /** parsing depth
11247
+ optional field
11248
+ number of results in SERP
11249
+ default value: 100
11250
+ max value: 700
11251
+ Note: your account will be billed per each SERP containing up to 100 results;
11252
+ thus, setting a depth above 100 may result in additional charges if the search engine returns more than 100 results;
11253
+ if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
11254
+ depth?: number | undefined;
11255
+ /** page crawl limit
11256
+ optional field
11257
+ number of search results pages to crawl
11258
+ max value: 100
11259
+ Note: the max_crawl_pages and depth parameters complement each other;
11260
+ learn more at our help center */
11261
+ max_crawl_pages?: number | undefined;
11262
+ /** full name of search engine location
11263
+ required field if you don’t specify location_code or location_coordinate
11264
+ if you use this field, you don’t need to specify location_code or location_coordinate
11265
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations
11266
+ example:
11267
+ London,England,United Kingdom */
11268
+ location_name?: string | undefined;
11269
+ /** search engine location code
11270
+ required field if you don’t specify location_name or location_coordinate
11271
+ if you use this field, you don’t need to specify location_name or location_coordinate
11272
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations
11273
+ example:
11274
+ 2840 */
11275
+ location_code?: number | undefined;
11276
+ /** GPS coordinates of a location
11277
+ optional field if you specify location_name or location_code
11278
+ if you use this field, you don’t need to specify location_name or location_code
11279
+ location_coordinate parameter should be specified in the “latitude,longitude,radius” format
11280
+ the maximum number of decimal digits for “latitude” and “longitude”: 7
11281
+ the minimum value for “radius”: 199.9 (mm)
11282
+ the maximum value for “radius”: 199999 (mm)
11283
+ example:
11284
+ 53.476225,-2.243572,200 */
11285
+ location_coordinate?: string | undefined;
11286
+ /** full name of search engine language
11287
+ optional field if you specify language_code
11288
+ if you use this field, you don’t need to specify language_code
11289
+ you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
11290
+ example:
11291
+ English */
11292
+ language_name?: string | undefined;
11293
+ /** search engine language code
11294
+ optional field if you specify language_name
11295
+ if you use this field, you don’t need to specify language_name
11296
+ you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
11297
+ example:
11298
+ en */
11299
+ language_code?: string | undefined;
11300
+ /** search engine domain
11301
+ optional field
11302
+ we choose the relevant search engine domain automatically according to the location and language you specify
11303
+ however, you can set a custom search engine domain in this field
11304
+ example:
11305
+ google.co.uk, google.com.au, google.de, etc. */
11306
+ se_domain?: string | undefined;
11307
+ /** device type
11308
+ optional field
11309
+ can take the values:desktop, mobile
11310
+ default value: desktop */
11311
+ device?: string | undefined;
11312
+ /** device operating system
11313
+ optional field
11314
+ if you specify desktop in the device field, choose from the following values: windows, macos
11315
+ default value: windows
11316
+ if you specify mobile in the device field, choose from the following values: android, ios
11317
+ default value: android */
11318
+ os?: string | undefined;
11319
+ /** target domain, subdomain, or webpage to get results for
11320
+ optional field
11321
+ a domain or a subdomain should be specified without https:// and www.
11322
+ note that the results of target-specific tasks will only include SERP elements that contain a url string;
11323
+ you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;
11324
+ examples:
11325
+ example.com – return results for the website’s home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;
11326
+ example.com* – returns results for the domain, including all its pages;
11327
+ *example.com* – returns results for the entire domain, including all its pages and subdomains;
11328
+ *example.com – returns results for the home page regardless of the subdomain, such as https://en.example.com;
11329
+ example.com/example-page – returns results for the exact URL;
11330
+ example.com/example-page* – returns results for all domain’s URLs that start with the specified string */
11331
+ target?: string | undefined;
11332
+ /** display related results
11333
+ optional field
11334
+ if set to true, the related_result element in the response will be provided as a snippet of its parent organic result;
11335
+ if set to false, the related_result element will be provided as a separate organic result;
11336
+ default value: true */
11337
+ group_organic_results?: boolean | undefined;
11338
+ /** calcualte pixel rankings for SERP elements in advanced results
11339
+ optional field
11340
+ pixel ranking refers to the distance between the result snippet and top left corner of the screen;
11341
+ Visit Help Center to learn more>>
11342
+ by default, the parameter is set to false
11343
+ Note: if set to true, the charge per task will be multiplied by 2 */
11344
+ calculate_rectangles?: boolean | undefined;
11345
+ /** browser screen width
11346
+ optional field
11347
+ you can set a custom browser screen width to calculate pixel rankings for a particular device;
11348
+ by default, the parameter is set to:
11349
+ 1920 for desktop;
11350
+ 360 for mobile on android;
11351
+ 375 for mobile on iOS;
11352
+ Note: to use this parameter, set calculate_rectangles to true */
11353
+ browser_screen_width?: number | undefined;
11354
+ /** browser screen height
11355
+ optional field
11356
+ you can set a custom browser screen height to calculate pixel rankings for a particular device;
11357
+ by default, the parameter is set to:
11358
+ 1080 for desktop;
11359
+ 640 for mobile on android;
11360
+ 812 for mobile on iOS;
11361
+ Note: to use this parameter, set calculate_rectangles to true */
11362
+ browser_screen_height?: number | undefined;
11363
+ /** browser screen resolution ratio
11364
+ optional field
11365
+ you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;
11366
+ by default, the parameter is set to:
11367
+ 1 for desktop;
11368
+ 3 for mobile on android;
11369
+ 3 for mobile on iOS;
11370
+ Note: to use this parameter, set calculate_rectangles to true */
11371
+ browser_screen_resolution_ratio?: number | undefined;
11372
+ /** clicks on the corresponding element
11373
+ optional field
11374
+ specify the click depth on the people_also_ask element to get additional people_also_ask_element items;
11375
+ Note your account will be billed $0.00015 extra for each click;
11376
+ if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balance
11377
+ possible values: from 1 to 4 */
11378
+ people_also_ask_click_depth?: number | undefined;
11379
+ /** additional parameters of the search query
11380
+ optional field
11381
+ get the list of available parameters and additional details here */
11382
+ search_param?: string | undefined;
11383
+ /** user-defined task identifier
11384
+ optional field
11385
+ the character limit is 255
11386
+ you can use this parameter to identify the task and match it with the result
11387
+ you will find the specified tag value in the data object of the response */
11388
+ tag?: string | undefined;
11389
+ [key: string]: any;
11390
+ }
10782
11391
  export declare class SerpGoogleOrganicLiveAdvancedResultInfo implements ISerpGoogleOrganicLiveAdvancedResultInfo {
10783
11392
  /** keyword received in a POST array
10784
11393
  the keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character) */
@@ -13883,8 +14492,7 @@ top_stories, news_search */
13883
14492
  se_results_count?: number | undefined;
13884
14493
  /** the number of results returned in the items array */
13885
14494
  items_count?: number | undefined;
13886
- /** additional items present in the element
13887
- if there are none, equals null */
14495
+ /** elements of search results found in SERP */
13888
14496
  items?: (BaseSerpElementItem | undefined)[] | undefined;
13889
14497
  [key: string]: any;
13890
14498
  constructor(data?: ISerpGoogleNewsLiveAdvancedResultInfo);
@@ -13924,8 +14532,7 @@ top_stories, news_search */
13924
14532
  se_results_count?: number | undefined;
13925
14533
  /** the number of results returned in the items array */
13926
14534
  items_count?: number | undefined;
13927
- /** additional items present in the element
13928
- if there are none, equals null */
14535
+ /** elements of search results found in SERP */
13929
14536
  items?: (BaseSerpElementItem | undefined)[] | undefined;
13930
14537
  [key: string]: any;
13931
14538
  }
@@ -15787,7 +16394,7 @@ i.a., the # symbol will be encoded into %23 */
15787
16394
  required field if you specify postback_url
15788
16395
  corresponds to the datatype that will be sent to your server
15789
16396
  possible values:
15790
- advanced */
16397
+ advanced, html */
15791
16398
  postback_data?: string | undefined;
15792
16399
  /** notification URL of a completed task
15793
16400
  optional field
@@ -15921,7 +16528,7 @@ i.a., the # symbol will be encoded into %23 */
15921
16528
  required field if you specify postback_url
15922
16529
  corresponds to the datatype that will be sent to your server
15923
16530
  possible values:
15924
- advanced */
16531
+ advanced, html */
15925
16532
  postback_data?: string | undefined;
15926
16533
  /** notification URL of a completed task
15927
16534
  optional field
@@ -30103,7 +30710,7 @@ optional field
30103
30710
  you can add several filters at once (8 filters maximum)
30104
30711
  you should set a logical operator and, or between the conditions
30105
30712
  the following operators are supported:
30106
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
30713
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
30107
30714
  you can use the % operator with like and not_like to match any string of zero or more characters
30108
30715
  note that you can not filter the results by relevance
30109
30716
  example:
@@ -30221,7 +30828,7 @@ optional field
30221
30828
  you can add several filters at once (8 filters maximum)
30222
30829
  you should set a logical operator and, or between the conditions
30223
30830
  the following operators are supported:
30224
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
30831
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
30225
30832
  you can use the % operator with like and not_like to match any string of zero or more characters
30226
30833
  note that you can not filter the results by relevance
30227
30834
  example:
@@ -30923,7 +31530,7 @@ optional field
30923
31530
  you can add several filters at once (8 filters maximum)
30924
31531
  you should set a logical operator and, or between the conditions
30925
31532
  the following operators are supported:
30926
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
31533
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
30927
31534
  you can use the % operator with like and not_like to match any string of zero or more characters
30928
31535
  example:
30929
31536
  ["keyword_info.search_volume",">",0]
@@ -31053,7 +31660,7 @@ optional field
31053
31660
  you can add several filters at once (8 filters maximum)
31054
31661
  you should set a logical operator and, or between the conditions
31055
31662
  the following operators are supported:
31056
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
31663
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
31057
31664
  you can use the % operator with like and not_like to match any string of zero or more characters
31058
31665
  example:
31059
31666
  ["keyword_info.search_volume",">",0]
@@ -31273,7 +31880,7 @@ optional field
31273
31880
  you can add several filters at once (8 filters maximum)
31274
31881
  you should set a logical operator and, or between the conditions
31275
31882
  the following operators are supported:
31276
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
31883
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
31277
31884
  you can use the % operator with like and not_like to match any string of zero or more characters
31278
31885
  example:
31279
31886
  ["keyword_info.search_volume",">",0]
@@ -31400,7 +32007,7 @@ optional field
31400
32007
  you can add several filters at once (8 filters maximum)
31401
32008
  you should set a logical operator and, or between the conditions
31402
32009
  the following operators are supported:
31403
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
32010
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
31404
32011
  you can use the % operator with like and not_like to match any string of zero or more characters
31405
32012
  example:
31406
32013
  ["keyword_info.search_volume",">",0]
@@ -31624,7 +32231,7 @@ optional field
31624
32231
  you can add several filters at once (8 filters maximum)
31625
32232
  you should set a logical operator and, or between the conditions
31626
32233
  the following operators are supported:
31627
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
32234
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
31628
32235
  you can use the % operator with like and not_like to match any string of zero or more characters
31629
32236
  note that you can not filter the results by relevance
31630
32237
  example:
@@ -31749,7 +32356,7 @@ optional field
31749
32356
  you can add several filters at once (8 filters maximum)
31750
32357
  you should set a logical operator and, or between the conditions
31751
32358
  the following operators are supported:
31752
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
32359
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
31753
32360
  you can use the % operator with like and not_like to match any string of zero or more characters
31754
32361
  note that you can not filter the results by relevance
31755
32362
  example:
@@ -32557,7 +33164,7 @@ optional field
32557
33164
  you can add several filters at once (8 filters maximum)
32558
33165
  you should set a logical operator and, or between the conditions
32559
33166
  the following operators are supported:
32560
- regex, <, <=, >, >=, =, <>, in, not_in
33167
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in
32561
33168
  example:
32562
33169
  ["metrics.organic.pos_1,">",0]
32563
33170
  [["metrics.organic.count",">=",100],
@@ -32665,7 +33272,7 @@ optional field
32665
33272
  you can add several filters at once (8 filters maximum)
32666
33273
  you should set a logical operator and, or between the conditions
32667
33274
  the following operators are supported:
32668
- regex, <, <=, >, >=, =, <>, in, not_in
33275
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in
32669
33276
  example:
32670
33277
  ["metrics.organic.pos_1,">",0]
32671
33278
  [["metrics.organic.count",">=",100],
@@ -32882,7 +33489,7 @@ optional field
32882
33489
  you can add several filters at once (8 filters maximum)
32883
33490
  you should set a logical operator and, or between the conditions
32884
33491
  the following operators are supported:
32885
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
33492
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
32886
33493
  you can use the % operator with like and not_like to match any string of zero or more characters
32887
33494
  example:
32888
33495
  ["keyword_info.search_volume",">",0]
@@ -33001,7 +33608,7 @@ optional field
33001
33608
  you can add several filters at once (8 filters maximum)
33002
33609
  you should set a logical operator and, or between the conditions
33003
33610
  the following operators are supported:
33004
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
33611
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
33005
33612
  you can use the % operator with like and not_like to match any string of zero or more characters
33006
33613
  example:
33007
33614
  ["keyword_info.search_volume",">",0]
@@ -33229,7 +33836,7 @@ optional field
33229
33836
  you can add several filters at once (8 filters maximum);
33230
33837
  you should set a logical operator and, or between the conditions
33231
33838
  the following operators are supported:
33232
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like;
33839
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like;
33233
33840
  you can use the % operator with like and not_like to match any string of zero or more characters;
33234
33841
  example:
33235
33842
  ["metrics_history.202110.organic.pos_1", ">", 15];
@@ -33374,7 +33981,7 @@ optional field
33374
33981
  you can add several filters at once (8 filters maximum);
33375
33982
  you should set a logical operator and, or between the conditions
33376
33983
  the following operators are supported:
33377
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like;
33984
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like;
33378
33985
  you can use the % operator with like and not_like to match any string of zero or more characters;
33379
33986
  example:
33380
33987
  ["metrics_history.202110.organic.pos_1", ">", 15];
@@ -33585,7 +34192,7 @@ optional field
33585
34192
  you can add several filters at once (8 filters maximum)
33586
34193
  you should set a logical operator and, or between the conditions
33587
34194
  the following operators are supported:
33588
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
34195
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
33589
34196
  you can use the % operator with like and not_like to match any string of zero or more characters
33590
34197
  example:
33591
34198
  ["keyword_info.search_volume",">",0]
@@ -33694,7 +34301,7 @@ optional field
33694
34301
  you can add several filters at once (8 filters maximum)
33695
34302
  you should set a logical operator and, or between the conditions
33696
34303
  the following operators are supported:
33697
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
34304
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
33698
34305
  you can use the % operator with like and not_like to match any string of zero or more characters
33699
34306
  example:
33700
34307
  ["keyword_info.search_volume",">",0]
@@ -33841,7 +34448,7 @@ optional field
33841
34448
  you can add several filters at once (8 filters maximum)
33842
34449
  you should set a logical operator and, or between the conditions
33843
34450
  the following operators are supported:
33844
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
34451
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
33845
34452
  you can use the % operator with like and not_like to match any string of zero or more characters
33846
34453
  examples:
33847
34454
  ["expiration_datetime", "<", "2021-02-15 01:00:00 +00:00"]
@@ -33895,7 +34502,7 @@ optional field
33895
34502
  you can add several filters at once (8 filters maximum)
33896
34503
  you should set a logical operator and, or between the conditions
33897
34504
  the following operators are supported:
33898
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
34505
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
33899
34506
  you can use the % operator with like and not_like to match any string of zero or more characters
33900
34507
  examples:
33901
34508
  ["expiration_datetime", "<", "2021-02-15 01:00:00 +00:00"]
@@ -34183,7 +34790,7 @@ optional field
34183
34790
  you can add several filters at once (8 filters maximum)
34184
34791
  you should set a logical operator and, or between the conditions
34185
34792
  the following operators are supported:
34186
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
34793
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
34187
34794
  you can use the % operator with like and not_like to match any string of zero or more characters
34188
34795
  example:
34189
34796
  ["ranked_serp_element.serp_item.rank_group","<=",10]
@@ -34316,7 +34923,7 @@ optional field
34316
34923
  you can add several filters at once (8 filters maximum)
34317
34924
  you should set a logical operator and, or between the conditions
34318
34925
  the following operators are supported:
34319
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
34926
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
34320
34927
  you can use the % operator with like and not_like to match any string of zero or more characters
34321
34928
  example:
34322
34929
  ["ranked_serp_element.serp_item.rank_group","<=",10]
@@ -34471,258 +35078,262 @@ if there are none, equals null */
34471
35078
  /** contains information from the ‘About this result’ panel
34472
35079
  ‘About this result’ panel provides additional context about why Google returned this result for the given query;
34473
35080
  this feature appears after clicking on the three dots next to most results */
34474
- about_this_result?: any | undefined;
34475
- /** primary domain name in SERP */
34476
- main_domain?: string | undefined;
34477
- /** URL in SERP that does not specify the HTTPs protocol and domain name */
34478
- relative_url?: string | undefined;
34479
- /** estimated traffic volume
34480
- estimated paid monthly traffic to the domain
34481
- calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
34482
- learn more about how the metric is calculated in this help center article */
34483
- etv?: number | undefined;
34484
- /** estimated traffic volume based on impressions
34485
- estimated paid monthly traffic to the domain
34486
- calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
34487
- learn more about how the metric is calculated in this help center article */
34488
- impressions_etv?: number | undefined;
34489
- /** estimated cost of monthly search traffic
34490
- represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
34491
- learn more about how the metric is calculated in this help center article */
34492
- estimated_paid_traffic_cost?: number | undefined;
34493
- /** changes in rankings
34494
- contains information about the ranking changes of the SERP element since the previous_updated_time */
34495
- rank_changes?: RankChanges | undefined;
34496
- /** backlinks information for the target website */
34497
- backlinks_info?: BacklinksInfo | undefined;
34498
- /** page and domain rank information */
34499
- rank_info?: RankInfo | undefined;
34500
- [key: string]: any;
34501
- constructor(data?: IOrganicDataforseoLabsSerpElementItem);
34502
- init(_data?: any): void;
34503
- static fromJS(data: any): OrganicDataforseoLabsSerpElementItem;
34504
- toJSON(data?: any): any;
34505
- }
34506
- export interface IOrganicDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
34507
- /** search engine type */
34508
- se_type?: string | undefined;
34509
- /** position within a group of elements with identical type values
34510
- positions of elements with different type values are omitted from rank_group */
34511
- rank_group?: number | undefined;
34512
- /** absolute rank in SERP
34513
- absolute position among all the elements in SERP */
34514
- rank_absolute?: number | undefined;
34515
- /** the alignment of the element in SERP
34516
- can take the following values:
34517
- left, right */
34518
- position?: string | undefined;
34519
- /** the XPath of the element */
34520
- xpath?: string | undefined;
34521
- /** subdomain in SERP */
34522
- domain?: string | undefined;
34523
- /** title of the result in SERP */
34524
- title?: string | undefined;
34525
- /** relevant URL in SERP */
34526
- url?: string | undefined;
34527
- /** breadcrumb in SERP */
34528
- breadcrumb?: string | undefined;
34529
- /** relevant website name in SERP */
34530
- website_name?: string | undefined;
34531
- /** indicates whether the element contains an image */
34532
- is_image?: boolean | undefined;
34533
- /** indicates whether the element contains a video */
34534
- is_video?: boolean | undefined;
34535
- /** indicates whether the element is a featured_snippet */
34536
- is_featured_snippet?: boolean | undefined;
34537
- /** indicates whether the element is marked as malicious */
34538
- is_malicious?: boolean | undefined;
34539
- /** description of the results element in SERP */
34540
- description?: string | undefined;
34541
- /** includes additional information appended before the result description in SERP */
34542
- pre_snippet?: string | undefined;
34543
- /** includes additional information appended after the result description in SERP */
34544
- extended_snippet?: string | undefined;
34545
- /** Accelerated Mobile Pages
34546
- indicates whether an item has the Accelerated Mobile Page (AMP) version */
34547
- amp_version?: boolean | undefined;
34548
- /** the item’s rating
34549
- the popularity rate based on reviews and displayed in SERP */
34550
- rating?: RatingInfo | undefined;
34551
- /** words highlighted in bold within the results description */
34552
- highlighted?: (string | undefined)[] | undefined;
34553
- /** sitelinks
34554
- the links shown below some of Google’s search results
34555
- if there are none, equals null */
34556
- links?: (AdLinkElement | undefined)[] | undefined;
34557
- /** contains information from the ‘About this result’ panel
34558
- ‘About this result’ panel provides additional context about why Google returned this result for the given query;
34559
- this feature appears after clicking on the three dots next to most results */
34560
- about_this_result?: any | undefined;
34561
- /** primary domain name in SERP */
34562
- main_domain?: string | undefined;
34563
- /** URL in SERP that does not specify the HTTPs protocol and domain name */
34564
- relative_url?: string | undefined;
34565
- /** estimated traffic volume
34566
- estimated paid monthly traffic to the domain
34567
- calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
34568
- learn more about how the metric is calculated in this help center article */
34569
- etv?: number | undefined;
34570
- /** estimated traffic volume based on impressions
34571
- estimated paid monthly traffic to the domain
34572
- calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
34573
- learn more about how the metric is calculated in this help center article */
34574
- impressions_etv?: number | undefined;
34575
- /** estimated cost of monthly search traffic
34576
- represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
34577
- learn more about how the metric is calculated in this help center article */
34578
- estimated_paid_traffic_cost?: number | undefined;
34579
- /** changes in rankings
34580
- contains information about the ranking changes of the SERP element since the previous_updated_time */
34581
- rank_changes?: RankChanges | undefined;
34582
- /** backlinks information for the target website */
34583
- backlinks_info?: BacklinksInfo | undefined;
34584
- /** page and domain rank information */
34585
- rank_info?: RankInfo | undefined;
34586
- [key: string]: any;
34587
- }
34588
- export declare class RankedSerpElement implements IRankedSerpElement {
34589
- /** search engine type */
34590
- se_type?: string | undefined;
34591
- /** contains data on the SERP element
34592
- the list of supported SERP elements can be found below */
34593
- serp_item?: BaseDataforseoLabsSerpElementItem | undefined;
34594
- /** direct URL to search engine results
34595
- you can use it to make sure that we provided accurate results */
34596
- check_url?: string | undefined;
34597
- /** types of search results in SERP
34598
- contains types of search results (items) found in SERP
34599
- possible item types:
34600
- answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, images, jobs, knowledge_graph, local_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;
34601
- note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements */
34602
- serp_item_types?: (string | undefined)[] | undefined;
34603
- /** number of search results for the returned keyword */
34604
- se_results_count?: string | undefined;
34605
- /** difficulty of ranking in the first top-10 organic results for a keyword
34606
- indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
34607
- calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;
34608
- learn more about the metric in this help center guide */
34609
- keyword_difficulty?: number | undefined;
34610
- /** lost ranked elements
34611
- indicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check */
34612
- is_lost?: boolean | undefined;
34613
- /** date and time when keyword data was updated
34614
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
34615
- example:
34616
- 2019-11-15 12:57:46 +00:00 */
34617
- last_updated_time?: string | undefined;
34618
- /** previous to the most recent date and time when SERP data was updated
34619
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
34620
- example:
34621
- 2019-10-15 12:57:46 +00:00 */
34622
- previous_updated_time?: string | undefined;
34623
- [key: string]: any;
34624
- constructor(data?: IRankedSerpElement);
34625
- init(_data?: any): void;
34626
- static fromJS(data: any): RankedSerpElement;
34627
- toJSON(data?: any): any;
34628
- }
34629
- export interface IRankedSerpElement {
34630
- /** search engine type */
34631
- se_type?: string | undefined;
34632
- /** contains data on the SERP element
34633
- the list of supported SERP elements can be found below */
34634
- serp_item?: BaseDataforseoLabsSerpElementItem | undefined;
34635
- /** direct URL to search engine results
34636
- you can use it to make sure that we provided accurate results */
34637
- check_url?: string | undefined;
34638
- /** types of search results in SERP
34639
- contains types of search results (items) found in SERP
34640
- possible item types:
34641
- answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, images, jobs, knowledge_graph, local_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;
34642
- note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements */
34643
- serp_item_types?: (string | undefined)[] | undefined;
34644
- /** number of search results for the returned keyword */
34645
- se_results_count?: string | undefined;
34646
- /** difficulty of ranking in the first top-10 organic results for a keyword
34647
- indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
34648
- calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;
34649
- learn more about the metric in this help center guide */
34650
- keyword_difficulty?: number | undefined;
34651
- /** lost ranked elements
34652
- indicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check */
34653
- is_lost?: boolean | undefined;
34654
- /** date and time when keyword data was updated
34655
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
34656
- example:
34657
- 2019-11-15 12:57:46 +00:00 */
34658
- last_updated_time?: string | undefined;
34659
- /** previous to the most recent date and time when SERP data was updated
34660
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
34661
- example:
34662
- 2019-10-15 12:57:46 +00:00 */
34663
- previous_updated_time?: string | undefined;
34664
- [key: string]: any;
34665
- }
34666
- export declare class DataforseoLabsGoogleRankedKeywordsLiveItem implements IDataforseoLabsGoogleRankedKeywordsLiveItem {
34667
- /** search engine type */
34668
- se_type?: string | undefined;
34669
- /** keyword data for the returned keyword */
34670
- keyword_data?: KeywordDataInfo | undefined;
34671
- /** contains data on the domain’s SERP element found for the returned keyword */
34672
- ranked_serp_element?: RankedSerpElement | undefined;
34673
- [key: string]: any;
34674
- constructor(data?: IDataforseoLabsGoogleRankedKeywordsLiveItem);
34675
- init(_data?: any): void;
34676
- static fromJS(data: any): DataforseoLabsGoogleRankedKeywordsLiveItem;
34677
- toJSON(data?: any): any;
34678
- }
34679
- export interface IDataforseoLabsGoogleRankedKeywordsLiveItem {
34680
- /** search engine type */
34681
- se_type?: string | undefined;
34682
- /** keyword data for the returned keyword */
34683
- keyword_data?: KeywordDataInfo | undefined;
34684
- /** contains data on the domain’s SERP element found for the returned keyword */
34685
- ranked_serp_element?: RankedSerpElement | undefined;
34686
- [key: string]: any;
34687
- }
34688
- export declare class PaidDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IPaidDataforseoLabsSerpElementItem {
34689
- /** search engine type */
34690
- se_type?: string | undefined;
34691
- /** position within a group of elements with identical type values
34692
- positions of elements with different type values are omitted from rank_group */
34693
- rank_group?: number | undefined;
34694
- /** absolute rank in SERP
34695
- absolute position among all the elements in SERP */
34696
- rank_absolute?: number | undefined;
34697
- /** the alignment of the element in SERP
34698
- can take the following values:
34699
- left, right */
34700
- position?: string | undefined;
34701
- /** the XPath of the element */
34702
- xpath?: string | undefined;
34703
- /** title of the result in SERP */
34704
- title?: string | undefined;
34705
- /** subdomain in SERP */
34706
- domain?: string | undefined;
34707
- /** description of the results element in SERP */
34708
- description?: string | undefined;
34709
- /** breadcrumb in SERP */
34710
- breadcrumb?: string | undefined;
34711
- /** relevant URL in SERP */
34712
- url?: string | undefined;
34713
- /** words highlighted in bold within the results description */
34714
- highlighted?: (string | undefined)[] | undefined;
34715
- /** additional information about the result */
34716
- extra?: {
34717
- [key: string]: string;
35081
+ about_this_result?: {
35082
+ [key: string]: AboutThisResultElement;
34718
35083
  } | undefined;
34719
- /** extended description
34720
- if there is none, equals null */
34721
- description_rows?: (string | undefined)[] | undefined;
34722
- /** sitelinks
34723
- the links shown below some of Google’s search results
34724
- if there are none, equals null */
34725
- links?: (AdLinkElement | undefined)[] | undefined;
35084
+ /** primary domain name in SERP */
35085
+ main_domain?: string | undefined;
35086
+ /** URL in SERP that does not specify the HTTPs protocol and domain name */
35087
+ relative_url?: string | undefined;
35088
+ /** estimated traffic volume
35089
+ estimated paid monthly traffic to the domain
35090
+ calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
35091
+ learn more about how the metric is calculated in this help center article */
35092
+ etv?: number | undefined;
35093
+ /** estimated traffic volume based on impressions
35094
+ estimated paid monthly traffic to the domain
35095
+ calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
35096
+ learn more about how the metric is calculated in this help center article */
35097
+ impressions_etv?: number | undefined;
35098
+ /** estimated cost of monthly search traffic
35099
+ represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
35100
+ learn more about how the metric is calculated in this help center article */
35101
+ estimated_paid_traffic_cost?: number | undefined;
35102
+ /** changes in rankings
35103
+ contains information about the ranking changes of the SERP element since the previous_updated_time */
35104
+ rank_changes?: RankChanges | undefined;
35105
+ /** backlinks information for the target website */
35106
+ backlinks_info?: BacklinksInfo | undefined;
35107
+ /** page and domain rank information */
35108
+ rank_info?: RankInfo | undefined;
35109
+ [key: string]: any;
35110
+ constructor(data?: IOrganicDataforseoLabsSerpElementItem);
35111
+ init(_data?: any): void;
35112
+ static fromJS(data: any): OrganicDataforseoLabsSerpElementItem;
35113
+ toJSON(data?: any): any;
35114
+ }
35115
+ export interface IOrganicDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
35116
+ /** search engine type */
35117
+ se_type?: string | undefined;
35118
+ /** position within a group of elements with identical type values
35119
+ positions of elements with different type values are omitted from rank_group */
35120
+ rank_group?: number | undefined;
35121
+ /** absolute rank in SERP
35122
+ absolute position among all the elements in SERP */
35123
+ rank_absolute?: number | undefined;
35124
+ /** the alignment of the element in SERP
35125
+ can take the following values:
35126
+ left, right */
35127
+ position?: string | undefined;
35128
+ /** the XPath of the element */
35129
+ xpath?: string | undefined;
35130
+ /** subdomain in SERP */
35131
+ domain?: string | undefined;
35132
+ /** title of the result in SERP */
35133
+ title?: string | undefined;
35134
+ /** relevant URL in SERP */
35135
+ url?: string | undefined;
35136
+ /** breadcrumb in SERP */
35137
+ breadcrumb?: string | undefined;
35138
+ /** relevant website name in SERP */
35139
+ website_name?: string | undefined;
35140
+ /** indicates whether the element contains an image */
35141
+ is_image?: boolean | undefined;
35142
+ /** indicates whether the element contains a video */
35143
+ is_video?: boolean | undefined;
35144
+ /** indicates whether the element is a featured_snippet */
35145
+ is_featured_snippet?: boolean | undefined;
35146
+ /** indicates whether the element is marked as malicious */
35147
+ is_malicious?: boolean | undefined;
35148
+ /** description of the results element in SERP */
35149
+ description?: string | undefined;
35150
+ /** includes additional information appended before the result description in SERP */
35151
+ pre_snippet?: string | undefined;
35152
+ /** includes additional information appended after the result description in SERP */
35153
+ extended_snippet?: string | undefined;
35154
+ /** Accelerated Mobile Pages
35155
+ indicates whether an item has the Accelerated Mobile Page (AMP) version */
35156
+ amp_version?: boolean | undefined;
35157
+ /** the item’s rating
35158
+ the popularity rate based on reviews and displayed in SERP */
35159
+ rating?: RatingInfo | undefined;
35160
+ /** words highlighted in bold within the results description */
35161
+ highlighted?: (string | undefined)[] | undefined;
35162
+ /** sitelinks
35163
+ the links shown below some of Google’s search results
35164
+ if there are none, equals null */
35165
+ links?: (AdLinkElement | undefined)[] | undefined;
35166
+ /** contains information from the ‘About this result’ panel
35167
+ ‘About this result’ panel provides additional context about why Google returned this result for the given query;
35168
+ this feature appears after clicking on the three dots next to most results */
35169
+ about_this_result?: {
35170
+ [key: string]: AboutThisResultElement;
35171
+ } | undefined;
35172
+ /** primary domain name in SERP */
35173
+ main_domain?: string | undefined;
35174
+ /** URL in SERP that does not specify the HTTPs protocol and domain name */
35175
+ relative_url?: string | undefined;
35176
+ /** estimated traffic volume
35177
+ estimated paid monthly traffic to the domain
35178
+ calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
35179
+ learn more about how the metric is calculated in this help center article */
35180
+ etv?: number | undefined;
35181
+ /** estimated traffic volume based on impressions
35182
+ estimated paid monthly traffic to the domain
35183
+ calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
35184
+ learn more about how the metric is calculated in this help center article */
35185
+ impressions_etv?: number | undefined;
35186
+ /** estimated cost of monthly search traffic
35187
+ represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
35188
+ learn more about how the metric is calculated in this help center article */
35189
+ estimated_paid_traffic_cost?: number | undefined;
35190
+ /** changes in rankings
35191
+ contains information about the ranking changes of the SERP element since the previous_updated_time */
35192
+ rank_changes?: RankChanges | undefined;
35193
+ /** backlinks information for the target website */
35194
+ backlinks_info?: BacklinksInfo | undefined;
35195
+ /** page and domain rank information */
35196
+ rank_info?: RankInfo | undefined;
35197
+ [key: string]: any;
35198
+ }
35199
+ export declare class RankedSerpElement implements IRankedSerpElement {
35200
+ /** search engine type */
35201
+ se_type?: string | undefined;
35202
+ /** contains data on the SERP element
35203
+ the list of supported SERP elements can be found below */
35204
+ serp_item?: BaseDataforseoLabsSerpElementItem | undefined;
35205
+ /** direct URL to search engine results
35206
+ you can use it to make sure that we provided accurate results */
35207
+ check_url?: string | undefined;
35208
+ /** types of search results in SERP
35209
+ contains types of search results (items) found in SERP
35210
+ possible item types:
35211
+ answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, images, jobs, knowledge_graph, local_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;
35212
+ note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements */
35213
+ serp_item_types?: (string | undefined)[] | undefined;
35214
+ /** number of search results for the returned keyword */
35215
+ se_results_count?: string | undefined;
35216
+ /** difficulty of ranking in the first top-10 organic results for a keyword
35217
+ indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
35218
+ calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;
35219
+ learn more about the metric in this help center guide */
35220
+ keyword_difficulty?: number | undefined;
35221
+ /** lost ranked elements
35222
+ indicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check */
35223
+ is_lost?: boolean | undefined;
35224
+ /** date and time when keyword data was updated
35225
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
35226
+ example:
35227
+ 2019-11-15 12:57:46 +00:00 */
35228
+ last_updated_time?: string | undefined;
35229
+ /** previous to the most recent date and time when SERP data was updated
35230
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
35231
+ example:
35232
+ 2019-10-15 12:57:46 +00:00 */
35233
+ previous_updated_time?: string | undefined;
35234
+ [key: string]: any;
35235
+ constructor(data?: IRankedSerpElement);
35236
+ init(_data?: any): void;
35237
+ static fromJS(data: any): RankedSerpElement;
35238
+ toJSON(data?: any): any;
35239
+ }
35240
+ export interface IRankedSerpElement {
35241
+ /** search engine type */
35242
+ se_type?: string | undefined;
35243
+ /** contains data on the SERP element
35244
+ the list of supported SERP elements can be found below */
35245
+ serp_item?: BaseDataforseoLabsSerpElementItem | undefined;
35246
+ /** direct URL to search engine results
35247
+ you can use it to make sure that we provided accurate results */
35248
+ check_url?: string | undefined;
35249
+ /** types of search results in SERP
35250
+ contains types of search results (items) found in SERP
35251
+ possible item types:
35252
+ answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, images, jobs, knowledge_graph, local_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;
35253
+ note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements */
35254
+ serp_item_types?: (string | undefined)[] | undefined;
35255
+ /** number of search results for the returned keyword */
35256
+ se_results_count?: string | undefined;
35257
+ /** difficulty of ranking in the first top-10 organic results for a keyword
35258
+ indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
35259
+ calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;
35260
+ learn more about the metric in this help center guide */
35261
+ keyword_difficulty?: number | undefined;
35262
+ /** lost ranked elements
35263
+ indicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check */
35264
+ is_lost?: boolean | undefined;
35265
+ /** date and time when keyword data was updated
35266
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
35267
+ example:
35268
+ 2019-11-15 12:57:46 +00:00 */
35269
+ last_updated_time?: string | undefined;
35270
+ /** previous to the most recent date and time when SERP data was updated
35271
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
35272
+ example:
35273
+ 2019-10-15 12:57:46 +00:00 */
35274
+ previous_updated_time?: string | undefined;
35275
+ [key: string]: any;
35276
+ }
35277
+ export declare class DataforseoLabsGoogleRankedKeywordsLiveItem implements IDataforseoLabsGoogleRankedKeywordsLiveItem {
35278
+ /** search engine type */
35279
+ se_type?: string | undefined;
35280
+ /** keyword data for the returned keyword */
35281
+ keyword_data?: KeywordDataInfo | undefined;
35282
+ /** contains data on the domain’s SERP element found for the returned keyword */
35283
+ ranked_serp_element?: RankedSerpElement | undefined;
35284
+ [key: string]: any;
35285
+ constructor(data?: IDataforseoLabsGoogleRankedKeywordsLiveItem);
35286
+ init(_data?: any): void;
35287
+ static fromJS(data: any): DataforseoLabsGoogleRankedKeywordsLiveItem;
35288
+ toJSON(data?: any): any;
35289
+ }
35290
+ export interface IDataforseoLabsGoogleRankedKeywordsLiveItem {
35291
+ /** search engine type */
35292
+ se_type?: string | undefined;
35293
+ /** keyword data for the returned keyword */
35294
+ keyword_data?: KeywordDataInfo | undefined;
35295
+ /** contains data on the domain’s SERP element found for the returned keyword */
35296
+ ranked_serp_element?: RankedSerpElement | undefined;
35297
+ [key: string]: any;
35298
+ }
35299
+ export declare class PaidDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IPaidDataforseoLabsSerpElementItem {
35300
+ /** search engine type */
35301
+ se_type?: string | undefined;
35302
+ /** position within a group of elements with identical type values
35303
+ positions of elements with different type values are omitted from rank_group */
35304
+ rank_group?: number | undefined;
35305
+ /** absolute rank in SERP
35306
+ absolute position among all the elements in SERP */
35307
+ rank_absolute?: number | undefined;
35308
+ /** the alignment of the element in SERP
35309
+ can take the following values:
35310
+ left, right */
35311
+ position?: string | undefined;
35312
+ /** the XPath of the element */
35313
+ xpath?: string | undefined;
35314
+ /** title of the result in SERP */
35315
+ title?: string | undefined;
35316
+ /** subdomain in SERP */
35317
+ domain?: string | undefined;
35318
+ /** description of the results element in SERP */
35319
+ description?: string | undefined;
35320
+ /** breadcrumb in SERP */
35321
+ breadcrumb?: string | undefined;
35322
+ /** relevant URL in SERP */
35323
+ url?: string | undefined;
35324
+ /** words highlighted in bold within the results description */
35325
+ highlighted?: (string | undefined)[] | undefined;
35326
+ /** additional information about the result */
35327
+ extra?: {
35328
+ [key: string]: string;
35329
+ } | undefined;
35330
+ /** extended description
35331
+ if there is none, equals null */
35332
+ description_rows?: (string | undefined)[] | undefined;
35333
+ /** sitelinks
35334
+ the links shown below some of Google’s search results
35335
+ if there are none, equals null */
35336
+ links?: (AdLinkElement | undefined)[] | undefined;
34726
35337
  /** primary domain name in SERP */
34727
35338
  main_domain?: string | undefined;
34728
35339
  /** URL in SERP that does not specify the HTTPs protocol and domain name */
@@ -34978,7 +35589,7 @@ optional field
34978
35589
  you can add several filters at once (8 filters maximum)
34979
35590
  you should set a logical operator and, or between the conditions
34980
35591
  the following operators are supported:
34981
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
35592
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
34982
35593
  you can use the % operator with like and not_like to match any string of zero or more characters
34983
35594
  example:
34984
35595
  ["median_position","in",[1,10]]
@@ -35085,7 +35696,7 @@ optional field
35085
35696
  you can add several filters at once (8 filters maximum)
35086
35697
  you should set a logical operator and, or between the conditions
35087
35698
  the following operators are supported:
35088
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
35699
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
35089
35700
  you can use the % operator with like and not_like to match any string of zero or more characters
35090
35701
  example:
35091
35702
  ["median_position","in",[1,10]]
@@ -35323,7 +35934,7 @@ optional field
35323
35934
  you can add several filters at once (8 filters maximum)
35324
35935
  you should set a logical operator and, or between the conditions
35325
35936
  the following operators are supported:
35326
- regex, <, <=, >, >=, =, <>, in, not_in
35937
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in
35327
35938
  example:
35328
35939
  ["metrics.organic.count",">",50]
35329
35940
  [["metrics.organic.pos_1","<>",0],"and",["metrics.organic.impressions_etv",">=","10"]]
@@ -35456,7 +36067,7 @@ optional field
35456
36067
  you can add several filters at once (8 filters maximum)
35457
36068
  you should set a logical operator and, or between the conditions
35458
36069
  the following operators are supported:
35459
- regex, <, <=, >, >=, =, <>, in, not_in
36070
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in
35460
36071
  example:
35461
36072
  ["metrics.organic.count",">",50]
35462
36073
  [["metrics.organic.pos_1","<>",0],"and",["metrics.organic.impressions_etv",">=","10"]]
@@ -35750,7 +36361,7 @@ optional field
35750
36361
  you can add several filters at once (8 filters maximum)
35751
36362
  you should set a logical operator and, or between the conditions
35752
36363
  the following operators are supported:
35753
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
36364
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
35754
36365
  you can use the % operator with like and not_like to match any string of zero or more characters
35755
36366
  example:
35756
36367
  ["keyword_data.keyword_info.search_volume","in",[100,1000]]
@@ -35869,7 +36480,7 @@ optional field
35869
36480
  you can add several filters at once (8 filters maximum)
35870
36481
  you should set a logical operator and, or between the conditions
35871
36482
  the following operators are supported:
35872
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
36483
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
35873
36484
  you can use the % operator with like and not_like to match any string of zero or more characters
35874
36485
  example:
35875
36486
  ["keyword_data.keyword_info.search_volume","in",[100,1000]]
@@ -36070,7 +36681,7 @@ optional field
36070
36681
  you can add several filters at once (8 filters maximum)
36071
36682
  you should set a logical operator and, or between the conditions
36072
36683
  the following operators are supported:
36073
- regex, <, <=, >, >=, =, <>, in, not_in
36684
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in
36074
36685
  example:
36075
36686
  ["metrics.paid.count",">",0]
36076
36687
  [["metrics.paid.count",">",0],"and",["metrics.paid.etv",">","50"]]
@@ -36183,7 +36794,7 @@ optional field
36183
36794
  you can add several filters at once (8 filters maximum)
36184
36795
  you should set a logical operator and, or between the conditions
36185
36796
  the following operators are supported:
36186
- regex, <, <=, >, >=, =, <>, in, not_in
36797
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in
36187
36798
  example:
36188
36799
  ["metrics.paid.count",">",0]
36189
36800
  [["metrics.paid.count",">",0],"and",["metrics.paid.etv",">","50"]]
@@ -36394,7 +37005,7 @@ optional field
36394
37005
  you can add several filters at once (8 filters maximum)
36395
37006
  you should set a logical operator and, or between the conditions
36396
37007
  the following operators are supported:
36397
- regex, <, <=, >, >=, =, <>, in, not_in
37008
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in
36398
37009
  example:
36399
37010
  ["metrics.paid.count",">",0]
36400
37011
  [["metrics.organic.count",">",50],"and",["metrics.organic.pos_1","<>",0]]
@@ -36507,7 +37118,7 @@ optional field
36507
37118
  you can add several filters at once (8 filters maximum)
36508
37119
  you should set a logical operator and, or between the conditions
36509
37120
  the following operators are supported:
36510
- regex, <, <=, >, >=, =, <>, in, not_in
37121
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in
36511
37122
  example:
36512
37123
  ["metrics.paid.count",">",0]
36513
37124
  [["metrics.organic.count",">",50],"and",["metrics.organic.pos_1","<>",0]]
@@ -37232,7 +37843,7 @@ left, right */
37232
37843
  /** the XPath of the element */
37233
37844
  xpath?: string | undefined;
37234
37845
  /** link of the element */
37235
- link?: any | undefined;
37846
+ link?: LinkElement | undefined;
37236
37847
  /** additional items present in the element
37237
37848
  if there are none, equals null */
37238
37849
  items?: (KnowledgeGraphImagesElement | undefined)[] | undefined;
@@ -37257,7 +37868,7 @@ left, right */
37257
37868
  /** the XPath of the element */
37258
37869
  xpath?: string | undefined;
37259
37870
  /** link of the element */
37260
- link?: any | undefined;
37871
+ link?: LinkElement | undefined;
37261
37872
  /** additional items present in the element
37262
37873
  if there are none, equals null */
37263
37874
  items?: (KnowledgeGraphImagesElement | undefined)[] | undefined;
@@ -37323,6 +37934,64 @@ if there are none, equals null */
37323
37934
  links?: (LinkElement | undefined)[] | undefined;
37324
37935
  [key: string]: any;
37325
37936
  }
37937
+ export declare class KnowledgeGraphCarouselItemDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IKnowledgeGraphCarouselItemDataforseoLabsSerpElementItem {
37938
+ /** group rank in SERP
37939
+ position within a group of elements with identical type values
37940
+ positions of elements with different type values are omitted from rank_group */
37941
+ rank_group?: number | undefined;
37942
+ /** absolute rank in SERP
37943
+ absolute position among all the elements in SERP */
37944
+ rank_absolute?: number | undefined;
37945
+ /** the alignment of the element in SERP
37946
+ can take the following values:
37947
+ left, right */
37948
+ position?: string | undefined;
37949
+ /** the XPath of the element */
37950
+ xpath?: string | undefined;
37951
+ /** title of the link */
37952
+ title?: string | undefined;
37953
+ /** google defined data attribute ID
37954
+ example:
37955
+ ss:/webfacts:net_worth */
37956
+ data_attrid?: string | undefined;
37957
+ /** link of the element */
37958
+ link?: LinkElement | undefined;
37959
+ /** additional items present in the element
37960
+ if there are none, equals null */
37961
+ items?: (KnowledgeGraphListElement | undefined)[] | undefined;
37962
+ [key: string]: any;
37963
+ constructor(data?: IKnowledgeGraphCarouselItemDataforseoLabsSerpElementItem);
37964
+ init(_data?: any): void;
37965
+ static fromJS(data: any): KnowledgeGraphCarouselItemDataforseoLabsSerpElementItem;
37966
+ toJSON(data?: any): any;
37967
+ }
37968
+ export interface IKnowledgeGraphCarouselItemDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
37969
+ /** group rank in SERP
37970
+ position within a group of elements with identical type values
37971
+ positions of elements with different type values are omitted from rank_group */
37972
+ rank_group?: number | undefined;
37973
+ /** absolute rank in SERP
37974
+ absolute position among all the elements in SERP */
37975
+ rank_absolute?: number | undefined;
37976
+ /** the alignment of the element in SERP
37977
+ can take the following values:
37978
+ left, right */
37979
+ position?: string | undefined;
37980
+ /** the XPath of the element */
37981
+ xpath?: string | undefined;
37982
+ /** title of the link */
37983
+ title?: string | undefined;
37984
+ /** google defined data attribute ID
37985
+ example:
37986
+ ss:/webfacts:net_worth */
37987
+ data_attrid?: string | undefined;
37988
+ /** link of the element */
37989
+ link?: LinkElement | undefined;
37990
+ /** additional items present in the element
37991
+ if there are none, equals null */
37992
+ items?: (KnowledgeGraphListElement | undefined)[] | undefined;
37993
+ [key: string]: any;
37994
+ }
37326
37995
  export declare class KnowledgeGraphDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IKnowledgeGraphDataforseoLabsSerpElementItem {
37327
37996
  /** search engine type */
37328
37997
  se_type?: string | undefined;
@@ -37479,64 +38148,6 @@ if there are none, equals null */
37479
38148
  items?: (BaseDataforseoLabsSerpElementItem | undefined)[] | undefined;
37480
38149
  [key: string]: any;
37481
38150
  }
37482
- export declare class KnowledgeGraphCarouselItemDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IKnowledgeGraphCarouselItemDataforseoLabsSerpElementItem {
37483
- /** group rank in SERP
37484
- position within a group of elements with identical type values
37485
- positions of elements with different type values are omitted from rank_group */
37486
- rank_group?: number | undefined;
37487
- /** absolute rank in SERP
37488
- absolute position among all the elements in SERP */
37489
- rank_absolute?: number | undefined;
37490
- /** the alignment of the element in SERP
37491
- can take the following values:
37492
- left, right */
37493
- position?: string | undefined;
37494
- /** the XPath of the element */
37495
- xpath?: string | undefined;
37496
- /** title of the link */
37497
- title?: string | undefined;
37498
- /** google defined data attribute ID
37499
- example:
37500
- ss:/webfacts:net_worth */
37501
- data_attrid?: string | undefined;
37502
- /** link of the element */
37503
- link?: any | undefined;
37504
- /** additional items present in the element
37505
- if there are none, equals null */
37506
- items?: (KnowledgeGraphListElement | undefined)[] | undefined;
37507
- [key: string]: any;
37508
- constructor(data?: IKnowledgeGraphCarouselItemDataforseoLabsSerpElementItem);
37509
- init(_data?: any): void;
37510
- static fromJS(data: any): KnowledgeGraphCarouselItemDataforseoLabsSerpElementItem;
37511
- toJSON(data?: any): any;
37512
- }
37513
- export interface IKnowledgeGraphCarouselItemDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
37514
- /** group rank in SERP
37515
- position within a group of elements with identical type values
37516
- positions of elements with different type values are omitted from rank_group */
37517
- rank_group?: number | undefined;
37518
- /** absolute rank in SERP
37519
- absolute position among all the elements in SERP */
37520
- rank_absolute?: number | undefined;
37521
- /** the alignment of the element in SERP
37522
- can take the following values:
37523
- left, right */
37524
- position?: string | undefined;
37525
- /** the XPath of the element */
37526
- xpath?: string | undefined;
37527
- /** title of the link */
37528
- title?: string | undefined;
37529
- /** google defined data attribute ID
37530
- example:
37531
- ss:/webfacts:net_worth */
37532
- data_attrid?: string | undefined;
37533
- /** link of the element */
37534
- link?: any | undefined;
37535
- /** additional items present in the element
37536
- if there are none, equals null */
37537
- items?: (KnowledgeGraphListElement | undefined)[] | undefined;
37538
- [key: string]: any;
37539
- }
37540
38151
  export declare class DataforseoLabsGoogleHistoricalSerpsLiveResultInfo implements IDataforseoLabsGoogleHistoricalSerpsLiveResultInfo {
37541
38152
  /** search engine type */
37542
38153
  se_type?: string | undefined;
@@ -37918,8 +38529,6 @@ left, right */
37918
38529
  [key: string]: any;
37919
38530
  }
37920
38531
  export declare class FeaturedSnippetDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IFeaturedSnippetDataforseoLabsSerpElementItem {
37921
- /** search engine type */
37922
- se_type?: string | undefined;
37923
38532
  /** position within a group of elements with identical type values
37924
38533
  positions of elements with different type values are omitted from rank_group */
37925
38534
  rank_group?: number | undefined;
@@ -37932,19 +38541,21 @@ left, right */
37932
38541
  position?: string | undefined;
37933
38542
  /** the XPath of the element */
37934
38543
  xpath?: string | undefined;
37935
- /** subdomain in SERP */
38544
+ /** domain where a link points */
37936
38545
  domain?: string | undefined;
37937
38546
  /** title of the result in SERP */
37938
38547
  title?: string | undefined;
37939
- /** the title of the featured snippets source page */
38548
+ /** title of a given element */
37940
38549
  featured_title?: string | undefined;
37941
38550
  /** description of the results element in SERP */
37942
38551
  description?: string | undefined;
37943
- /** relevant URL in SERP */
38552
+ /** relevant URL of the Ad element in SERP */
37944
38553
  url?: string | undefined;
37945
38554
  /** results table
37946
38555
  if there are none, equals null */
37947
- table?: any | undefined;
38556
+ table?: Table | undefined;
38557
+ /** search engine type */
38558
+ se_type?: string | undefined;
37948
38559
  /** primary domain name in SERP */
37949
38560
  main_domain?: string | undefined;
37950
38561
  /** URL in SERP that does not specify the HTTPs protocol and domain name */
@@ -37972,8 +38583,6 @@ contains information about the ranking changes of the SERP element since the pre
37972
38583
  toJSON(data?: any): any;
37973
38584
  }
37974
38585
  export interface IFeaturedSnippetDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
37975
- /** search engine type */
37976
- se_type?: string | undefined;
37977
38586
  /** position within a group of elements with identical type values
37978
38587
  positions of elements with different type values are omitted from rank_group */
37979
38588
  rank_group?: number | undefined;
@@ -37986,19 +38595,21 @@ left, right */
37986
38595
  position?: string | undefined;
37987
38596
  /** the XPath of the element */
37988
38597
  xpath?: string | undefined;
37989
- /** subdomain in SERP */
38598
+ /** domain where a link points */
37990
38599
  domain?: string | undefined;
37991
38600
  /** title of the result in SERP */
37992
38601
  title?: string | undefined;
37993
- /** the title of the featured snippets source page */
38602
+ /** title of a given element */
37994
38603
  featured_title?: string | undefined;
37995
38604
  /** description of the results element in SERP */
37996
38605
  description?: string | undefined;
37997
- /** relevant URL in SERP */
38606
+ /** relevant URL of the Ad element in SERP */
37998
38607
  url?: string | undefined;
37999
38608
  /** results table
38000
38609
  if there are none, equals null */
38001
- table?: any | undefined;
38610
+ table?: Table | undefined;
38611
+ /** search engine type */
38612
+ se_type?: string | undefined;
38002
38613
  /** primary domain name in SERP */
38003
38614
  main_domain?: string | undefined;
38004
38615
  /** URL in SERP that does not specify the HTTPs protocol and domain name */
@@ -39678,7 +40289,7 @@ optional field
39678
40289
  you can add several filters at once (8 filters maximum)
39679
40290
  you should set a logical operator and, or between the conditions
39680
40291
  the following operators are supported:
39681
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
40292
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
39682
40293
  you can use the % operator with like and not_like to match any string of zero or more characters
39683
40294
  note that if you want to filter by any field in the intersection_result array you need to specify the number of corresponding page
39684
40295
  for instance, if you want to filter results by the ranking of the first specified URL, you should set the following filter:
@@ -39836,7 +40447,7 @@ optional field
39836
40447
  you can add several filters at once (8 filters maximum)
39837
40448
  you should set a logical operator and, or between the conditions
39838
40449
  the following operators are supported:
39839
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
40450
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
39840
40451
  you can use the % operator with like and not_like to match any string of zero or more characters
39841
40452
  note that if you want to filter by any field in the intersection_result array you need to specify the number of corresponding page
39842
40453
  for instance, if you want to filter results by the ranking of the first specified URL, you should set the following filter:
@@ -41094,7 +41705,7 @@ optional field
41094
41705
  you can add several filters at once (8 filters maximum)
41095
41706
  you should set a logical operator and, or between the conditions
41096
41707
  the following operators are supported:
41097
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
41708
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
41098
41709
  you can use the % operator with like and not_like to match any string of zero or more characters
41099
41710
  example:
41100
41711
  ["keyword_data.keyword_info.search_volume","in",[100,1000]];
@@ -41184,7 +41795,7 @@ optional field
41184
41795
  you can add several filters at once (8 filters maximum)
41185
41796
  you should set a logical operator and, or between the conditions
41186
41797
  the following operators are supported:
41187
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
41798
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
41188
41799
  you can use the % operator with like and not_like to match any string of zero or more characters
41189
41800
  example:
41190
41801
  ["keyword_data.keyword_info.search_volume","in",[100,1000]];
@@ -41787,7 +42398,7 @@ optional field
41787
42398
  you can add several filters at once (8 filters maximum)
41788
42399
  you should set a logical operator and, or between the conditions
41789
42400
  the following operators are supported:
41790
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
42401
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
41791
42402
  you can use the % operator with like and not_like to match any string of zero or more characters
41792
42403
  example:
41793
42404
  ["full_metrics.amazon_serp.pos_1",">", 20]
@@ -41872,7 +42483,7 @@ optional field
41872
42483
  you can add several filters at once (8 filters maximum)
41873
42484
  you should set a logical operator and, or between the conditions
41874
42485
  the following operators are supported:
41875
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
42486
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
41876
42487
  you can use the % operator with like and not_like to match any string of zero or more characters
41877
42488
  example:
41878
42489
  ["full_metrics.amazon_serp.pos_1",">", 20]
@@ -42093,7 +42704,7 @@ optional field
42093
42704
  you can add several filters at once (8 filters maximum)
42094
42705
  you should set a logical operator and, or between the conditions
42095
42706
  the following operators are supported:
42096
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
42707
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
42097
42708
  you can use the % operator with like and not_like to match any string of zero or more characters
42098
42709
  example:
42099
42710
  ["avg_position","<", 10]
@@ -42192,7 +42803,7 @@ optional field
42192
42803
  you can add several filters at once (8 filters maximum)
42193
42804
  you should set a logical operator and, or between the conditions
42194
42805
  the following operators are supported:
42195
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
42806
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
42196
42807
  you can use the % operator with like and not_like to match any string of zero or more characters
42197
42808
  example:
42198
42809
  ["avg_position","<", 10]
@@ -42723,7 +43334,7 @@ optional field
42723
43334
  you can add several filters at once (8 filters maximum)
42724
43335
  you should set a logical operator and, or between the conditions
42725
43336
  the following operators are supported:
42726
- regex, <, <=, >, >=, =, <>, in, not_in
43337
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in
42727
43338
  example:
42728
43339
  ["metrics.organic.count",">",50]
42729
43340
  [["metrics.organic.pos_1","<>",0],"and",["metrics.organic.etv",">=","10"]]
@@ -42858,7 +43469,7 @@ optional field
42858
43469
  you can add several filters at once (8 filters maximum)
42859
43470
  you should set a logical operator and, or between the conditions
42860
43471
  the following operators are supported:
42861
- regex, <, <=, >, >=, =, <>, in, not_in
43472
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in
42862
43473
  example:
42863
43474
  ["metrics.organic.count",">",50]
42864
43475
  [["metrics.organic.pos_1","<>",0],"and",["metrics.organic.etv",">=","10"]]
@@ -43082,7 +43693,7 @@ optional field
43082
43693
  you can add several filters at once (8 filters maximum)
43083
43694
  you should set a logical operator and, or between the conditions
43084
43695
  the following operators are supported:
43085
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
43696
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
43086
43697
  you can use the % operator with like and not_like to match any string of zero or more characters
43087
43698
  example:
43088
43699
  ["keyword_data.keyword_info.search_volume","in",[100,1000]]
@@ -43203,7 +43814,7 @@ optional field
43203
43814
  you can add several filters at once (8 filters maximum)
43204
43815
  you should set a logical operator and, or between the conditions
43205
43816
  the following operators are supported:
43206
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
43817
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
43207
43818
  you can use the % operator with like and not_like to match any string of zero or more characters
43208
43819
  example:
43209
43820
  ["keyword_data.keyword_info.search_volume","in",[100,1000]]
@@ -43658,7 +44269,7 @@ optional field
43658
44269
  you can add several filters at once (8 filters maximum)
43659
44270
  you should set a logical operator and, or between the conditions
43660
44271
  the following operators are supported:
43661
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
44272
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
43662
44273
  you can use the % operator with like and not_like to match any string of zero or more charactersnote that if you want to filter by any field in the intersection_result array you need to specify the number of corresponding page
43663
44274
  for instance, if you want to filter results by the ranking of the first specified URL, you should set the following filter:
43664
44275
  [intersection_result.1.rank_absolute,"=",1]
@@ -43817,7 +44428,7 @@ optional field
43817
44428
  you can add several filters at once (8 filters maximum)
43818
44429
  you should set a logical operator and, or between the conditions
43819
44430
  the following operators are supported:
43820
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
44431
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
43821
44432
  you can use the % operator with like and not_like to match any string of zero or more charactersnote that if you want to filter by any field in the intersection_result array you need to specify the number of corresponding page
43822
44433
  for instance, if you want to filter results by the ranking of the first specified URL, you should set the following filter:
43823
44434
  [intersection_result.1.rank_absolute,"=",1]
@@ -44059,7 +44670,7 @@ optional field
44059
44670
  you can add several filters at once (8 filters maximum)
44060
44671
  you should set a logical operator and, or between the conditions
44061
44672
  the following operators are supported:
44062
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
44673
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
44063
44674
  you can use the % operator with like and not_like to match any string of zero or more characters
44064
44675
  example:
44065
44676
  ["ranked_serp_element.serp_item.rank_group","<=",10]
@@ -44194,7 +44805,7 @@ optional field
44194
44805
  you can add several filters at once (8 filters maximum)
44195
44806
  you should set a logical operator and, or between the conditions
44196
44807
  the following operators are supported:
44197
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
44808
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
44198
44809
  you can use the % operator with like and not_like to match any string of zero or more characters
44199
44810
  example:
44200
44811
  ["ranked_serp_element.serp_item.rank_group","<=",10]
@@ -44425,7 +45036,7 @@ optional field
44425
45036
  you can add several filters at once (8 filters maximum)
44426
45037
  you should set a logical operator and, or between the conditions
44427
45038
  the following operators are supported:
44428
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
45039
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
44429
45040
  you can use the % operator with like and not_like to match any string of zero or more characters
44430
45041
  example:
44431
45042
  ["keyword_data.keyword_info.search_volume",">",0]
@@ -44549,7 +45160,7 @@ optional field
44549
45160
  you can add several filters at once (8 filters maximum)
44550
45161
  you should set a logical operator and, or between the conditions
44551
45162
  the following operators are supported:
44552
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
45163
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
44553
45164
  you can use the % operator with like and not_like to match any string of zero or more characters
44554
45165
  example:
44555
45166
  ["keyword_data.keyword_info.search_volume",">",0]
@@ -44766,7 +45377,7 @@ optional field
44766
45377
  you can add several filters at once (8 filters maximum)
44767
45378
  you should set a logical operator and, or between the conditions
44768
45379
  the following operators are supported:
44769
- regex, <, <=, >, >=, =, <>, in, not_in
45380
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in
44770
45381
  example:
44771
45382
  ["metrics.paid.count",">",0]
44772
45383
  [["metrics.organic.count",">",50],"and",["metrics.organic.pos_1","<>",0]]
@@ -44881,7 +45492,7 @@ optional field
44881
45492
  you can add several filters at once (8 filters maximum)
44882
45493
  you should set a logical operator and, or between the conditions
44883
45494
  the following operators are supported:
44884
- regex, <, <=, >, >=, =, <>, in, not_in
45495
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in
44885
45496
  example:
44886
45497
  ["metrics.paid.count",">",0]
44887
45498
  [["metrics.organic.count",">",50],"and",["metrics.organic.pos_1","<>",0]]
@@ -45056,7 +45667,7 @@ optional field
45056
45667
  you can add several filters at once (8 filters maximum)
45057
45668
  you should set a logical operator and, or between the conditions
45058
45669
  the following operators are supported:
45059
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
45670
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
45060
45671
  you can use the % operator with like and not_like to match any string of zero or more characters
45061
45672
  example:
45062
45673
  ["median_position","in",[1,10]]
@@ -45165,7 +45776,7 @@ optional field
45165
45776
  you can add several filters at once (8 filters maximum)
45166
45777
  you should set a logical operator and, or between the conditions
45167
45778
  the following operators are supported:
45168
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
45779
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
45169
45780
  you can use the % operator with like and not_like to match any string of zero or more characters
45170
45781
  example:
45171
45782
  ["median_position","in",[1,10]]
@@ -53555,32 +54166,6 @@ export interface IDemography {
53555
54166
  gender?: (DataforseoTrendsDataInfo | undefined)[] | undefined;
53556
54167
  [key: string]: any;
53557
54168
  }
53558
- export declare class DemographyComparison implements IDemographyComparison {
53559
- /** comparison of keyword popularity data by age */
53560
- age?: {
53561
- [key: string]: (number | undefined)[];
53562
- } | undefined;
53563
- /** comparison of keyword popularity data by gender */
53564
- gender?: {
53565
- [key: string]: (number | undefined)[];
53566
- } | undefined;
53567
- [key: string]: any;
53568
- constructor(data?: IDemographyComparison);
53569
- init(_data?: any): void;
53570
- static fromJS(data: any): DemographyComparison;
53571
- toJSON(data?: any): any;
53572
- }
53573
- export interface IDemographyComparison {
53574
- /** comparison of keyword popularity data by age */
53575
- age?: {
53576
- [key: string]: (number | undefined)[];
53577
- } | undefined;
53578
- /** comparison of keyword popularity data by gender */
53579
- gender?: {
53580
- [key: string]: (number | undefined)[];
53581
- } | undefined;
53582
- [key: string]: any;
53583
- }
53584
54169
  export declare class DataforseoTrendsDemographyInfo implements IDataforseoTrendsDemographyInfo {
53585
54170
  /** the alignment of the element
53586
54171
  can take the following values: 1, 2, 3, 4, etc. */
@@ -53596,7 +54181,7 @@ conains keyword popularity data by age and gender */
53596
54181
  /** comparison of demographic data on keyword popularity for the specified parameters
53597
54182
  conains keyword popularity data by age and gender
53598
54183
  if you specified a single keyword, the value will be null */
53599
- demography_comparison?: DemographyComparison | undefined;
54184
+ demography_comparison?: DemographyComparisonInfo | undefined;
53600
54185
  [key: string]: any;
53601
54186
  constructor(data?: IDataforseoTrendsDemographyInfo);
53602
54187
  init(_data?: any): void;
@@ -53618,7 +54203,7 @@ conains keyword popularity data by age and gender */
53618
54203
  /** comparison of demographic data on keyword popularity for the specified parameters
53619
54204
  conains keyword popularity data by age and gender
53620
54205
  if you specified a single keyword, the value will be null */
53621
- demography_comparison?: DemographyComparison | undefined;
54206
+ demography_comparison?: DemographyComparisonInfo | undefined;
53622
54207
  [key: string]: any;
53623
54208
  }
53624
54209
  export declare class KeywordsDataDataforseoTrendsDemographyLiveResultInfo implements IKeywordsDataDataforseoTrendsDemographyLiveResultInfo {
@@ -53825,10 +54410,7 @@ the data included in the interests and interests_comparison is based on the keyw
53825
54410
  /** demographic breakdown of keyword popularity data per each specified term
53826
54411
  conains keyword popularity data by age and gender */
53827
54412
  demography?: Demography | undefined;
53828
- /** comparison of demographic data on keyword popularity for the specified parameters
53829
- conains keyword popularity data by age and gender
53830
- if you specified a single keyword, the value will be null */
53831
- demography_comparison?: any | undefined;
54413
+ demography_comparison?: DemographyComparisonInfo | undefined;
53832
54414
  [key: string]: any;
53833
54415
  constructor(data?: IDataforseoTrendsDemographyElementItem);
53834
54416
  init(_data?: any): void;
@@ -53845,10 +54427,7 @@ the data included in the interests and interests_comparison is based on the keyw
53845
54427
  /** demographic breakdown of keyword popularity data per each specified term
53846
54428
  conains keyword popularity data by age and gender */
53847
54429
  demography?: Demography | undefined;
53848
- /** comparison of demographic data on keyword popularity for the specified parameters
53849
- conains keyword popularity data by age and gender
53850
- if you specified a single keyword, the value will be null */
53851
- demography_comparison?: any | undefined;
54430
+ demography_comparison?: DemographyComparisonInfo | undefined;
53852
54431
  [key: string]: any;
53853
54432
  }
53854
54433
  export declare class KeywordsDataDataforseoTrendsMergedDataLiveResultInfo implements IKeywordsDataDataforseoTrendsMergedDataLiveResultInfo {
@@ -58160,7 +58739,7 @@ optional field
58160
58739
  you can add several filters at once (8 filters maximum)
58161
58740
  you should set a logical operator and, or between the conditions
58162
58741
  the following operators are supported:
58163
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
58742
+ regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, regex, not_regex
58164
58743
  you can use the % operator with like and not_like to match any string of zero or more characters
58165
58744
  example:
58166
58745
  ["rank",">","80"]
@@ -58282,7 +58861,7 @@ optional field
58282
58861
  you can add several filters at once (8 filters maximum)
58283
58862
  you should set a logical operator and, or between the conditions
58284
58863
  the following operators are supported:
58285
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
58864
+ regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, regex, not_regex
58286
58865
  you can use the % operator with like and not_like to match any string of zero or more characters
58287
58866
  example:
58288
58867
  ["rank",">","80"]
@@ -58820,7 +59399,7 @@ optional field
58820
59399
  you can add several filters at once (8 filters maximum)
58821
59400
  you should set a logical operator and, or between the conditions
58822
59401
  the following operators are supported:
58823
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
59402
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
58824
59403
  you can use the % operator with like and not_like to match any string of zero or more characters
58825
59404
  example:
58826
59405
  ["referring_links_types.anchors",">","1"]
@@ -58923,7 +59502,7 @@ optional field
58923
59502
  you can add several filters at once (8 filters maximum)
58924
59503
  you should set a logical operator and, or between the conditions
58925
59504
  the following operators are supported:
58926
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
59505
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
58927
59506
  you can use the % operator with like and not_like to match any string of zero or more characters
58928
59507
  example:
58929
59508
  ["referring_links_types.anchors",">","1"]
@@ -59253,7 +59832,7 @@ optional field
59253
59832
  you can add several filters at once (8 filters maximum)
59254
59833
  you should set a logical operator and, or between the conditions
59255
59834
  the following operators are supported:
59256
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
59835
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
59257
59836
  you can use the % operator with like and not_like to match any string of zero or more characters
59258
59837
  example:
59259
59838
  ["meta.internal_links_count",">","1"]
@@ -59346,7 +59925,7 @@ optional field
59346
59925
  you can add several filters at once (8 filters maximum)
59347
59926
  you should set a logical operator and, or between the conditions
59348
59927
  the following operators are supported:
59349
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
59928
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
59350
59929
  you can use the % operator with like and not_like to match any string of zero or more characters
59351
59930
  example:
59352
59931
  ["meta.internal_links_count",">","1"]
@@ -59876,7 +60455,7 @@ optional field
59876
60455
  you can add several filters at once (8 filters maximum)
59877
60456
  you should set a logical operator and, or between the conditions
59878
60457
  the following operators are supported:
59879
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
60458
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
59880
60459
  you can use the % operator with like and not_like to match any string of zero or more characters
59881
60460
  example:
59882
60461
  ["referring_links_types.anchors",">","1"]
@@ -59979,7 +60558,7 @@ optional field
59979
60558
  you can add several filters at once (8 filters maximum)
59980
60559
  you should set a logical operator and, or between the conditions
59981
60560
  the following operators are supported:
59982
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
60561
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
59983
60562
  you can use the % operator with like and not_like to match any string of zero or more characters
59984
60563
  example:
59985
60564
  ["referring_links_types.anchors",">","1"]
@@ -60308,7 +60887,7 @@ optional field
60308
60887
  you can add several filters at once (8 filters maximum)
60309
60888
  you should set a logical operator and, or between the conditions
60310
60889
  the following operators are supported:
60311
- regex, =, <>, in, not_in, like, not_like
60890
+ regex, not_regex, =, <>, in, not_in, like, not_like
60312
60891
  you can use the % operator with like and not_like to match any string of zero or more characters
60313
60892
  example:
60314
60893
  ["referring_pages",">","1"]
@@ -60411,7 +60990,7 @@ optional field
60411
60990
  you can add several filters at once (8 filters maximum)
60412
60991
  you should set a logical operator and, or between the conditions
60413
60992
  the following operators are supported:
60414
- regex, =, <>, in, not_in, like, not_like
60993
+ regex, not_regex, =, <>, in, not_in, like, not_like
60415
60994
  you can use the % operator with like and not_like to match any string of zero or more characters
60416
60995
  example:
60417
60996
  ["referring_pages",">","1"]
@@ -60753,7 +61332,7 @@ optional field
60753
61332
  you can add several filters at once (8 filters maximum)
60754
61333
  you should set a logical operator and, or between the conditions
60755
61334
  the following operators are supported:
60756
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
61335
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
60757
61336
  you can use the % operator with like and not_like to match any string of zero or more characters
60758
61337
  example:
60759
61338
  ["referring_pages",">","1"]
@@ -60861,7 +61440,7 @@ optional field
60861
61440
  you can add several filters at once (8 filters maximum)
60862
61441
  you should set a logical operator and, or between the conditions
60863
61442
  the following operators are supported:
60864
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
61443
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
60865
61444
  you can use the % operator with like and not_like to match any string of zero or more characters
60866
61445
  example:
60867
61446
  ["referring_pages",">","1"]
@@ -61166,7 +61745,7 @@ optional field
61166
61745
  you can add several filters at once (8 filters maximum)
61167
61746
  you should set a logical operator and, or between the conditions
61168
61747
  the following operators are supported:
61169
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
61748
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
61170
61749
  you can use the % operator with like and not_like to match any string of zero or more characters
61171
61750
  example:
61172
61751
  ["rank",">","100"]
@@ -61232,7 +61811,7 @@ optional field
61232
61811
  you can add several filters at once (8 filters maximum)
61233
61812
  you should set a logical operator and, or between the conditions
61234
61813
  the following operators are supported:
61235
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
61814
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
61236
61815
  you can use the % operator with like and not_like to match any string of zero or more characters
61237
61816
  example:
61238
61817
  ["rank",">","100"]
@@ -61384,7 +61963,7 @@ optional field
61384
61963
  you can add several filters at once (8 filters maximum)
61385
61964
  you should set a logical operator and, or between the conditions
61386
61965
  the following operators are supported:
61387
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
61966
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
61388
61967
  you can use the % operator with like and not_like to match any string of zero or more characters
61389
61968
  example:
61390
61969
  ["1.internal_links_count",">","1"]
@@ -61467,7 +62046,7 @@ default value: true */
61467
62046
  /** indicates whether to intersect backlinks
61468
62047
  optional field
61469
62048
  use this field to intersect or merge results for the specified domains
61470
- possible values: all, partical
62049
+ possible values: all, partial
61471
62050
  all – results are based on all backlinks;
61472
62051
  partial – results are based on the intersecting backlinks only;
61473
62052
  default value: all */
@@ -61513,7 +62092,7 @@ optional field
61513
62092
  you can add several filters at once (8 filters maximum)
61514
62093
  you should set a logical operator and, or between the conditions
61515
62094
  the following operators are supported:
61516
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
62095
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
61517
62096
  you can use the % operator with like and not_like to match any string of zero or more characters
61518
62097
  example:
61519
62098
  ["1.internal_links_count",">","1"]
@@ -61596,7 +62175,7 @@ default value: true */
61596
62175
  /** indicates whether to intersect backlinks
61597
62176
  optional field
61598
62177
  use this field to intersect or merge results for the specified domains
61599
- possible values: all, partical
62178
+ possible values: all, partial
61600
62179
  all – results are based on all backlinks;
61601
62180
  partial – results are based on the intersecting backlinks only;
61602
62181
  default value: all */
@@ -61907,7 +62486,7 @@ optional field
61907
62486
  you can add several filters at once (8 filters maximum)
61908
62487
  you should set a logical operator and, or between the conditions
61909
62488
  the following operators are supported:
61910
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
62489
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
61911
62490
  you can use the % operator with like and not_like to match any string of zero or more characters
61912
62491
  example:
61913
62492
  ["1.rank",">","80"]
@@ -61965,7 +62544,7 @@ default value: true */
61965
62544
  /** indicates whether to intersect backlinks
61966
62545
  optional field
61967
62546
  use this field to intersect or merge results for the specified URLs
61968
- possible values: all, partical
62547
+ possible values: all, partial
61969
62548
  all – results are based on all backlinks;
61970
62549
  partial – results are based on the intersecting backlinks only;
61971
62550
  default value: all */
@@ -62020,7 +62599,7 @@ optional field
62020
62599
  you can add several filters at once (8 filters maximum)
62021
62600
  you should set a logical operator and, or between the conditions
62022
62601
  the following operators are supported:
62023
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
62602
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
62024
62603
  you can use the % operator with like and not_like to match any string of zero or more characters
62025
62604
  example:
62026
62605
  ["1.rank",">","80"]
@@ -62078,7 +62657,7 @@ default value: true */
62078
62657
  /** indicates whether to intersect backlinks
62079
62658
  optional field
62080
62659
  use this field to intersect or merge results for the specified URLs
62081
- possible values: all, partical
62660
+ possible values: all, partial
62082
62661
  all – results are based on all backlinks;
62083
62662
  partial – results are based on the intersecting backlinks only;
62084
62663
  default value: all */
@@ -63819,11 +64398,106 @@ a page should be specified with absolute URL (including http:// or https://)
63819
64398
  you can specify up to 1000 pages, domains, or subdomains in each request.
63820
64399
  note that the URLs you set in a single request cannot belong to more than 100 different domains. */
63821
64400
  targets?: string[];
63822
- /** the maximum number of returned pages
64401
+ /** offset in the results array of returned pages
63823
64402
  optional field
63824
- default value: 100
64403
+ default value: 0
64404
+ 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 */
64405
+ offset?: number | undefined;
64406
+ /** maximum number of elements within internal arrays
64407
+ optional field
64408
+ you can use this field to limit the number of elements within the following arrays:
64409
+ referring_links_tld
64410
+ referring_links_types
64411
+ referring_links_attributes
64412
+ referring_links_platform_types
64413
+ referring_links_semantic_locations
64414
+ default value: 10
63825
64415
  maximum value: 1000 */
63826
- limit?: number | undefined;
64416
+ internal_list_limit?: number | undefined;
64417
+ /** set what backlinks to return and count
64418
+ optional field
64419
+ you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
64420
+ possible values:
64421
+ all – all backlinks will be returned and counted;
64422
+ live – backlinks found during the last check will be returned and counted;
64423
+ lost – lost backlinks will be returned and counted;
64424
+ default value: live */
64425
+ backlinks_status_type?: string | undefined;
64426
+ /** array of results filtering parameters
64427
+ optional field
64428
+ you can add several filters at once (8 filters maximum)
64429
+ you should set a logical operator and, or between the conditions
64430
+ the following operators are supported:
64431
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
64432
+ you can use the % operator with like and not_like to match any string of zero or more characters
64433
+ example:
64434
+ ["referring_links_types.anchors",">","1"]
64435
+ [["broken_pages",">","2"],
64436
+ "and",
64437
+ ["backlinks",">","10"]]
64438
+ [["first_seen",">","2017-10-23 11:31:45 +00:00"],
64439
+ "and",
64440
+ [["anchor","like","%seo%"],"or",["referring_domains",">","10"]]]
64441
+ The full list of possible filters is available here. */
64442
+ filters?: (any | undefined)[] | undefined;
64443
+ /** results sorting rules
64444
+ optional field
64445
+ you can use the same values as in the filters array to sort the results
64446
+ possible sorting types:
64447
+ asc – results will be sorted in the ascending order
64448
+ desc – results will be sorted in the descending order
64449
+ you should use a comma to set up a sorting type
64450
+ example:
64451
+ ["backlinks,desc"]
64452
+ note that you can set no more than three sorting rules in a single request
64453
+ you should use a comma to separate several sorting rules
64454
+ example:
64455
+ ["backlinks,desc","rank,asc"] */
64456
+ order_by?: string[] | undefined;
64457
+ /** filter the backlinks of your target
64458
+ optional field
64459
+ you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
64460
+ you can filter the backlinks by all fields available in the response of this endpoint
64461
+ using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
64462
+ example:
64463
+ "backlinks_filters": [["dofollow", "=", true]] */
64464
+ backlinks_filters?: (any | undefined)[] | undefined;
64465
+ /** indicates if the subdomains of the target will be included in the search
64466
+ optional field
64467
+ if set to false, the subdomains will be ignored
64468
+ default value: true */
64469
+ include_subdomains?: boolean | undefined;
64470
+ /** indicates if indirect links to the target will be included in the results
64471
+ optional field
64472
+ if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page
64473
+ if set to false, indirect links will be ignored
64474
+ default value: true */
64475
+ include_indirect_links?: boolean | undefined;
64476
+ /** indicates whether the backlinks from subdomains of the target are excluded
64477
+ optional field
64478
+ if set to false, the backlinks from subdomains of the target will be ommited and you won’t receive the same domain in the response;
64479
+ default value: true */
64480
+ exclude_internal_backlinks?: boolean | undefined;
64481
+ /** user-defined task identifier
64482
+ optional field
64483
+ the character limit is 255
64484
+ you can use this parameter to identify the task and match it with the result
64485
+ you will find the specified tag value in the data object of the response */
64486
+ tag?: string | undefined;
64487
+ [key: string]: any;
64488
+ constructor(data?: IBacklinksBulkPagesSummaryLiveRequestInfo);
64489
+ init(_data?: any): void;
64490
+ static fromJS(data: any): BacklinksBulkPagesSummaryLiveRequestInfo;
64491
+ toJSON(data?: any): any;
64492
+ }
64493
+ export interface IBacklinksBulkPagesSummaryLiveRequestInfo {
64494
+ /** domains, subdomains or webpages to get summary data for
64495
+ required field
64496
+ a domain or a subdomain should be specified without https:// and www.
64497
+ a page should be specified with absolute URL (including http:// or https://)
64498
+ you can specify up to 1000 pages, domains, or subdomains in each request.
64499
+ note that the URLs you set in a single request cannot belong to more than 100 different domains. */
64500
+ targets?: string[];
63827
64501
  /** offset in the results array of returned pages
63828
64502
  optional field
63829
64503
  default value: 0
@@ -63854,112 +64528,7 @@ optional field
63854
64528
  you can add several filters at once (8 filters maximum)
63855
64529
  you should set a logical operator and, or between the conditions
63856
64530
  the following operators are supported:
63857
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
63858
- you can use the % operator with like and not_like to match any string of zero or more characters
63859
- example:
63860
- ["referring_links_types.anchors",">","1"]
63861
- [["broken_pages",">","2"],
63862
- "and",
63863
- ["backlinks",">","10"]]
63864
- [["first_seen",">","2017-10-23 11:31:45 +00:00"],
63865
- "and",
63866
- [["anchor","like","%seo%"],"or",["referring_domains",">","10"]]]
63867
- The full list of possible filters is available here. */
63868
- filters?: (any | undefined)[] | undefined;
63869
- /** results sorting rules
63870
- optional field
63871
- you can use the same values as in the filters array to sort the results
63872
- possible sorting types:
63873
- asc – results will be sorted in the ascending order
63874
- desc – results will be sorted in the descending order
63875
- you should use a comma to set up a sorting type
63876
- example:
63877
- ["backlinks,desc"]
63878
- note that you can set no more than three sorting rules in a single request
63879
- you should use a comma to separate several sorting rules
63880
- example:
63881
- ["backlinks,desc","rank,asc"] */
63882
- order_by?: string[] | undefined;
63883
- /** filter the backlinks of your target
63884
- optional field
63885
- you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
63886
- you can filter the backlinks by all fields available in the response of this endpoint
63887
- using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
63888
- example:
63889
- "backlinks_filters": [["dofollow", "=", true]] */
63890
- backlinks_filters?: (any | undefined)[] | undefined;
63891
- /** indicates if the subdomains of the target will be included in the search
63892
- optional field
63893
- if set to false, the subdomains will be ignored
63894
- default value: true */
63895
- include_subdomains?: boolean | undefined;
63896
- /** indicates if indirect links to the target will be included in the results
63897
- optional field
63898
- if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page
63899
- if set to false, indirect links will be ignored
63900
- default value: true */
63901
- include_indirect_links?: boolean | undefined;
63902
- /** indicates whether the backlinks from subdomains of the target are excluded
63903
- optional field
63904
- if set to false, the backlinks from subdomains of the target will be ommited and you won’t receive the same domain in the response;
63905
- default value: true */
63906
- exclude_internal_backlinks?: boolean | undefined;
63907
- /** user-defined task identifier
63908
- optional field
63909
- the character limit is 255
63910
- you can use this parameter to identify the task and match it with the result
63911
- you will find the specified tag value in the data object of the response */
63912
- tag?: string | undefined;
63913
- [key: string]: any;
63914
- constructor(data?: IBacklinksBulkPagesSummaryLiveRequestInfo);
63915
- init(_data?: any): void;
63916
- static fromJS(data: any): BacklinksBulkPagesSummaryLiveRequestInfo;
63917
- toJSON(data?: any): any;
63918
- }
63919
- export interface IBacklinksBulkPagesSummaryLiveRequestInfo {
63920
- /** domains, subdomains or webpages to get summary data for
63921
- required field
63922
- a domain or a subdomain should be specified without https:// and www.
63923
- a page should be specified with absolute URL (including http:// or https://)
63924
- you can specify up to 1000 pages, domains, or subdomains in each request.
63925
- note that the URLs you set in a single request cannot belong to more than 100 different domains. */
63926
- targets?: string[];
63927
- /** the maximum number of returned pages
63928
- optional field
63929
- default value: 100
63930
- maximum value: 1000 */
63931
- limit?: number | undefined;
63932
- /** offset in the results array of returned pages
63933
- optional field
63934
- default value: 0
63935
- 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 */
63936
- offset?: number | undefined;
63937
- /** maximum number of elements within internal arrays
63938
- optional field
63939
- you can use this field to limit the number of elements within the following arrays:
63940
- referring_links_tld
63941
- referring_links_types
63942
- referring_links_attributes
63943
- referring_links_platform_types
63944
- referring_links_semantic_locations
63945
- default value: 10
63946
- maximum value: 1000 */
63947
- internal_list_limit?: number | undefined;
63948
- /** set what backlinks to return and count
63949
- optional field
63950
- you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
63951
- possible values:
63952
- all – all backlinks will be returned and counted;
63953
- live – backlinks found during the last check will be returned and counted;
63954
- lost – lost backlinks will be returned and counted;
63955
- default value: live */
63956
- backlinks_status_type?: string | undefined;
63957
- /** array of results filtering parameters
63958
- optional field
63959
- you can add several filters at once (8 filters maximum)
63960
- you should set a logical operator and, or between the conditions
63961
- the following operators are supported:
63962
- regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
64531
+ regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
63963
64532
  you can use the % operator with like and not_like to match any string of zero or more characters
63964
64533
  example:
63965
64534
  ["referring_links_types.anchors",">","1"]
@@ -65475,7 +66044,7 @@ optional field
65475
66044
  you can add several filters at once (8 filters maximum)
65476
66045
  you should set a logical operator and, or between the conditions
65477
66046
  the following operators are supported:
65478
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
66047
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
65479
66048
  you can use the % operator with like and not_like to match any string of zero or more characters
65480
66049
  example:
65481
66050
  ["meta.external_links_count","<=",50]["url","like","https://dataforseo.com/apis/dataforseo-labs-api"][["checks.high_waiting_time","=",false],
@@ -65529,7 +66098,7 @@ optional field
65529
66098
  you can add several filters at once (8 filters maximum)
65530
66099
  you should set a logical operator and, or between the conditions
65531
66100
  the following operators are supported:
65532
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
66101
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
65533
66102
  you can use the % operator with like and not_like to match any string of zero or more characters
65534
66103
  example:
65535
66104
  ["meta.external_links_count","<=",50]["url","like","https://dataforseo.com/apis/dataforseo-labs-api"][["checks.high_waiting_time","=",false],
@@ -66225,7 +66794,7 @@ optional field
66225
66794
  you can add several filters at once (8 filters maximum)
66226
66795
  you should set a logical operator and, or between the conditions
66227
66796
  the following operators are supported:
66228
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
66797
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
66229
66798
  you can use the % operator with like and not_like to match any string of zero or more characters
66230
66799
  example:
66231
66800
  ["meta.external_links_count","<=",50]["url","like","https://dataforseo.com/apis/dataforseo-labs-api"]
@@ -66288,7 +66857,7 @@ optional field
66288
66857
  you can add several filters at once (8 filters maximum)
66289
66858
  you should set a logical operator and, or between the conditions
66290
66859
  the following operators are supported:
66291
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
66860
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
66292
66861
  you can use the % operator with like and not_like to match any string of zero or more characters
66293
66862
  example:
66294
66863
  ["meta.external_links_count","<=",50]["url","like","https://dataforseo.com/apis/dataforseo-labs-api"]
@@ -66407,7 +66976,7 @@ optional field
66407
66976
  you can add several filters at once (8 filters maximum)
66408
66977
  you should set a logical operator and, or between the conditions
66409
66978
  the following operators are supported:
66410
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
66979
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
66411
66980
  you can use the % operator with like and not_like to match any string of zero or more characters
66412
66981
  example:
66413
66982
  ["resource_type","=","stylesheet"]
@@ -66423,7 +66992,7 @@ you can apply the same filters here as available for the pages endpoint
66423
66992
  you can add several filters at once (8 filters maximum)
66424
66993
  you should set a logical operator and, or between the conditions
66425
66994
  the following operators are supported:
66426
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
66995
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
66427
66996
  you can use the % operator with like and not_like to match any string of zero or more characters
66428
66997
  example:
66429
66998
  ["checks.no_image_title","=",true] */
@@ -66482,7 +67051,7 @@ optional field
66482
67051
  you can add several filters at once (8 filters maximum)
66483
67052
  you should set a logical operator and, or between the conditions
66484
67053
  the following operators are supported:
66485
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
67054
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
66486
67055
  you can use the % operator with like and not_like to match any string of zero or more characters
66487
67056
  example:
66488
67057
  ["resource_type","=","stylesheet"]
@@ -66498,7 +67067,7 @@ you can apply the same filters here as available for the pages endpoint
66498
67067
  you can add several filters at once (8 filters maximum)
66499
67068
  you should set a logical operator and, or between the conditions
66500
67069
  the following operators are supported:
66501
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
67070
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
66502
67071
  you can use the % operator with like and not_like to match any string of zero or more characters
66503
67072
  example:
66504
67073
  ["checks.no_image_title","=",true] */
@@ -67473,7 +68042,7 @@ optional field
67473
68042
  you can add several filters at once (8 filters maximum)
67474
68043
  you should set a logical operator and, or between the conditions
67475
68044
  the following operators are supported:
67476
- regex, =, <>, in, not_in, like, not_like
68045
+ regex, not_regex, =, <>, in, not_in, like, not_like
67477
68046
  you can use the % operator with like and not_like to match any string of zero or more characters
67478
68047
  example:
67479
68048
  ["direction","=","external"]
@@ -67529,7 +68098,7 @@ optional field
67529
68098
  you can add several filters at once (8 filters maximum)
67530
68099
  you should set a logical operator and, or between the conditions
67531
68100
  the following operators are supported:
67532
- regex, =, <>, in, not_in, like, not_like
68101
+ regex, not_regex, =, <>, in, not_in, like, not_like
67533
68102
  you can use the % operator with like and not_like to match any string of zero or more characters
67534
68103
  example:
67535
68104
  ["direction","=","external"]
@@ -67647,6 +68216,52 @@ status code of the page to which the link is pointing */
67647
68216
  page_to_status_code?: number | undefined;
67648
68217
  [key: string]: any;
67649
68218
  }
68219
+ export declare class OnPageLinksResultInfo implements IOnPageLinksResultInfo {
68220
+ /** status of the crawling session
68221
+ possible values: in_progress, finished */
68222
+ crawl_progress?: string | undefined;
68223
+ /** details of the crawling session */
68224
+ crawl_status?: CrawlStatusInfo | undefined;
68225
+ /** total number of relevant items in the database */
68226
+ total_items_count?: number | undefined;
68227
+ /** number of items in the results array */
68228
+ items_count?: number | undefined;
68229
+ /** items array */
68230
+ items?: (BaseOnPageLinkItemInfo | undefined)[] | undefined;
68231
+ [key: string]: any;
68232
+ constructor(data?: IOnPageLinksResultInfo);
68233
+ init(_data?: any): void;
68234
+ static fromJS(data: any): OnPageLinksResultInfo;
68235
+ toJSON(data?: any): any;
68236
+ }
68237
+ export interface IOnPageLinksResultInfo {
68238
+ /** status of the crawling session
68239
+ possible values: in_progress, finished */
68240
+ crawl_progress?: string | undefined;
68241
+ /** details of the crawling session */
68242
+ crawl_status?: CrawlStatusInfo | undefined;
68243
+ /** total number of relevant items in the database */
68244
+ total_items_count?: number | undefined;
68245
+ /** number of items in the results array */
68246
+ items_count?: number | undefined;
68247
+ /** items array */
68248
+ items?: (BaseOnPageLinkItemInfo | undefined)[] | undefined;
68249
+ [key: string]: any;
68250
+ }
68251
+ export declare class OnPageLinksTaskInfo extends BaseResponseTaskInfo implements IOnPageLinksTaskInfo {
68252
+ /** array of results */
68253
+ result?: (OnPageLinksResultInfo | undefined)[] | undefined;
68254
+ [key: string]: any;
68255
+ constructor(data?: IOnPageLinksTaskInfo);
68256
+ init(_data?: any): void;
68257
+ static fromJS(data: any): OnPageLinksTaskInfo;
68258
+ toJSON(data?: any): any;
68259
+ }
68260
+ export interface IOnPageLinksTaskInfo extends IBaseResponseTaskInfo {
68261
+ /** array of results */
68262
+ result?: (OnPageLinksResultInfo | undefined)[] | undefined;
68263
+ [key: string]: any;
68264
+ }
67650
68265
  export declare class ImageLinkElementItem extends BaseOnPageLinkItemInfo implements IImageLinkElementItem {
67651
68266
  /** referring domain
67652
68267
  the link was found on this domain */
@@ -67753,52 +68368,6 @@ status code of the page to which the link is pointing */
67753
68368
  page_to_status_code?: number | undefined;
67754
68369
  [key: string]: any;
67755
68370
  }
67756
- export declare class OnPageLinksResultInfo implements IOnPageLinksResultInfo {
67757
- /** status of the crawling session
67758
- possible values: in_progress, finished */
67759
- crawl_progress?: string | undefined;
67760
- /** details of the crawling session */
67761
- crawl_status?: CrawlStatusInfo | undefined;
67762
- /** total number of relevant items in the database */
67763
- total_items_count?: number | undefined;
67764
- /** number of items in the results array */
67765
- items_count?: number | undefined;
67766
- /** items array */
67767
- items?: (BaseOnPageLinkItemInfo | undefined)[] | undefined;
67768
- [key: string]: any;
67769
- constructor(data?: IOnPageLinksResultInfo);
67770
- init(_data?: any): void;
67771
- static fromJS(data: any): OnPageLinksResultInfo;
67772
- toJSON(data?: any): any;
67773
- }
67774
- export interface IOnPageLinksResultInfo {
67775
- /** status of the crawling session
67776
- possible values: in_progress, finished */
67777
- crawl_progress?: string | undefined;
67778
- /** details of the crawling session */
67779
- crawl_status?: CrawlStatusInfo | undefined;
67780
- /** total number of relevant items in the database */
67781
- total_items_count?: number | undefined;
67782
- /** number of items in the results array */
67783
- items_count?: number | undefined;
67784
- /** items array */
67785
- items?: (BaseOnPageLinkItemInfo | undefined)[] | undefined;
67786
- [key: string]: any;
67787
- }
67788
- export declare class OnPageLinksTaskInfo extends BaseResponseTaskInfo implements IOnPageLinksTaskInfo {
67789
- /** array of results */
67790
- result?: (OnPageLinksResultInfo | undefined)[] | undefined;
67791
- [key: string]: any;
67792
- constructor(data?: IOnPageLinksTaskInfo);
67793
- init(_data?: any): void;
67794
- static fromJS(data: any): OnPageLinksTaskInfo;
67795
- toJSON(data?: any): any;
67796
- }
67797
- export interface IOnPageLinksTaskInfo extends IBaseResponseTaskInfo {
67798
- /** array of results */
67799
- result?: (OnPageLinksResultInfo | undefined)[] | undefined;
67800
- [key: string]: any;
67801
- }
67802
68371
  export declare class AlternateLinkElementItem extends BaseOnPageLinkItemInfo implements IAlternateLinkElementItem {
67803
68372
  /** referring domain
67804
68373
  the link was found on this domain */
@@ -67925,7 +68494,7 @@ you can use only one filtering parameter with this endpoint
67925
68494
  the following filtering parameter is supported:
67926
68495
  is_redirect_loop
67927
68496
  the following operators are supported:
67928
- regex, =, <>
68497
+ regex, not_regex, =, <>
67929
68498
  examples:
67930
68499
  ["is_redirect_loop","=","true"]
67931
68500
  ["is_redirect_loop","<>","false"] */
@@ -67970,7 +68539,7 @@ you can use only one filtering parameter with this endpoint
67970
68539
  the following filtering parameter is supported:
67971
68540
  is_redirect_loop
67972
68541
  the following operators are supported:
67973
- regex, =, <>
68542
+ regex, not_regex, =, <>
67974
68543
  examples:
67975
68544
  ["is_redirect_loop","=","true"]
67976
68545
  ["is_redirect_loop","<>","false"] */
@@ -68163,7 +68732,7 @@ optional field
68163
68732
  you can add several filters at once (8 filters maximum)
68164
68733
  you should set a logical operator and, or between the conditions
68165
68734
  the following operators are supported:
68166
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
68735
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
68167
68736
  you can use the % operator with like and not_like to match any string of zero or more characters
68168
68737
  example:
68169
68738
  ["reason","=","robots_txt"][["reason","<>","robots_txt"],
@@ -68202,7 +68771,7 @@ optional field
68202
68771
  you can add several filters at once (8 filters maximum)
68203
68772
  you should set a logical operator and, or between the conditions
68204
68773
  the following operators are supported:
68205
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
68774
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
68206
68775
  you can use the % operator with like and not_like to match any string of zero or more characters
68207
68776
  example:
68208
68777
  ["reason","=","robots_txt"][["reason","<>","robots_txt"],
@@ -68495,7 +69064,7 @@ optional field
68495
69064
  you can add several filters at once (8 filters maximum)
68496
69065
  you should set a logical operator and, or between the conditions
68497
69066
  the following operators are supported:
68498
- regex, =, <>, in, not_in, like, not_like
69067
+ regex, not_regex, =, <>, in, not_in, like, not_like
68499
69068
  you can use the % operator with like and not_like to match any string of zero or more characters
68500
69069
  example:
68501
69070
  ["keyword","=","%seo%"]
@@ -68561,7 +69130,7 @@ optional field
68561
69130
  you can add several filters at once (8 filters maximum)
68562
69131
  you should set a logical operator and, or between the conditions
68563
69132
  the following operators are supported:
68564
- regex, =, <>, in, not_in, like, not_like
69133
+ regex, not_regex, =, <>, in, not_in, like, not_like
68565
69134
  you can use the % operator with like and not_like to match any string of zero or more characters
68566
69135
  example:
68567
69136
  ["keyword","=","%seo%"]
@@ -69280,7 +69849,7 @@ export declare class OnPageContentParsingRequestInfo implements IOnPageContentPa
69280
69849
  required field
69281
69850
  URL of the page to parse
69282
69851
  example:
69283
- https://www.fujielectric.com/ */
69852
+ https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api */
69284
69853
  url?: string;
69285
69854
  /** ID of the task
69286
69855
  required field
@@ -69300,7 +69869,7 @@ export interface IOnPageContentParsingRequestInfo {
69300
69869
  required field
69301
69870
  URL of the page to parse
69302
69871
  example:
69303
- https://www.fujielectric.com/ */
69872
+ https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api */
69304
69873
  url?: string;
69305
69874
  /** ID of the task
69306
69875
  required field
@@ -69311,12 +69880,32 @@ example:
69311
69880
  id?: string;
69312
69881
  [key: string]: any;
69313
69882
  }
69883
+ export declare class ContentUrlInfo implements IContentUrlInfo {
69884
+ /** other URL found in the content element */
69885
+ url?: string | undefined;
69886
+ /** text of the URL’s anchor */
69887
+ anchor_text?: string | undefined;
69888
+ [key: string]: any;
69889
+ constructor(data?: IContentUrlInfo);
69890
+ init(_data?: any): void;
69891
+ static fromJS(data: any): ContentUrlInfo;
69892
+ toJSON(data?: any): any;
69893
+ }
69894
+ export interface IContentUrlInfo {
69895
+ /** other URL found in the content element */
69896
+ url?: string | undefined;
69897
+ /** text of the URL’s anchor */
69898
+ anchor_text?: string | undefined;
69899
+ [key: string]: any;
69900
+ }
69314
69901
  export declare class ContentItemInfo implements IContentItemInfo {
69315
69902
  /** content text */
69316
69903
  text?: string | undefined;
69317
69904
  /** page URL
69318
69905
  displayed in case the text is a link anchor */
69319
69906
  url?: string | undefined;
69907
+ /** contains other URLs and anchors found in the content element */
69908
+ urls?: (ContentUrlInfo | undefined)[] | undefined;
69320
69909
  [key: string]: any;
69321
69910
  constructor(data?: IContentItemInfo);
69322
69911
  init(_data?: any): void;
@@ -69329,6 +69918,8 @@ export interface IContentItemInfo {
69329
69918
  /** page URL
69330
69919
  displayed in case the text is a link anchor */
69331
69920
  url?: string | undefined;
69921
+ /** contains other URLs and anchors found in the content element */
69922
+ urls?: (ContentUrlInfo | undefined)[] | undefined;
69332
69923
  [key: string]: any;
69333
69924
  }
69334
69925
  export declare class PageSectionContentInfo implements IPageSectionContentInfo {
@@ -69338,6 +69929,8 @@ you can find more information about content priority calculation in this help ce
69338
69929
  /** secondary content on the page
69339
69930
  you can find more information about content priority calculation in this help center article */
69340
69931
  secondary_content?: (ContentItemInfo | undefined)[] | undefined;
69932
+ /** content of the table on the page */
69933
+ table_content?: (TableContent | undefined)[] | undefined;
69341
69934
  [key: string]: any;
69342
69935
  constructor(data?: IPageSectionContentInfo);
69343
69936
  init(_data?: any): void;
@@ -69351,9 +69944,69 @@ you can find more information about content priority calculation in this help ce
69351
69944
  /** secondary content on the page
69352
69945
  you can find more information about content priority calculation in this help center article */
69353
69946
  secondary_content?: (ContentItemInfo | undefined)[] | undefined;
69947
+ /** content of the table on the page */
69948
+ table_content?: (TableContent | undefined)[] | undefined;
69949
+ [key: string]: any;
69950
+ }
69951
+ export declare class RowCellInfo implements IRowCellInfo {
69952
+ /** content text */
69953
+ text?: string | undefined;
69954
+ /** contains other URLs and anchors found in the content element */
69955
+ urls?: (ContentUrlInfo | undefined)[] | undefined;
69956
+ /** indicates if the text belongs to the header */
69957
+ is_header?: boolean | undefined;
69958
+ [key: string]: any;
69959
+ constructor(data?: IRowCellInfo);
69960
+ init(_data?: any): void;
69961
+ static fromJS(data: any): RowCellInfo;
69962
+ toJSON(data?: any): any;
69963
+ }
69964
+ export interface IRowCellInfo {
69965
+ /** content text */
69966
+ text?: string | undefined;
69967
+ /** contains other URLs and anchors found in the content element */
69968
+ urls?: (ContentUrlInfo | undefined)[] | undefined;
69969
+ /** indicates if the text belongs to the header */
69970
+ is_header?: boolean | undefined;
69354
69971
  [key: string]: any;
69355
69972
  }
69356
- export declare class TopicInfo implements ITopicInfo {
69973
+ export declare class TableContentItemInfo implements ITableContentItemInfo {
69974
+ /** content of the row cells of the header */
69975
+ row_cells?: (RowCellInfo | undefined)[] | undefined;
69976
+ [key: string]: any;
69977
+ constructor(data?: ITableContentItemInfo);
69978
+ init(_data?: any): void;
69979
+ static fromJS(data: any): TableContentItemInfo;
69980
+ toJSON(data?: any): any;
69981
+ }
69982
+ export interface ITableContentItemInfo {
69983
+ /** content of the row cells of the header */
69984
+ row_cells?: (RowCellInfo | undefined)[] | undefined;
69985
+ [key: string]: any;
69986
+ }
69987
+ export declare class TableContent implements ITableContent {
69988
+ /** content of the header of the table */
69989
+ header?: (TableContentItemInfo | undefined)[] | undefined;
69990
+ /** content of the body of the table */
69991
+ body?: (TableContentItemInfo | undefined)[] | undefined;
69992
+ /** parsed content of the footer */
69993
+ footer?: (TableContentItemInfo | undefined)[] | undefined;
69994
+ [key: string]: any;
69995
+ constructor(data?: ITableContent);
69996
+ init(_data?: any): void;
69997
+ static fromJS(data: any): TableContent;
69998
+ toJSON(data?: any): any;
69999
+ }
70000
+ export interface ITableContent {
70001
+ /** content of the header of the table */
70002
+ header?: (TableContentItemInfo | undefined)[] | undefined;
70003
+ /** content of the body of the table */
70004
+ body?: (TableContentItemInfo | undefined)[] | undefined;
70005
+ /** parsed content of the footer */
70006
+ footer?: (TableContentItemInfo | undefined)[] | undefined;
70007
+ [key: string]: any;
70008
+ }
70009
+ export declare class MainTopic implements IMainTopic {
69357
70010
  /** meta title */
69358
70011
  h_title?: string | undefined;
69359
70012
  /** main title of the block */
@@ -69363,20 +70016,22 @@ export declare class TopicInfo implements ITopicInfo {
69363
70016
  /** content language */
69364
70017
  language?: string | undefined;
69365
70018
  /** HTML level */
69366
- level?: string | undefined;
70019
+ level?: number | undefined;
69367
70020
  /** primary content on the page
69368
70021
  you can find more information about content priority calculation in this help center article */
69369
70022
  primary_content?: (ContentItemInfo | undefined)[] | undefined;
69370
70023
  /** secondary content on the page
69371
70024
  you can find more information about content priority calculation in this help center article */
69372
70025
  secondary_content?: (ContentItemInfo | undefined)[] | undefined;
70026
+ /** content of the table on the page */
70027
+ table_content?: (TableContent | undefined)[] | undefined;
69373
70028
  [key: string]: any;
69374
- constructor(data?: ITopicInfo);
70029
+ constructor(data?: IMainTopic);
69375
70030
  init(_data?: any): void;
69376
- static fromJS(data: any): TopicInfo;
70031
+ static fromJS(data: any): MainTopic;
69377
70032
  toJSON(data?: any): any;
69378
70033
  }
69379
- export interface ITopicInfo {
70034
+ export interface IMainTopic {
69380
70035
  /** meta title */
69381
70036
  h_title?: string | undefined;
69382
70037
  /** main title of the block */
@@ -69386,26 +70041,74 @@ export interface ITopicInfo {
69386
70041
  /** content language */
69387
70042
  language?: string | undefined;
69388
70043
  /** HTML level */
69389
- level?: string | undefined;
70044
+ level?: number | undefined;
69390
70045
  /** primary content on the page
69391
70046
  you can find more information about content priority calculation in this help center article */
69392
70047
  primary_content?: (ContentItemInfo | undefined)[] | undefined;
69393
70048
  /** secondary content on the page
69394
70049
  you can find more information about content priority calculation in this help center article */
69395
70050
  secondary_content?: (ContentItemInfo | undefined)[] | undefined;
70051
+ /** content of the table on the page */
70052
+ table_content?: (TableContent | undefined)[] | undefined;
70053
+ [key: string]: any;
70054
+ }
70055
+ export declare class SecondaryTopic implements ISecondaryTopic {
70056
+ /** meta title */
70057
+ h_title?: string | undefined;
70058
+ /** main title of the block */
70059
+ main_title?: string | undefined;
70060
+ /** content author name */
70061
+ author?: string | undefined;
70062
+ /** content language */
70063
+ language?: string | undefined;
70064
+ /** HTML level */
70065
+ level?: number | undefined;
70066
+ /** primary content on the page
70067
+ you can find more information about content priority calculation in this help center article */
70068
+ primary_content?: string | undefined;
70069
+ /** secondary content on the page
70070
+ you can find more information about content priority calculation in this help center article */
70071
+ secondary_content?: (ContentItemInfo | undefined)[] | undefined;
70072
+ /** content of the table on the page */
70073
+ table_content?: (TableContent | undefined)[] | undefined;
70074
+ [key: string]: any;
70075
+ constructor(data?: ISecondaryTopic);
70076
+ init(_data?: any): void;
70077
+ static fromJS(data: any): SecondaryTopic;
70078
+ toJSON(data?: any): any;
70079
+ }
70080
+ export interface ISecondaryTopic {
70081
+ /** meta title */
70082
+ h_title?: string | undefined;
70083
+ /** main title of the block */
70084
+ main_title?: string | undefined;
70085
+ /** content author name */
70086
+ author?: string | undefined;
70087
+ /** content language */
70088
+ language?: string | undefined;
70089
+ /** HTML level */
70090
+ level?: number | undefined;
70091
+ /** primary content on the page
70092
+ you can find more information about content priority calculation in this help center article */
70093
+ primary_content?: string | undefined;
70094
+ /** secondary content on the page
70095
+ you can find more information about content priority calculation in this help center article */
70096
+ secondary_content?: (ContentItemInfo | undefined)[] | undefined;
70097
+ /** content of the table on the page */
70098
+ table_content?: (TableContent | undefined)[] | undefined;
69396
70099
  [key: string]: any;
69397
70100
  }
69398
70101
  export declare class PageContentInfo implements IPageContentInfo {
69399
70102
  /** parsed content of the header */
69400
70103
  header?: PageSectionContentInfo | undefined;
69401
- /** parsed content of the footer */
70104
+ /** content of the footer of the table */
69402
70105
  footer?: PageSectionContentInfo | undefined;
69403
70106
  /** main topic on the page
69404
70107
  you can find more information about topic priority calculation in this help center article */
69405
- main_topic?: (TopicInfo | undefined)[] | undefined;
70108
+ main_topic?: (MainTopic | undefined)[] | undefined;
69406
70109
  /** secondary topic on the page
69407
70110
  you can find more information about topic priority calculation in this help center article */
69408
- secondary_topic?: (TopicInfo | undefined)[] | undefined;
70111
+ secondary_topic?: (SecondaryTopic | undefined)[] | undefined;
69409
70112
  [key: string]: any;
69410
70113
  constructor(data?: IPageContentInfo);
69411
70114
  init(_data?: any): void;
@@ -69415,14 +70118,14 @@ you can find more information about topic priority calculation in this help cent
69415
70118
  export interface IPageContentInfo {
69416
70119
  /** parsed content of the header */
69417
70120
  header?: PageSectionContentInfo | undefined;
69418
- /** parsed content of the footer */
70121
+ /** content of the footer of the table */
69419
70122
  footer?: PageSectionContentInfo | undefined;
69420
70123
  /** main topic on the page
69421
70124
  you can find more information about topic priority calculation in this help center article */
69422
- main_topic?: (TopicInfo | undefined)[] | undefined;
70125
+ main_topic?: (MainTopic | undefined)[] | undefined;
69423
70126
  /** secondary topic on the page
69424
70127
  you can find more information about topic priority calculation in this help center article */
69425
- secondary_topic?: (TopicInfo | undefined)[] | undefined;
70128
+ secondary_topic?: (SecondaryTopic | undefined)[] | undefined;
69426
70129
  [key: string]: any;
69427
70130
  }
69428
70131
  export declare class OnPageContentParsingItem implements IOnPageContentParsingItem {
@@ -69709,6 +70412,28 @@ if you use this field, enable_javascript must be set to true; */
69709
70412
  enable_xhr?: boolean | undefined;
69710
70413
  [key: string]: any;
69711
70414
  }
70415
+ export declare class RowCells implements IRowCells {
70416
+ /** content text */
70417
+ text?: string | undefined;
70418
+ /** contains other URLs and anchors found in the content element */
70419
+ urls?: any | undefined;
70420
+ /** indicates if the text belongs to the header */
70421
+ is_header?: boolean | undefined;
70422
+ [key: string]: any;
70423
+ constructor(data?: IRowCells);
70424
+ init(_data?: any): void;
70425
+ static fromJS(data: any): RowCells;
70426
+ toJSON(data?: any): any;
70427
+ }
70428
+ export interface IRowCells {
70429
+ /** content text */
70430
+ text?: string | undefined;
70431
+ /** contains other URLs and anchors found in the content element */
70432
+ urls?: any | undefined;
70433
+ /** indicates if the text belongs to the header */
70434
+ is_header?: boolean | undefined;
70435
+ [key: string]: any;
70436
+ }
69712
70437
  export declare class OnPageContentParsingLiveResultInfo implements IOnPageContentParsingLiveResultInfo {
69713
70438
  /** status of the crawling session
69714
70439
  possible values: in_progress, finished */
@@ -71082,7 +71807,7 @@ optional field
71082
71807
  you can add several filters at once (8 filters maximum)
71083
71808
  you should set a logical operator and, or between the conditions
71084
71809
  the following operators are supported:
71085
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
71810
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
71086
71811
  you can use the % operator with like and not_like to match any string of zero or more characters
71087
71812
  example:
71088
71813
  ["country","=", "US"]
@@ -71182,7 +71907,7 @@ optional field
71182
71907
  you can add several filters at once (8 filters maximum)
71183
71908
  you should set a logical operator and, or between the conditions
71184
71909
  the following operators are supported:
71185
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
71910
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
71186
71911
  you can use the % operator with like and not_like to match any string of zero or more characters
71187
71912
  example:
71188
71913
  ["country","=", "US"]
@@ -71451,7 +72176,7 @@ to obtain a full list of available categories, refer to the Categories endpoint
71451
72176
  page_types?: string[] | undefined;
71452
72177
  /** ratings found on the page
71453
72178
  all ratings found on the page based on microdata */
71454
- ratings?: any | undefined;
72179
+ ratings?: (RatingInfo | undefined)[] | undefined;
71455
72180
  /** social media engagement metrics
71456
72181
  data on social media interactions associated with the content based on website embeds developed and supported by social media platforms */
71457
72182
  social_metrics?: (SocialMetricsInfo | undefined)[] | undefined;
@@ -71509,7 +72234,7 @@ to obtain a full list of available categories, refer to the Categories endpoint
71509
72234
  page_types?: string[] | undefined;
71510
72235
  /** ratings found on the page
71511
72236
  all ratings found on the page based on microdata */
71512
- ratings?: any | undefined;
72237
+ ratings?: (RatingInfo | undefined)[] | undefined;
71513
72238
  /** social media engagement metrics
71514
72239
  data on social media interactions associated with the content based on website embeds developed and supported by social media platforms */
71515
72240
  social_metrics?: (SocialMetricsInfo | undefined)[] | undefined;
@@ -71636,7 +72361,7 @@ optional field
71636
72361
  you can add several filters at once (8 filters maximum)
71637
72362
  you should set a logical operator and, or between the conditions
71638
72363
  the following operators are supported:
71639
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
72364
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
71640
72365
  you can use the % operator with like and not_like to match any string of zero or more characters
71641
72366
  example:
71642
72367
  ["domain","<>", "logitech.com"]
@@ -71721,7 +72446,7 @@ optional field
71721
72446
  you can add several filters at once (8 filters maximum)
71722
72447
  you should set a logical operator and, or between the conditions
71723
72448
  the following operators are supported:
71724
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
72449
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
71725
72450
  you can use the % operator with like and not_like to match any string of zero or more characters
71726
72451
  example:
71727
72452
  ["domain","<>", "logitech.com"]
@@ -71933,7 +72658,7 @@ optional field
71933
72658
  you can add several filters at once (8 filters maximum)
71934
72659
  you should set a logical operator and, or between the conditions
71935
72660
  the following operators are supported:
71936
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
72661
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
71937
72662
  you can use the % operator with like and not_like to match any string of zero or more characters
71938
72663
  example:
71939
72664
  ["domain","<>", "logitech.com"]
@@ -72017,7 +72742,7 @@ optional field
72017
72742
  you can add several filters at once (8 filters maximum)
72018
72743
  you should set a logical operator and, or between the conditions
72019
72744
  the following operators are supported:
72020
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
72745
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
72021
72746
  you can use the % operator with like and not_like to match any string of zero or more characters
72022
72747
  example:
72023
72748
  ["domain","<>", "logitech.com"]
@@ -72200,7 +72925,7 @@ optional field
72200
72925
  you can add several filters at once (8 filters maximum)
72201
72926
  you should set a logical operator and, or between the conditions
72202
72927
  the following operators are supported:
72203
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
72928
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
72204
72929
  you can use the % operator with like and not_like to match any string of zero or more characters
72205
72930
  example:
72206
72931
  ["domain","<>", "logitech.com"]
@@ -72291,7 +73016,7 @@ optional field
72291
73016
  you can add several filters at once (8 filters maximum)
72292
73017
  you should set a logical operator and, or between the conditions
72293
73018
  the following operators are supported:
72294
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
73019
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
72295
73020
  you can use the % operator with like and not_like to match any string of zero or more characters
72296
73021
  example:
72297
73022
  ["domain","<>", "logitech.com"]
@@ -72436,7 +73161,7 @@ optional field
72436
73161
  you can add several filters at once (8 filters maximum)
72437
73162
  you should set a logical operator and, or between the conditions
72438
73163
  the following operators are supported:
72439
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
73164
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
72440
73165
  you can use the % operator with like and not_like to match any string of zero or more characters
72441
73166
  example:
72442
73167
  ["domain","<>", "logitech.com"]
@@ -72531,7 +73256,7 @@ optional field
72531
73256
  you can add several filters at once (8 filters maximum)
72532
73257
  you should set a logical operator and, or between the conditions
72533
73258
  the following operators are supported:
72534
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
73259
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
72535
73260
  you can use the % operator with like and not_like to match any string of zero or more characters
72536
73261
  example:
72537
73262
  ["domain","<>", "logitech.com"]
@@ -72739,7 +73464,7 @@ optional field
72739
73464
  you can add several filters at once (8 filters maximum)
72740
73465
  you should set a logical operator and, or between the conditions
72741
73466
  the following operators are supported:
72742
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
73467
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
72743
73468
  you can use the % operator with like and not_like to match any string of zero or more characters
72744
73469
  example:
72745
73470
  ["domain","<>", "logitech.com"]
@@ -72815,7 +73540,7 @@ optional field
72815
73540
  you can add several filters at once (8 filters maximum)
72816
73541
  you should set a logical operator and, or between the conditions
72817
73542
  the following operators are supported:
72818
- regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
73543
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
72819
73544
  you can use the % operator with like and not_like to match any string of zero or more characters
72820
73545
  example:
72821
73546
  ["domain","<>", "logitech.com"]
@@ -82857,7 +83582,7 @@ optional field
82857
83582
  you can add several filters at once (8 filters maximum)
82858
83583
  you should set a logical operator and, or between the conditions
82859
83584
  the following operators are supported:
82860
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
83585
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
82861
83586
  you can use the % operator with like and not_like to match any string of zero or more characters
82862
83587
  example:
82863
83588
  ["item.rating.value",">",3]
@@ -82929,7 +83654,7 @@ optional field
82929
83654
  you can add several filters at once (8 filters maximum)
82930
83655
  you should set a logical operator and, or between the conditions
82931
83656
  the following operators are supported:
82932
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
83657
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
82933
83658
  you can use the % operator with like and not_like to match any string of zero or more characters
82934
83659
  example:
82935
83660
  ["item.rating.value",">",3]
@@ -84989,7 +85714,7 @@ optional field
84989
85714
  you can add several filters at once (8 filters maximum)
84990
85715
  you should set a logical operator and, or between the conditions
84991
85716
  the following operators are supported:
84992
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
85717
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
84993
85718
  you can use the % operator with like and not_like to match any string of zero or more characters
84994
85719
  example:
84995
85720
  ["rating.value",">",3]
@@ -85061,7 +85786,7 @@ optional field
85061
85786
  you can add several filters at once (8 filters maximum)
85062
85787
  you should set a logical operator and, or between the conditions
85063
85788
  the following operators are supported:
85064
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
85789
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
85065
85790
  you can use the % operator with like and not_like to match any string of zero or more characters
85066
85791
  example:
85067
85792
  ["rating.value",">",3]
@@ -85669,7 +86394,7 @@ optional field
85669
86394
  you can add several filters at once (8 filters maximum)
85670
86395
  you should set a logical operator and, or between the conditions
85671
86396
  the following operators are supported:
85672
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
86397
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
85673
86398
  you can use the % operator with like and not_like to match any string of zero or more characters
85674
86399
  example:
85675
86400
  ["rating.value",">",3]
@@ -85752,7 +86477,7 @@ optional field
85752
86477
  you can add several filters at once (8 filters maximum)
85753
86478
  you should set a logical operator and, or between the conditions
85754
86479
  the following operators are supported:
85755
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
86480
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
85756
86481
  you can use the % operator with like and not_like to match any string of zero or more characters
85757
86482
  example:
85758
86483
  ["rating.value",">",3]
@@ -86020,6 +86745,14 @@ example:
86020
86745
  /** the element’s rating
86021
86746
  the popularity rate based on reviews and displayed in SERP */
86022
86747
  rating?: RatingInfo | undefined;
86748
+ /** hotel class rating
86749
+ class ratings range between 1-5 stars, learn more
86750
+ if there is no hotel class rating information, the value will be null */
86751
+ hotel_rating?: number | undefined;
86752
+ /** property price level
86753
+ can take values: inexpensive, moderate, expensive, very_expensive
86754
+ if there is no price level information, the value will be null */
86755
+ price_level?: string | undefined;
86023
86756
  /** the distribution of ratings of the business entity
86024
86757
  the object displays the number of 1-star to 5-star ratings, as reviewed by users */
86025
86758
  rating_distribution?: {
@@ -86033,8 +86766,6 @@ information related to operational hours of the business entity */
86033
86766
  /** popular times
86034
86767
  information related to busy hours of the business entity */
86035
86768
  popular_times?: PopularTimes | undefined;
86036
- /** available interactions with the business
86037
- list of options to interact with the business directly from search results */
86038
86769
  local_business_links?: (BaseLocalBusinessLink | undefined)[] | undefined;
86039
86770
  /** available contacts of the business
86040
86771
  list of contacts to interact with the business */
@@ -86126,6 +86857,14 @@ example:
86126
86857
  /** the element’s rating
86127
86858
  the popularity rate based on reviews and displayed in SERP */
86128
86859
  rating?: RatingInfo | undefined;
86860
+ /** hotel class rating
86861
+ class ratings range between 1-5 stars, learn more
86862
+ if there is no hotel class rating information, the value will be null */
86863
+ hotel_rating?: number | undefined;
86864
+ /** property price level
86865
+ can take values: inexpensive, moderate, expensive, very_expensive
86866
+ if there is no price level information, the value will be null */
86867
+ price_level?: string | undefined;
86129
86868
  /** the distribution of ratings of the business entity
86130
86869
  the object displays the number of 1-star to 5-star ratings, as reviewed by users */
86131
86870
  rating_distribution?: {
@@ -86139,8 +86878,6 @@ information related to operational hours of the business entity */
86139
86878
  /** popular times
86140
86879
  information related to busy hours of the business entity */
86141
86880
  popular_times?: PopularTimes | undefined;
86142
- /** available interactions with the business
86143
- list of options to interact with the business directly from search results */
86144
86881
  local_business_links?: (BaseLocalBusinessLink | undefined)[] | undefined;
86145
86882
  /** available contacts of the business
86146
86883
  list of contacts to interact with the business */
@@ -86257,7 +86994,7 @@ optional field
86257
86994
  you can add several filters at once (8 filters maximum)
86258
86995
  you should set a logical operator and, or between the conditions
86259
86996
  the following operators are supported:
86260
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
86997
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
86261
86998
  you can use the % operator with like and not_like to match any string of zero or more characters
86262
86999
  example:
86263
87000
  ["rating.value",">",3]
@@ -86322,7 +87059,7 @@ optional field
86322
87059
  you can add several filters at once (8 filters maximum)
86323
87060
  you should set a logical operator and, or between the conditions
86324
87061
  the following operators are supported:
86325
- regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
87062
+ regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
86326
87063
  you can use the % operator with like and not_like to match any string of zero or more characters
86327
87064
  example:
86328
87065
  ["rating.value",">",3]
@@ -86714,6 +87451,7 @@ unique task identifier in our system in the UUID format */
86714
87451
  /** search engine specified when setting the task
86715
87452
  can take the following values: google */
86716
87453
  se?: string | undefined;
87454
+ se_type?: string | undefined;
86717
87455
  /** date when the task was posted (in the UTC format) */
86718
87456
  date_posted?: string | undefined;
86719
87457
  /** user-defined task identifier */
@@ -86733,6 +87471,7 @@ unique task identifier in our system in the UUID format */
86733
87471
  /** search engine specified when setting the task
86734
87472
  can take the following values: google */
86735
87473
  se?: string | undefined;
87474
+ se_type?: string | undefined;
86736
87475
  /** date when the task was posted (in the UTC format) */
86737
87476
  date_posted?: string | undefined;
86738
87477
  /** user-defined task identifier */
@@ -87032,6 +87771,7 @@ example:
87032
87771
  longitude?: number | undefined;
87033
87772
  /** shows whether the entity is verified by its owner on Google Maps */
87034
87773
  is_claimed?: boolean | undefined;
87774
+ questions_and_answers_count?: number | undefined;
87035
87775
  /** service details in a form of user-reviewed checks;
87036
87776
  service details of a business entity displayed in a form of checks and based on user feedback and business category */
87037
87777
  attributes?: BusinessDataAttributesInfo | undefined;
@@ -87151,6 +87891,7 @@ example:
87151
87891
  longitude?: number | undefined;
87152
87892
  /** shows whether the entity is verified by its owner on Google Maps */
87153
87893
  is_claimed?: boolean | undefined;
87894
+ questions_and_answers_count?: number | undefined;
87154
87895
  /** service details in a form of user-reviewed checks;
87155
87896
  service details of a business entity displayed in a form of checks and based on user feedback and business category */
87156
87897
  attributes?: BusinessDataAttributesInfo | undefined;
@@ -87360,6 +88101,7 @@ unique task identifier in our system in the UUID format */
87360
88101
  /** search engine specified when setting the task
87361
88102
  can take the following values: google */
87362
88103
  se?: string | undefined;
88104
+ se_type?: string | undefined;
87363
88105
  /** date when the task was posted (in the UTC format) */
87364
88106
  date_posted?: string | undefined;
87365
88107
  /** user-defined task identifier */
@@ -87379,6 +88121,7 @@ unique task identifier in our system in the UUID format */
87379
88121
  /** search engine specified when setting the task
87380
88122
  can take the following values: google */
87381
88123
  se?: string | undefined;
88124
+ se_type?: string | undefined;
87382
88125
  /** date when the task was posted (in the UTC format) */
87383
88126
  date_posted?: string | undefined;
87384
88127
  /** user-defined task identifier */
@@ -87898,6 +88641,7 @@ unique task identifier in our system in the UUID format */
87898
88641
  /** search engine specified when setting the task
87899
88642
  can take the following values: google */
87900
88643
  se?: string | undefined;
88644
+ se_type?: string | undefined;
87901
88645
  /** date when the task was posted (in the UTC format) */
87902
88646
  date_posted?: string | undefined;
87903
88647
  /** user-defined task identifier */
@@ -87917,6 +88661,7 @@ unique task identifier in our system in the UUID format */
87917
88661
  /** search engine specified when setting the task
87918
88662
  can take the following values: google */
87919
88663
  se?: string | undefined;
88664
+ se_type?: string | undefined;
87920
88665
  /** date when the task was posted (in the UTC format) */
87921
88666
  date_posted?: string | undefined;
87922
88667
  /** user-defined task identifier */
@@ -88878,6 +89623,7 @@ unique task identifier in our system in the UUID format */
88878
89623
  /** search engine specified when setting the task
88879
89624
  can take the following values: google */
88880
89625
  se?: string | undefined;
89626
+ se_type?: string | undefined;
88881
89627
  /** date when the task was posted (in the UTC format) */
88882
89628
  date_posted?: string | undefined;
88883
89629
  /** user-defined task identifier */
@@ -88899,6 +89645,7 @@ unique task identifier in our system in the UUID format */
88899
89645
  /** search engine specified when setting the task
88900
89646
  can take the following values: google */
88901
89647
  se?: string | undefined;
89648
+ se_type?: string | undefined;
88902
89649
  /** date when the task was posted (in the UTC format) */
88903
89650
  date_posted?: string | undefined;
88904
89651
  /** user-defined task identifier */
@@ -90589,6 +91336,688 @@ export interface IBusinessDataGoogleReviewsTaskGetResponseInfo extends IBaseResp
90589
91336
  tasks?: (BusinessDataGoogleReviewsTaskGetTaskInfo | undefined)[] | undefined;
90590
91337
  [key: string]: any;
90591
91338
  }
91339
+ export declare class BusinessDataGoogleQuestionsAndAnswersTaskPostRequestInfo extends BusinessDataTaskRequestInfo implements IBusinessDataGoogleQuestionsAndAnswersTaskPostRequestInfo {
91340
+ /** parsing depth
91341
+ optional field
91342
+ number of question rows in the result
91343
+ default value: 20
91344
+ max value: 700
91345
+ Note: your account will be billed for every 20 questions;
91346
+ thus, setting a depth above 20 may result in additional charges if the search engine returns more than 20 questions;
91347
+ if the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance */
91348
+ depth?: number | undefined;
91349
+ [key: string]: any;
91350
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersTaskPostRequestInfo);
91351
+ init(_data?: any): void;
91352
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersTaskPostRequestInfo;
91353
+ toJSON(data?: any): any;
91354
+ }
91355
+ export interface IBusinessDataGoogleQuestionsAndAnswersTaskPostRequestInfo extends IBusinessDataTaskRequestInfo {
91356
+ /** parsing depth
91357
+ optional field
91358
+ number of question rows in the result
91359
+ default value: 20
91360
+ max value: 700
91361
+ Note: your account will be billed for every 20 questions;
91362
+ thus, setting a depth above 20 may result in additional charges if the search engine returns more than 20 questions;
91363
+ if the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance */
91364
+ depth?: number | undefined;
91365
+ [key: string]: any;
91366
+ }
91367
+ export declare class BusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo extends BaseResponseTaskInfo implements IBusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo {
91368
+ /** array of results
91369
+ in this case, the value will be null */
91370
+ result?: any | undefined;
91371
+ [key: string]: any;
91372
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo);
91373
+ init(_data?: any): void;
91374
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo;
91375
+ toJSON(data?: any): any;
91376
+ }
91377
+ export interface IBusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo extends IBaseResponseTaskInfo {
91378
+ /** array of results
91379
+ in this case, the value will be null */
91380
+ result?: any | undefined;
91381
+ [key: string]: any;
91382
+ }
91383
+ export declare class BusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo extends BaseResponseInfo implements IBusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo {
91384
+ /** array of tasks */
91385
+ tasks?: (BusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo | undefined)[] | undefined;
91386
+ [key: string]: any;
91387
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo);
91388
+ init(_data?: any): void;
91389
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo;
91390
+ toJSON(data?: any): any;
91391
+ }
91392
+ export interface IBusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo extends IBaseResponseInfo {
91393
+ /** array of tasks */
91394
+ tasks?: (BusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo | undefined)[] | undefined;
91395
+ [key: string]: any;
91396
+ }
91397
+ export declare class BusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo implements IBusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo {
91398
+ /** task identifier of the completed task
91399
+ unique task identifier in our system in the UUID format */
91400
+ id?: string | undefined;
91401
+ /** search engine specified when setting the task
91402
+ can take the following values: google */
91403
+ se?: string | undefined;
91404
+ se_type?: string | undefined;
91405
+ /** date when the task was posted (in the UTC format) */
91406
+ date_posted?: string | undefined;
91407
+ /** user-defined task identifier */
91408
+ tag?: string | undefined;
91409
+ /** URL for collecting the results of the task */
91410
+ endpoint?: string | undefined;
91411
+ [key: string]: any;
91412
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo);
91413
+ init(_data?: any): void;
91414
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo;
91415
+ toJSON(data?: any): any;
91416
+ }
91417
+ export interface IBusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo {
91418
+ /** task identifier of the completed task
91419
+ unique task identifier in our system in the UUID format */
91420
+ id?: string | undefined;
91421
+ /** search engine specified when setting the task
91422
+ can take the following values: google */
91423
+ se?: string | undefined;
91424
+ se_type?: string | undefined;
91425
+ /** date when the task was posted (in the UTC format) */
91426
+ date_posted?: string | undefined;
91427
+ /** user-defined task identifier */
91428
+ tag?: string | undefined;
91429
+ /** URL for collecting the results of the task */
91430
+ endpoint?: string | undefined;
91431
+ [key: string]: any;
91432
+ }
91433
+ export declare class BusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo extends BaseResponseTaskInfo implements IBusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo {
91434
+ /** array of results */
91435
+ result?: (BusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo | undefined)[] | undefined;
91436
+ [key: string]: any;
91437
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo);
91438
+ init(_data?: any): void;
91439
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo;
91440
+ toJSON(data?: any): any;
91441
+ }
91442
+ export interface IBusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo extends IBaseResponseTaskInfo {
91443
+ /** array of results */
91444
+ result?: (BusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo | undefined)[] | undefined;
91445
+ [key: string]: any;
91446
+ }
91447
+ export declare class BusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo extends BaseResponseInfo implements IBusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo {
91448
+ /** array of tasks */
91449
+ tasks?: (BusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo | undefined)[] | undefined;
91450
+ [key: string]: any;
91451
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo);
91452
+ init(_data?: any): void;
91453
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo;
91454
+ toJSON(data?: any): any;
91455
+ }
91456
+ export interface IBusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo extends IBaseResponseInfo {
91457
+ /** array of tasks */
91458
+ tasks?: (BusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo | undefined)[] | undefined;
91459
+ [key: string]: any;
91460
+ }
91461
+ export declare class ItemsWithoutAnswers implements IItemsWithoutAnswers {
91462
+ /** type of element */
91463
+ type?: string | undefined;
91464
+ /** position within a group of elements with identical type values
91465
+ positions of elements with different type values are omitted from rank_group */
91466
+ rank_group?: number | undefined;
91467
+ /** absolute rank among all the elements */
91468
+ rank_absolute?: number | undefined;
91469
+ /** ID of the question */
91470
+ question_id?: string | undefined;
91471
+ /** URL of the question */
91472
+ url?: string | undefined;
91473
+ /** URL of the user’s profile image */
91474
+ profile_image_url?: string | undefined;
91475
+ /** URL of the user’s profile */
91476
+ profile_url?: string | undefined;
91477
+ /** displayed name of the user */
91478
+ profile_name?: string | undefined;
91479
+ /** current text of the question */
91480
+ question_text?: string | undefined;
91481
+ /** original text of the question */
91482
+ original_question_text?: string | undefined;
91483
+ /** estimated time when the question was posted */
91484
+ time_ago?: string | undefined;
91485
+ /** exact time when the question was posted */
91486
+ timestamp?: string | undefined;
91487
+ /** array of items
91488
+ items within google_business_question_item */
91489
+ items?: GoogleBusinessAnswerElement | undefined;
91490
+ [key: string]: any;
91491
+ constructor(data?: IItemsWithoutAnswers);
91492
+ init(_data?: any): void;
91493
+ static fromJS(data: any): ItemsWithoutAnswers;
91494
+ toJSON(data?: any): any;
91495
+ }
91496
+ export interface IItemsWithoutAnswers {
91497
+ /** type of element */
91498
+ type?: string | undefined;
91499
+ /** position within a group of elements with identical type values
91500
+ positions of elements with different type values are omitted from rank_group */
91501
+ rank_group?: number | undefined;
91502
+ /** absolute rank among all the elements */
91503
+ rank_absolute?: number | undefined;
91504
+ /** ID of the question */
91505
+ question_id?: string | undefined;
91506
+ /** URL of the question */
91507
+ url?: string | undefined;
91508
+ /** URL of the user’s profile image */
91509
+ profile_image_url?: string | undefined;
91510
+ /** URL of the user’s profile */
91511
+ profile_url?: string | undefined;
91512
+ /** displayed name of the user */
91513
+ profile_name?: string | undefined;
91514
+ /** current text of the question */
91515
+ question_text?: string | undefined;
91516
+ /** original text of the question */
91517
+ original_question_text?: string | undefined;
91518
+ /** estimated time when the question was posted */
91519
+ time_ago?: string | undefined;
91520
+ /** exact time when the question was posted */
91521
+ timestamp?: string | undefined;
91522
+ /** array of items
91523
+ items within google_business_question_item */
91524
+ items?: GoogleBusinessAnswerElement | undefined;
91525
+ [key: string]: any;
91526
+ }
91527
+ export declare class GoogleBusinessAnswerElement implements IGoogleBusinessAnswerElement {
91528
+ /** type of element */
91529
+ type?: string | undefined;
91530
+ /** ID of the answer */
91531
+ answer_id?: string | undefined;
91532
+ /** URL of the user’s profile image */
91533
+ profile_image_url?: string | undefined;
91534
+ /** URL of the user’s profile */
91535
+ profile_url?: string | undefined;
91536
+ /** displayed name of the user */
91537
+ profile_name?: string | undefined;
91538
+ /** current text of the answer */
91539
+ answer_text?: string | undefined;
91540
+ /** original text of the answer */
91541
+ original_answer_text?: string | undefined;
91542
+ /** estimated time when the answer was posted */
91543
+ time_ago?: string | undefined;
91544
+ /** exact time when the answer was posted */
91545
+ timestamp?: string | undefined;
91546
+ [key: string]: any;
91547
+ constructor(data?: IGoogleBusinessAnswerElement);
91548
+ init(_data?: any): void;
91549
+ static fromJS(data: any): GoogleBusinessAnswerElement;
91550
+ toJSON(data?: any): any;
91551
+ }
91552
+ export interface IGoogleBusinessAnswerElement {
91553
+ /** type of element */
91554
+ type?: string | undefined;
91555
+ /** ID of the answer */
91556
+ answer_id?: string | undefined;
91557
+ /** URL of the user’s profile image */
91558
+ profile_image_url?: string | undefined;
91559
+ /** URL of the user’s profile */
91560
+ profile_url?: string | undefined;
91561
+ /** displayed name of the user */
91562
+ profile_name?: string | undefined;
91563
+ /** current text of the answer */
91564
+ answer_text?: string | undefined;
91565
+ /** original text of the answer */
91566
+ original_answer_text?: string | undefined;
91567
+ /** estimated time when the answer was posted */
91568
+ time_ago?: string | undefined;
91569
+ /** exact time when the answer was posted */
91570
+ timestamp?: string | undefined;
91571
+ [key: string]: any;
91572
+ }
91573
+ export declare class BusinessDataGoogleQuestionsAndAnswersItem implements IBusinessDataGoogleQuestionsAndAnswersItem {
91574
+ /** type of element */
91575
+ type?: string | undefined;
91576
+ /** position within a group of elements with identical type values
91577
+ positions of elements with different type values are omitted from rank_group */
91578
+ rank_group?: number | undefined;
91579
+ /** absolute rank among all the elements */
91580
+ rank_absolute?: number | undefined;
91581
+ /** ID of the question */
91582
+ question_id?: string | undefined;
91583
+ /** URL of the question */
91584
+ url?: string | undefined;
91585
+ /** URL of the user’s profile image */
91586
+ profile_image_url?: string | undefined;
91587
+ /** URL of the user’s profile */
91588
+ profile_url?: string | undefined;
91589
+ /** displayed name of the user */
91590
+ profile_name?: string | undefined;
91591
+ /** current text of the question */
91592
+ question_text?: string | undefined;
91593
+ /** original text of the question */
91594
+ original_question_text?: string | undefined;
91595
+ /** estimated time when the question was posted */
91596
+ time_ago?: string | undefined;
91597
+ /** exact time when the question was posted */
91598
+ timestamp?: string | undefined;
91599
+ /** array of google business question items with answers
91600
+ possible item types: google_business_question_item */
91601
+ items?: (GoogleBusinessAnswerElement | undefined)[] | undefined;
91602
+ [key: string]: any;
91603
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersItem);
91604
+ init(_data?: any): void;
91605
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersItem;
91606
+ toJSON(data?: any): any;
91607
+ }
91608
+ export interface IBusinessDataGoogleQuestionsAndAnswersItem {
91609
+ /** type of element */
91610
+ type?: string | undefined;
91611
+ /** position within a group of elements with identical type values
91612
+ positions of elements with different type values are omitted from rank_group */
91613
+ rank_group?: number | undefined;
91614
+ /** absolute rank among all the elements */
91615
+ rank_absolute?: number | undefined;
91616
+ /** ID of the question */
91617
+ question_id?: string | undefined;
91618
+ /** URL of the question */
91619
+ url?: string | undefined;
91620
+ /** URL of the user’s profile image */
91621
+ profile_image_url?: string | undefined;
91622
+ /** URL of the user’s profile */
91623
+ profile_url?: string | undefined;
91624
+ /** displayed name of the user */
91625
+ profile_name?: string | undefined;
91626
+ /** current text of the question */
91627
+ question_text?: string | undefined;
91628
+ /** original text of the question */
91629
+ original_question_text?: string | undefined;
91630
+ /** estimated time when the question was posted */
91631
+ time_ago?: string | undefined;
91632
+ /** exact time when the question was posted */
91633
+ timestamp?: string | undefined;
91634
+ /** array of google business question items with answers
91635
+ possible item types: google_business_question_item */
91636
+ items?: (GoogleBusinessAnswerElement | undefined)[] | undefined;
91637
+ [key: string]: any;
91638
+ }
91639
+ export declare class BusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo implements IBusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo {
91640
+ /** keyword received in a POST array
91641
+ keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
91642
+ this field will contain the cid parameter if you specified it in the keyword field when setting a task;
91643
+ example:
91644
+ cid:2946633002421908862
91645
+ learn more about the parameter in this help center article */
91646
+ keyword?: string | undefined;
91647
+ /** search engine domain as specified in a POST array */
91648
+ se_domain?: string | undefined;
91649
+ /** location code in a POST array */
91650
+ location_code?: number | undefined;
91651
+ /** language code in a POST array */
91652
+ language_code?: string | undefined;
91653
+ /** direct URL to search engine results
91654
+ you can use it to make sure that we provided accurate results */
91655
+ check_url?: string | undefined;
91656
+ /** date and time when the result was received
91657
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
91658
+ example:
91659
+ 2019-11-15 12:57:46 +00:00 */
91660
+ datetime?: string | undefined;
91661
+ /** google-defined client id
91662
+ unique id of a local establishment;
91663
+ learn more about the identifier in this help center article */
91664
+ cid?: string | undefined;
91665
+ /** unique identifier of the SERP feature */
91666
+ feature_id?: string | undefined;
91667
+ /** item types
91668
+ types of search engine results encountered in the items array;
91669
+ possible item types: google_business_question_item */
91670
+ item_types?: (string | undefined)[] | undefined;
91671
+ /** array of google business question items without answers */
91672
+ items_without_answers?: (ItemsWithoutAnswers | undefined)[] | undefined;
91673
+ /** the number of items in the items array */
91674
+ items_count?: number | undefined;
91675
+ /** array of items within google_business_question_item
91676
+ contains answers to the google business questions;
91677
+ the maximum number of answers returned for each question: 5
91678
+ possible item types google_business_answer_element */
91679
+ items?: (BusinessDataGoogleQuestionsAndAnswersItem | undefined)[] | undefined;
91680
+ [key: string]: any;
91681
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo);
91682
+ init(_data?: any): void;
91683
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo;
91684
+ toJSON(data?: any): any;
91685
+ }
91686
+ export interface IBusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo {
91687
+ /** keyword received in a POST array
91688
+ keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
91689
+ this field will contain the cid parameter if you specified it in the keyword field when setting a task;
91690
+ example:
91691
+ cid:2946633002421908862
91692
+ learn more about the parameter in this help center article */
91693
+ keyword?: string | undefined;
91694
+ /** search engine domain as specified in a POST array */
91695
+ se_domain?: string | undefined;
91696
+ /** location code in a POST array */
91697
+ location_code?: number | undefined;
91698
+ /** language code in a POST array */
91699
+ language_code?: string | undefined;
91700
+ /** direct URL to search engine results
91701
+ you can use it to make sure that we provided accurate results */
91702
+ check_url?: string | undefined;
91703
+ /** date and time when the result was received
91704
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
91705
+ example:
91706
+ 2019-11-15 12:57:46 +00:00 */
91707
+ datetime?: string | undefined;
91708
+ /** google-defined client id
91709
+ unique id of a local establishment;
91710
+ learn more about the identifier in this help center article */
91711
+ cid?: string | undefined;
91712
+ /** unique identifier of the SERP feature */
91713
+ feature_id?: string | undefined;
91714
+ /** item types
91715
+ types of search engine results encountered in the items array;
91716
+ possible item types: google_business_question_item */
91717
+ item_types?: (string | undefined)[] | undefined;
91718
+ /** array of google business question items without answers */
91719
+ items_without_answers?: (ItemsWithoutAnswers | undefined)[] | undefined;
91720
+ /** the number of items in the items array */
91721
+ items_count?: number | undefined;
91722
+ /** array of items within google_business_question_item
91723
+ contains answers to the google business questions;
91724
+ the maximum number of answers returned for each question: 5
91725
+ possible item types google_business_answer_element */
91726
+ items?: (BusinessDataGoogleQuestionsAndAnswersItem | undefined)[] | undefined;
91727
+ [key: string]: any;
91728
+ }
91729
+ export declare class BusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo extends BaseResponseTaskInfo implements IBusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo {
91730
+ /** array of results */
91731
+ result?: (BusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo | undefined)[] | undefined;
91732
+ [key: string]: any;
91733
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo);
91734
+ init(_data?: any): void;
91735
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo;
91736
+ toJSON(data?: any): any;
91737
+ }
91738
+ export interface IBusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo extends IBaseResponseTaskInfo {
91739
+ /** array of results */
91740
+ result?: (BusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo | undefined)[] | undefined;
91741
+ [key: string]: any;
91742
+ }
91743
+ export declare class BusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo extends BaseResponseInfo implements IBusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo {
91744
+ /** array of tasks */
91745
+ tasks?: (BusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo | undefined)[] | undefined;
91746
+ [key: string]: any;
91747
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo);
91748
+ init(_data?: any): void;
91749
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo;
91750
+ toJSON(data?: any): any;
91751
+ }
91752
+ export interface IBusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo extends IBaseResponseInfo {
91753
+ /** array of tasks */
91754
+ tasks?: (BusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo | undefined)[] | undefined;
91755
+ [key: string]: any;
91756
+ }
91757
+ export declare class BusinessDataGoogleQuestionsAndAnswersLiveRequestInfo implements IBusinessDataGoogleQuestionsAndAnswersLiveRequestInfo {
91758
+ /** keyword
91759
+ required field
91760
+ the keyword you specify should indicate the name of the local establishment
91761
+ you can specify up to 700 symbols in the keyword filed
91762
+ all %## will be decoded (plus symbol ‘+’ will be decoded to a space character)
91763
+ if you need to use the “%” symbol for your keyword, please specify it as “%25”;
91764
+ this field can also be used to pass the following parameters:
91765
+ cid – a unique, google-defined id of the business entity;
91766
+ place_id – an identifier of the business entity in Google Maps;
91767
+ spp – a unique identifier of local services featured in the local_pack element of Google SERP
91768
+ example:
91769
+ cid:194604053573767737
91770
+ place_id:GhIJQWDl0CIeQUARxks3icF8U8A
91771
+ spp:CgsvZy8xdGN4cWRraBoUChIJPZDrEzLsZIgRoNrpodC5P30
91772
+ learn more about the cid and place_id identifiers in this help center article */
91773
+ keyword?: string;
91774
+ /** full name of search engine location
91775
+ required field if you don’t specify location_code or location_coordinate
91776
+ if you use this field, you don’t need to specify location_code or location_coordinate
91777
+ you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
91778
+ example:
91779
+ London,England,United Kingdom */
91780
+ location_name?: string | undefined;
91781
+ /** search engine location code
91782
+ required field if you don’t specify location_name or location_coordinate
91783
+ if you use this field, you don’t need to specify location_name or location_coordinate
91784
+ you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
91785
+ example:
91786
+ 2840 */
91787
+ location_code?: number | undefined;
91788
+ /** GPS coordinates of a location
91789
+ required field if you don’t specify location_name or location_code
91790
+ if you use this field, you don’t need to specify location_name or location_code
91791
+ location_coordinate parameter should be specified in the “latitude,longitude,radius” format
91792
+ the maximum number of decimal digits for “latitude” and “longitude”: 7
91793
+ the minimum value for “radius”: 199.9 (mm)
91794
+ the maximum value for “radius”: 199999 (mm)
91795
+ example:
91796
+ 53.476225,-2.243572,200 */
91797
+ location_coordinate?: string | undefined;
91798
+ /** full name of search engine language
91799
+ required field if you don’t specify language_code
91800
+ if you use this field, you don’t need to specify language_code
91801
+ you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
91802
+ example:
91803
+ English */
91804
+ language_name?: string | undefined;
91805
+ /** search engine language code
91806
+ required field if you don’t specify language_name
91807
+ if you use this field, you don’t need to specify language_name
91808
+ you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
91809
+ example:
91810
+ en */
91811
+ language_code?: string | undefined;
91812
+ /** parsing depth
91813
+ optional field
91814
+ number of results in SERP
91815
+ default value: 20
91816
+ max value: 100
91817
+ Note: your account will be billed per each SERP containing up to 20 results;
91818
+ thus, setting a depth above 20 may result in additional charges if the search engine returns more than 20 results;
91819
+ if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
91820
+ depth?: number | undefined;
91821
+ /** user-defined task identifier
91822
+ optional field
91823
+ the character limit is 255
91824
+ you can use this parameter to identify the task and match it with the result
91825
+ you will find the specified tag value in the data object of the response */
91826
+ tag?: string | undefined;
91827
+ [key: string]: any;
91828
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersLiveRequestInfo);
91829
+ init(_data?: any): void;
91830
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersLiveRequestInfo;
91831
+ toJSON(data?: any): any;
91832
+ }
91833
+ export interface IBusinessDataGoogleQuestionsAndAnswersLiveRequestInfo {
91834
+ /** keyword
91835
+ required field
91836
+ the keyword you specify should indicate the name of the local establishment
91837
+ you can specify up to 700 symbols in the keyword filed
91838
+ all %## will be decoded (plus symbol ‘+’ will be decoded to a space character)
91839
+ if you need to use the “%” symbol for your keyword, please specify it as “%25”;
91840
+ this field can also be used to pass the following parameters:
91841
+ cid – a unique, google-defined id of the business entity;
91842
+ place_id – an identifier of the business entity in Google Maps;
91843
+ spp – a unique identifier of local services featured in the local_pack element of Google SERP
91844
+ example:
91845
+ cid:194604053573767737
91846
+ place_id:GhIJQWDl0CIeQUARxks3icF8U8A
91847
+ spp:CgsvZy8xdGN4cWRraBoUChIJPZDrEzLsZIgRoNrpodC5P30
91848
+ learn more about the cid and place_id identifiers in this help center article */
91849
+ keyword?: string;
91850
+ /** full name of search engine location
91851
+ required field if you don’t specify location_code or location_coordinate
91852
+ if you use this field, you don’t need to specify location_code or location_coordinate
91853
+ you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
91854
+ example:
91855
+ London,England,United Kingdom */
91856
+ location_name?: string | undefined;
91857
+ /** search engine location code
91858
+ required field if you don’t specify location_name or location_coordinate
91859
+ if you use this field, you don’t need to specify location_name or location_coordinate
91860
+ you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
91861
+ example:
91862
+ 2840 */
91863
+ location_code?: number | undefined;
91864
+ /** GPS coordinates of a location
91865
+ required field if you don’t specify location_name or location_code
91866
+ if you use this field, you don’t need to specify location_name or location_code
91867
+ location_coordinate parameter should be specified in the “latitude,longitude,radius” format
91868
+ the maximum number of decimal digits for “latitude” and “longitude”: 7
91869
+ the minimum value for “radius”: 199.9 (mm)
91870
+ the maximum value for “radius”: 199999 (mm)
91871
+ example:
91872
+ 53.476225,-2.243572,200 */
91873
+ location_coordinate?: string | undefined;
91874
+ /** full name of search engine language
91875
+ required field if you don’t specify language_code
91876
+ if you use this field, you don’t need to specify language_code
91877
+ you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
91878
+ example:
91879
+ English */
91880
+ language_name?: string | undefined;
91881
+ /** search engine language code
91882
+ required field if you don’t specify language_name
91883
+ if you use this field, you don’t need to specify language_name
91884
+ you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
91885
+ example:
91886
+ en */
91887
+ language_code?: string | undefined;
91888
+ /** parsing depth
91889
+ optional field
91890
+ number of results in SERP
91891
+ default value: 20
91892
+ max value: 100
91893
+ Note: your account will be billed per each SERP containing up to 20 results;
91894
+ thus, setting a depth above 20 may result in additional charges if the search engine returns more than 20 results;
91895
+ if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance */
91896
+ depth?: number | undefined;
91897
+ /** user-defined task identifier
91898
+ optional field
91899
+ the character limit is 255
91900
+ you can use this parameter to identify the task and match it with the result
91901
+ you will find the specified tag value in the data object of the response */
91902
+ tag?: string | undefined;
91903
+ [key: string]: any;
91904
+ }
91905
+ export declare class BusinessDataGoogleQuestionsAndAnswersLiveResultInfo implements IBusinessDataGoogleQuestionsAndAnswersLiveResultInfo {
91906
+ /** keyword received in a POST array
91907
+ keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
91908
+ this field will contain the cid parameter if you specified it in the keyword field when setting a task;
91909
+ example:
91910
+ cid:2946633002421908862
91911
+ learn more about the parameter in this help center article */
91912
+ keyword?: string | undefined;
91913
+ /** search engine domain as specified in a POST array */
91914
+ se_domain?: string | undefined;
91915
+ /** location code in a POST array */
91916
+ location_code?: number | undefined;
91917
+ /** language code in a POST array */
91918
+ language_code?: string | undefined;
91919
+ /** direct URL to search engine results
91920
+ you can use it to make sure that we provided accurate results */
91921
+ check_url?: string | undefined;
91922
+ /** date and time when the result was received
91923
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
91924
+ example:
91925
+ 2019-11-15 12:57:46 +00:00 */
91926
+ datetime?: string | undefined;
91927
+ /** google-defined client id
91928
+ unique id of a local establishment;
91929
+ learn more about the identifier in this help center article */
91930
+ cid?: string | undefined;
91931
+ /** unique identifier of the SERP feature */
91932
+ feature_id?: string | undefined;
91933
+ /** item types
91934
+ types of search engine results encountered in the items array;
91935
+ possible item types: google_business_question_item */
91936
+ item_types?: (string | undefined)[] | undefined;
91937
+ /** array of google business question items without answers */
91938
+ items_without_answers?: (ItemsWithoutAnswers | undefined)[] | undefined;
91939
+ /** the number of items in the items array */
91940
+ items_count?: number | undefined;
91941
+ /** array of items within google_business_question_item
91942
+ contains answers to the google business questions;
91943
+ possible item types google_business_answer_element */
91944
+ items?: (BusinessDataGoogleQuestionsAndAnswersItem | undefined)[] | undefined;
91945
+ [key: string]: any;
91946
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersLiveResultInfo);
91947
+ init(_data?: any): void;
91948
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersLiveResultInfo;
91949
+ toJSON(data?: any): any;
91950
+ }
91951
+ export interface IBusinessDataGoogleQuestionsAndAnswersLiveResultInfo {
91952
+ /** keyword received in a POST array
91953
+ keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
91954
+ this field will contain the cid parameter if you specified it in the keyword field when setting a task;
91955
+ example:
91956
+ cid:2946633002421908862
91957
+ learn more about the parameter in this help center article */
91958
+ keyword?: string | undefined;
91959
+ /** search engine domain as specified in a POST array */
91960
+ se_domain?: string | undefined;
91961
+ /** location code in a POST array */
91962
+ location_code?: number | undefined;
91963
+ /** language code in a POST array */
91964
+ language_code?: string | undefined;
91965
+ /** direct URL to search engine results
91966
+ you can use it to make sure that we provided accurate results */
91967
+ check_url?: string | undefined;
91968
+ /** date and time when the result was received
91969
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
91970
+ example:
91971
+ 2019-11-15 12:57:46 +00:00 */
91972
+ datetime?: string | undefined;
91973
+ /** google-defined client id
91974
+ unique id of a local establishment;
91975
+ learn more about the identifier in this help center article */
91976
+ cid?: string | undefined;
91977
+ /** unique identifier of the SERP feature */
91978
+ feature_id?: string | undefined;
91979
+ /** item types
91980
+ types of search engine results encountered in the items array;
91981
+ possible item types: google_business_question_item */
91982
+ item_types?: (string | undefined)[] | undefined;
91983
+ /** array of google business question items without answers */
91984
+ items_without_answers?: (ItemsWithoutAnswers | undefined)[] | undefined;
91985
+ /** the number of items in the items array */
91986
+ items_count?: number | undefined;
91987
+ /** array of items within google_business_question_item
91988
+ contains answers to the google business questions;
91989
+ possible item types google_business_answer_element */
91990
+ items?: (BusinessDataGoogleQuestionsAndAnswersItem | undefined)[] | undefined;
91991
+ [key: string]: any;
91992
+ }
91993
+ export declare class BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo extends BaseResponseTaskInfo implements IBusinessDataGoogleQuestionsAndAnswersLiveTaskInfo {
91994
+ /** array of results */
91995
+ result?: (BusinessDataGoogleQuestionsAndAnswersLiveResultInfo | undefined)[] | undefined;
91996
+ [key: string]: any;
91997
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersLiveTaskInfo);
91998
+ init(_data?: any): void;
91999
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo;
92000
+ toJSON(data?: any): any;
92001
+ }
92002
+ export interface IBusinessDataGoogleQuestionsAndAnswersLiveTaskInfo extends IBaseResponseTaskInfo {
92003
+ /** array of results */
92004
+ result?: (BusinessDataGoogleQuestionsAndAnswersLiveResultInfo | undefined)[] | undefined;
92005
+ [key: string]: any;
92006
+ }
92007
+ export declare class BusinessDataGoogleQuestionsAndAnswersLiveResponseInfo extends BaseResponseInfo implements IBusinessDataGoogleQuestionsAndAnswersLiveResponseInfo {
92008
+ /** array of tasks */
92009
+ tasks?: (BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo | undefined)[] | undefined;
92010
+ [key: string]: any;
92011
+ constructor(data?: IBusinessDataGoogleQuestionsAndAnswersLiveResponseInfo);
92012
+ init(_data?: any): void;
92013
+ static fromJS(data: any): BusinessDataGoogleQuestionsAndAnswersLiveResponseInfo;
92014
+ toJSON(data?: any): any;
92015
+ }
92016
+ export interface IBusinessDataGoogleQuestionsAndAnswersLiveResponseInfo extends IBaseResponseInfo {
92017
+ /** array of tasks */
92018
+ tasks?: (BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo | undefined)[] | undefined;
92019
+ [key: string]: any;
92020
+ }
90592
92021
  export declare class BusinessDataTrustpilotSearchTaskPostRequestInfo implements IBusinessDataTrustpilotSearchTaskPostRequestInfo {
90593
92022
  /** keyword
90594
92023
  required field
@@ -90734,6 +92163,7 @@ unique task identifier in our system in the UUID format */
90734
92163
  /** search engine specified when setting the task
90735
92164
  can take the following values: trustpilot */
90736
92165
  se?: string | undefined;
92166
+ se_type?: string | undefined;
90737
92167
  /** date when the task was posted (in the UTC format) */
90738
92168
  date_posted?: string | undefined;
90739
92169
  /** user-defined task identifier */
@@ -90753,6 +92183,7 @@ unique task identifier in our system in the UUID format */
90753
92183
  /** search engine specified when setting the task
90754
92184
  can take the following values: trustpilot */
90755
92185
  se?: string | undefined;
92186
+ se_type?: string | undefined;
90756
92187
  /** date when the task was posted (in the UTC format) */
90757
92188
  date_posted?: string | undefined;
90758
92189
  /** user-defined task identifier */
@@ -91066,6 +92497,7 @@ unique task identifier in our system in the UUID format */
91066
92497
  /** search engine specified when setting the task
91067
92498
  can take the following values: trustpilot */
91068
92499
  se?: string | undefined;
92500
+ se_type?: string | undefined;
91069
92501
  /** date when the task was posted (in the UTC format) */
91070
92502
  date_posted?: string | undefined;
91071
92503
  /** user-defined task identifier */
@@ -91085,6 +92517,7 @@ unique task identifier in our system in the UUID format */
91085
92517
  /** search engine specified when setting the task
91086
92518
  can take the following values: trustpilot */
91087
92519
  se?: string | undefined;
92520
+ se_type?: string | undefined;
91088
92521
  /** date when the task was posted (in the UTC format) */
91089
92522
  date_posted?: string | undefined;
91090
92523
  /** user-defined task identifier */
@@ -91674,6 +93107,7 @@ unique task identifier in our system in the UUID format */
91674
93107
  /** search engine specified when setting the task
91675
93108
  can take the following values: tripadvisor */
91676
93109
  se?: string | undefined;
93110
+ se_type?: string | undefined;
91677
93111
  /** date when the task was posted (in the UTC format) */
91678
93112
  date_posted?: string | undefined;
91679
93113
  /** user-defined task identifier */
@@ -91693,6 +93127,7 @@ unique task identifier in our system in the UUID format */
91693
93127
  /** search engine specified when setting the task
91694
93128
  can take the following values: tripadvisor */
91695
93129
  se?: string | undefined;
93130
+ se_type?: string | undefined;
91696
93131
  /** date when the task was posted (in the UTC format) */
91697
93132
  date_posted?: string | undefined;
91698
93133
  /** user-defined task identifier */
@@ -92150,6 +93585,7 @@ unique task identifier in our system in the UUID format */
92150
93585
  /** search engine specified when setting the task
92151
93586
  can take the following values: tripadvisor */
92152
93587
  se?: string | undefined;
93588
+ se_type?: string | undefined;
92153
93589
  /** date when the task was posted (in the UTC format) */
92154
93590
  date_posted?: string | undefined;
92155
93591
  /** user-defined task identifier */
@@ -92169,6 +93605,7 @@ unique task identifier in our system in the UUID format */
92169
93605
  /** search engine specified when setting the task
92170
93606
  can take the following values: tripadvisor */
92171
93607
  se?: string | undefined;
93608
+ se_type?: string | undefined;
92172
93609
  /** date when the task was posted (in the UTC format) */
92173
93610
  date_posted?: string | undefined;
92174
93611
  /** user-defined task identifier */
@@ -94378,6 +95815,7 @@ export declare class AppendixMerchantLimitsRatesDataInfo implements IAppendixMer
94378
95815
  languages?: number | undefined;
94379
95816
  errors?: number | undefined;
94380
95817
  reviews?: AppendixSerpLimitsRatesDataInfo | undefined;
95818
+ tasks_ready?: number | undefined;
94381
95819
  [key: string]: any;
94382
95820
  constructor(data?: IAppendixMerchantLimitsRatesDataInfo);
94383
95821
  init(_data?: any): void;
@@ -94391,6 +95829,7 @@ export interface IAppendixMerchantLimitsRatesDataInfo {
94391
95829
  languages?: number | undefined;
94392
95830
  errors?: number | undefined;
94393
95831
  reviews?: AppendixSerpLimitsRatesDataInfo | undefined;
95832
+ tasks_ready?: number | undefined;
94394
95833
  [key: string]: any;
94395
95834
  }
94396
95835
  export declare class AppendixOnPageLimitsRatesDataInfo implements IAppendixOnPageLimitsRatesDataInfo {
@@ -94449,6 +95888,7 @@ export declare class AppendixBusinessDataGoogleInfo implements IAppendixBusiness
94449
95888
  hotel_info?: AppendixSerpLimitsRatesDataInfo | undefined;
94450
95889
  hotel_searches?: AppendixFunctionInfo | undefined;
94451
95890
  reviews?: AppendixFunctionInfo | undefined;
95891
+ questions_and_answers?: AppendixFunctionInfo | undefined;
94452
95892
  [key: string]: any;
94453
95893
  constructor(data?: IAppendixBusinessDataGoogleInfo);
94454
95894
  init(_data?: any): void;
@@ -94461,6 +95901,7 @@ export interface IAppendixBusinessDataGoogleInfo {
94461
95901
  hotel_info?: AppendixSerpLimitsRatesDataInfo | undefined;
94462
95902
  hotel_searches?: AppendixFunctionInfo | undefined;
94463
95903
  reviews?: AppendixFunctionInfo | undefined;
95904
+ questions_and_answers?: AppendixFunctionInfo | undefined;
94464
95905
  [key: string]: any;
94465
95906
  }
94466
95907
  export declare class AppendixBusinessDataDayLimitsRatesDataInfo implements IAppendixBusinessDataDayLimitsRatesDataInfo {
@@ -94521,6 +95962,7 @@ export declare class AppendixBusinessDataLimitsRatesDataInfo implements IAppendi
94521
95962
  tripadvisor?: AppendixBusinessDataDayLimitsRatesDataInfo | undefined;
94522
95963
  trustpilot?: AppendixBusinessDataDayLimitsRatesDataInfo | undefined;
94523
95964
  business_listings?: AppendixBusinessListingsBusinessDataLimitsRatesDataInfo | undefined;
95965
+ tasks_ready?: number | undefined;
94524
95966
  [key: string]: any;
94525
95967
  constructor(data?: IAppendixBusinessDataLimitsRatesDataInfo);
94526
95968
  init(_data?: any): void;
@@ -94537,6 +95979,7 @@ export interface IAppendixBusinessDataLimitsRatesDataInfo {
94537
95979
  tripadvisor?: AppendixBusinessDataDayLimitsRatesDataInfo | undefined;
94538
95980
  trustpilot?: AppendixBusinessDataDayLimitsRatesDataInfo | undefined;
94539
95981
  business_listings?: AppendixBusinessListingsBusinessDataLimitsRatesDataInfo | undefined;
95982
+ tasks_ready?: number | undefined;
94540
95983
  [key: string]: any;
94541
95984
  }
94542
95985
  export declare class AppendixBacklinksLimitsRatesDataInfo implements IAppendixBacklinksLimitsRatesDataInfo {
@@ -94600,6 +96043,7 @@ export declare class AppendixAppDataLimitsRatesDataInfo implements IAppendixAppD
94600
96043
  languages?: number | undefined;
94601
96044
  locations?: number | undefined;
94602
96045
  categories?: number | undefined;
96046
+ tasks_ready?: number | undefined;
94603
96047
  [key: string]: any;
94604
96048
  constructor(data?: IAppendixAppDataLimitsRatesDataInfo);
94605
96049
  init(_data?: any): void;
@@ -94615,6 +96059,7 @@ export interface IAppendixAppDataLimitsRatesDataInfo {
94615
96059
  languages?: number | undefined;
94616
96060
  locations?: number | undefined;
94617
96061
  categories?: number | undefined;
96062
+ tasks_ready?: number | undefined;
94618
96063
  [key: string]: any;
94619
96064
  }
94620
96065
  export declare class AppendixContentAnalysisLimitsRatesDataInfo implements IAppendixContentAnalysisLimitsRatesDataInfo {
@@ -95374,6 +96819,7 @@ export declare class AppendixMerchantPriceData implements IAppendixMerchantPrice
95374
96819
  languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95375
96820
  locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95376
96821
  reviews?: AppendixProductGoogleMerchantPriceDataInfo | undefined;
96822
+ tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95377
96823
  [key: string]: any;
95378
96824
  constructor(data?: IAppendixMerchantPriceData);
95379
96825
  init(_data?: any): void;
@@ -95387,12 +96833,13 @@ export interface IAppendixMerchantPriceData {
95387
96833
  languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95388
96834
  locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95389
96835
  reviews?: AppendixProductGoogleMerchantPriceDataInfo | undefined;
96836
+ tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95390
96837
  [key: string]: any;
95391
96838
  }
95392
96839
  export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceDataInfo {
95393
- advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95394
- html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95395
96840
  regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
96841
+ html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
96842
+ advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95396
96843
  [key: string]: any;
95397
96844
  constructor(data?: IAppendixSerpPriceDataInfo);
95398
96845
  init(_data?: any): void;
@@ -95400,9 +96847,9 @@ export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceData
95400
96847
  toJSON(data?: any): any;
95401
96848
  }
95402
96849
  export interface IAppendixSerpPriceDataInfo {
95403
- advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95404
- html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95405
96850
  regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
96851
+ html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
96852
+ advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95406
96853
  [key: string]: any;
95407
96854
  }
95408
96855
  export declare class AppendixSerpPriceData implements IAppendixSerpPriceData {
@@ -95458,6 +96905,7 @@ export declare class AppendixAppDataPriceData implements IAppendixAppDataPriceDa
95458
96905
  errors?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95459
96906
  languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95460
96907
  locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
96908
+ tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95461
96909
  [key: string]: any;
95462
96910
  constructor(data?: IAppendixAppDataPriceData);
95463
96911
  init(_data?: any): void;
@@ -95473,6 +96921,7 @@ export interface IAppendixAppDataPriceData {
95473
96921
  errors?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95474
96922
  languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95475
96923
  locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
96924
+ tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95476
96925
  [key: string]: any;
95477
96926
  }
95478
96927
  export declare class AppendixBacklinksPriceData implements IAppendixBacklinksPriceData {
@@ -95579,18 +97028,18 @@ export interface IAppendixHotelInfoGoogleBusinessDataPriceData {
95579
97028
  tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95580
97029
  [key: string]: any;
95581
97030
  }
95582
- export declare class AppendixHotelSearchesGoogleBusinessDataPriceData implements IAppendixHotelSearchesGoogleBusinessDataPriceData {
97031
+ export declare class AppendixsGoogleBusinessDataPriceDataInfo implements IAppendixsGoogleBusinessDataPriceDataInfo {
95583
97032
  live?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95584
97033
  task_get?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95585
97034
  task_post?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95586
97035
  tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95587
97036
  [key: string]: any;
95588
- constructor(data?: IAppendixHotelSearchesGoogleBusinessDataPriceData);
97037
+ constructor(data?: IAppendixsGoogleBusinessDataPriceDataInfo);
95589
97038
  init(_data?: any): void;
95590
- static fromJS(data: any): AppendixHotelSearchesGoogleBusinessDataPriceData;
97039
+ static fromJS(data: any): AppendixsGoogleBusinessDataPriceDataInfo;
95591
97040
  toJSON(data?: any): any;
95592
97041
  }
95593
- export interface IAppendixHotelSearchesGoogleBusinessDataPriceData {
97042
+ export interface IAppendixsGoogleBusinessDataPriceDataInfo {
95594
97043
  live?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95595
97044
  task_get?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95596
97045
  task_post?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
@@ -95599,10 +97048,11 @@ export interface IAppendixHotelSearchesGoogleBusinessDataPriceData {
95599
97048
  }
95600
97049
  export declare class AppendixGoogleBusinessDataPriceData implements IAppendixGoogleBusinessDataPriceData {
95601
97050
  hotel_info?: AppendixHotelInfoGoogleBusinessDataPriceData | undefined;
95602
- hotel_searches?: AppendixHotelSearchesGoogleBusinessDataPriceData | undefined;
95603
- my_business_info?: AppendixHotelSearchesGoogleBusinessDataPriceData | undefined;
95604
- my_business_updates?: AppendixHotelSearchesGoogleBusinessDataPriceData | undefined;
95605
- reviews?: AppendixHotelSearchesGoogleBusinessDataPriceData | undefined;
97051
+ hotel_searches?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
97052
+ my_business_info?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
97053
+ my_business_updates?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
97054
+ questions_and_answers?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
97055
+ reviews?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
95606
97056
  [key: string]: any;
95607
97057
  constructor(data?: IAppendixGoogleBusinessDataPriceData);
95608
97058
  init(_data?: any): void;
@@ -95611,15 +97061,16 @@ export declare class AppendixGoogleBusinessDataPriceData implements IAppendixGoo
95611
97061
  }
95612
97062
  export interface IAppendixGoogleBusinessDataPriceData {
95613
97063
  hotel_info?: AppendixHotelInfoGoogleBusinessDataPriceData | undefined;
95614
- hotel_searches?: AppendixHotelSearchesGoogleBusinessDataPriceData | undefined;
95615
- my_business_info?: AppendixHotelSearchesGoogleBusinessDataPriceData | undefined;
95616
- my_business_updates?: AppendixHotelSearchesGoogleBusinessDataPriceData | undefined;
95617
- reviews?: AppendixHotelSearchesGoogleBusinessDataPriceData | undefined;
97064
+ hotel_searches?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
97065
+ my_business_info?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
97066
+ my_business_updates?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
97067
+ questions_and_answers?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
97068
+ reviews?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
95618
97069
  [key: string]: any;
95619
97070
  }
95620
97071
  export declare class AppendixTrBusinessDataPriceDataInfo implements IAppendixTrBusinessDataPriceDataInfo {
95621
- reviews?: AppendixHotelSearchesGoogleBusinessDataPriceData | undefined;
95622
- search?: AppendixHotelSearchesGoogleBusinessDataPriceData | undefined;
97072
+ reviews?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
97073
+ search?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
95623
97074
  [key: string]: any;
95624
97075
  constructor(data?: IAppendixTrBusinessDataPriceDataInfo);
95625
97076
  init(_data?: any): void;
@@ -95627,8 +97078,8 @@ export declare class AppendixTrBusinessDataPriceDataInfo implements IAppendixTrB
95627
97078
  toJSON(data?: any): any;
95628
97079
  }
95629
97080
  export interface IAppendixTrBusinessDataPriceDataInfo {
95630
- reviews?: AppendixHotelSearchesGoogleBusinessDataPriceData | undefined;
95631
- search?: AppendixHotelSearchesGoogleBusinessDataPriceData | undefined;
97081
+ reviews?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
97082
+ search?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
95632
97083
  [key: string]: any;
95633
97084
  }
95634
97085
  export declare class AppendixBusinessDataPriceData implements IAppendixBusinessDataPriceData {
@@ -95641,6 +97092,7 @@ export declare class AppendixBusinessDataPriceData implements IAppendixBusinessD
95641
97092
  tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
95642
97093
  trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
95643
97094
  yelp?: AppendixTrBusinessDataPriceDataInfo | undefined;
97095
+ tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95644
97096
  [key: string]: any;
95645
97097
  constructor(data?: IAppendixBusinessDataPriceData);
95646
97098
  init(_data?: any): void;
@@ -95657,6 +97109,7 @@ export interface IAppendixBusinessDataPriceData {
95657
97109
  tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
95658
97110
  trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
95659
97111
  yelp?: AppendixTrBusinessDataPriceDataInfo | undefined;
97112
+ tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95660
97113
  [key: string]: any;
95661
97114
  }
95662
97115
  export declare class AppendixContentAnalysisPriceData implements IAppendixContentAnalysisPriceData {
@@ -95863,27 +97316,9 @@ export interface IAppendixDomainAnalyticsPriceData {
95863
97316
  tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95864
97317
  [key: string]: any;
95865
97318
  }
95866
- export declare class AppendixLighthouseOnPagePriceData implements IAppendixLighthouseOnPagePriceData {
95867
- live?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95868
- task_get?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95869
- task_post?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95870
- tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95871
- [key: string]: any;
95872
- constructor(data?: IAppendixLighthouseOnPagePriceData);
95873
- init(_data?: any): void;
95874
- static fromJS(data: any): AppendixLighthouseOnPagePriceData;
95875
- toJSON(data?: any): any;
95876
- }
95877
- export interface IAppendixLighthouseOnPagePriceData {
95878
- live?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95879
- task_get?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95880
- task_post?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95881
- tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95882
- [key: string]: any;
95883
- }
95884
97319
  export declare class AppendixOnPagePriceData implements IAppendixOnPagePriceData {
95885
97320
  errors?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95886
- lighthouse?: AppendixLighthouseOnPagePriceData | undefined;
97321
+ lighthouse?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
95887
97322
  content_parsing?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95888
97323
  content_parsing_live?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95889
97324
  duplicate_content?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
@@ -95910,7 +97345,7 @@ export declare class AppendixOnPagePriceData implements IAppendixOnPagePriceData
95910
97345
  }
95911
97346
  export interface IAppendixOnPagePriceData {
95912
97347
  errors?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95913
- lighthouse?: AppendixLighthouseOnPagePriceData | undefined;
97348
+ lighthouse?: AppendixsGoogleBusinessDataPriceDataInfo | undefined;
95914
97349
  content_parsing?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95915
97350
  content_parsing_live?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95916
97351
  duplicate_content?: AppendixTaskKeywordsDataPriceDataInfo | undefined;