dataforseo-client 1.0.16 → 1.0.18
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.
- package/main.d.ts +1526 -401
- package/main.js +1424 -220
- package/main.js.map +1 -1
- package/main.ts +2939 -647
- package/package.json +1 -1
package/main.d.ts
CHANGED
|
@@ -1378,6 +1378,12 @@ export declare class KeywordsDataApi {
|
|
|
1378
1378
|
*/
|
|
1379
1379
|
keywordsDataGoogleAdsLocations(): Promise<KeywordsDataGoogleAdsLocationsResponseInfo | null>;
|
|
1380
1380
|
protected processKeywordsDataGoogleAdsLocations(response: Response): Promise<KeywordsDataGoogleAdsLocationsResponseInfo | null>;
|
|
1381
|
+
/**
|
|
1382
|
+
* @param country (optional)
|
|
1383
|
+
* @return Successful operation
|
|
1384
|
+
*/
|
|
1385
|
+
keywordsDataGoogleAdsLocationsCountry(country: any | undefined): Promise<KeywordsDataGoogleAdsLocationsCountryResponseInfo | null>;
|
|
1386
|
+
protected processKeywordsDataGoogleAdsLocationsCountry(response: Response): Promise<KeywordsDataGoogleAdsLocationsCountryResponseInfo | null>;
|
|
1381
1387
|
/**
|
|
1382
1388
|
* @return Successful operation
|
|
1383
1389
|
*/
|
|
@@ -2213,6 +2219,11 @@ export declare class MerchantApi {
|
|
|
2213
2219
|
*/
|
|
2214
2220
|
googleProductsTasksReady(): Promise<MerchantGoogleProductsTasksReadyResponseInfo | null>;
|
|
2215
2221
|
protected processGoogleProductsTasksReady(response: Response): Promise<MerchantGoogleProductsTasksReadyResponseInfo | null>;
|
|
2222
|
+
/**
|
|
2223
|
+
* @return Successful operation
|
|
2224
|
+
*/
|
|
2225
|
+
merchantTasksReady(): Promise<MerchantTasksReadyResponseInfo | null>;
|
|
2226
|
+
protected processMerchantTasksReady(response: Response): Promise<MerchantTasksReadyResponseInfo | null>;
|
|
2216
2227
|
/**
|
|
2217
2228
|
* @param id task identifier
|
|
2218
2229
|
unique task identifier in our system in the UUID format
|
|
@@ -2467,6 +2478,12 @@ export declare class AppDataApi {
|
|
|
2467
2478
|
*/
|
|
2468
2479
|
appDataGoogleLocations(): Promise<AppDataGoogleLocationsResponseInfo | null>;
|
|
2469
2480
|
protected processAppDataGoogleLocations(response: Response): Promise<AppDataGoogleLocationsResponseInfo | null>;
|
|
2481
|
+
/**
|
|
2482
|
+
* @param country (optional)
|
|
2483
|
+
* @return Successful operation
|
|
2484
|
+
*/
|
|
2485
|
+
appDataGoogleLocationsCountry(country: any | undefined): Promise<AppDataGoogleLocationsCountryResponseInfo | null>;
|
|
2486
|
+
protected processAppDataGoogleLocationsCountry(response: Response): Promise<AppDataGoogleLocationsCountryResponseInfo | null>;
|
|
2470
2487
|
/**
|
|
2471
2488
|
* @return Successful operation
|
|
2472
2489
|
*/
|
|
@@ -2483,6 +2500,11 @@ export declare class AppDataApi {
|
|
|
2483
2500
|
*/
|
|
2484
2501
|
googleAppSearchesTasksReady(): Promise<AppDataGoogleAppSearchesTasksReadyResponseInfo | null>;
|
|
2485
2502
|
protected processGoogleAppSearchesTasksReady(response: Response): Promise<AppDataGoogleAppSearchesTasksReadyResponseInfo | null>;
|
|
2503
|
+
/**
|
|
2504
|
+
* @return Successful operation
|
|
2505
|
+
*/
|
|
2506
|
+
appDataTasksReady(): Promise<AppDataTasksReadyResponseInfo | null>;
|
|
2507
|
+
protected processAppDataTasksReady(response: Response): Promise<AppDataTasksReadyResponseInfo | null>;
|
|
2486
2508
|
/**
|
|
2487
2509
|
* @param id task identifier
|
|
2488
2510
|
unique task identifier in our system in the UUID format
|
|
@@ -2771,6 +2793,11 @@ export declare class BusinessDataApi {
|
|
|
2771
2793
|
*/
|
|
2772
2794
|
googleMyBusinessInfoTasksReady(): Promise<BusinessDataGoogleMyBusinessInfoTasksReadyResponseInfo | null>;
|
|
2773
2795
|
protected processGoogleMyBusinessInfoTasksReady(response: Response): Promise<BusinessDataGoogleMyBusinessInfoTasksReadyResponseInfo | null>;
|
|
2796
|
+
/**
|
|
2797
|
+
* @return Successful operation
|
|
2798
|
+
*/
|
|
2799
|
+
businessDataTasksReady(): Promise<BusinessDataTasksReadyResponseInfo | null>;
|
|
2800
|
+
protected processBusinessDataTasksReady(response: Response): Promise<BusinessDataTasksReadyResponseInfo | null>;
|
|
2774
2801
|
/**
|
|
2775
2802
|
* @param id task identifier
|
|
2776
2803
|
unique task identifier in our system in the UUID format
|
|
@@ -4465,8 +4492,9 @@ you will be able to use it within 30 days to request the results of the task at
|
|
|
4465
4492
|
task_id?: string;
|
|
4466
4493
|
/** AI prompt
|
|
4467
4494
|
optional field
|
|
4468
|
-
additional task for AI
|
|
4495
|
+
additional task for AI summariser;
|
|
4469
4496
|
any form of text, question or information that communicates to AI what response you’re looking for;
|
|
4497
|
+
max number of symbols or characters you can specify: 2000;
|
|
4470
4498
|
note: your prompt has to be relevant to the keyword specified in the POST request to SERP API */
|
|
4471
4499
|
prompt?: string | undefined;
|
|
4472
4500
|
/** support extra SERP features
|
|
@@ -4498,8 +4526,9 @@ you will be able to use it within 30 days to request the results of the task at
|
|
|
4498
4526
|
task_id?: string;
|
|
4499
4527
|
/** AI prompt
|
|
4500
4528
|
optional field
|
|
4501
|
-
additional task for AI
|
|
4529
|
+
additional task for AI summariser;
|
|
4502
4530
|
any form of text, question or information that communicates to AI what response you’re looking for;
|
|
4531
|
+
max number of symbols or characters you can specify: 2000;
|
|
4503
4532
|
note: your prompt has to be relevant to the keyword specified in the POST request to SERP API */
|
|
4504
4533
|
prompt?: string | undefined;
|
|
4505
4534
|
/** support extra SERP features
|
|
@@ -5963,7 +5992,8 @@ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
|
|
|
5963
5992
|
example:
|
|
5964
5993
|
2019-11-15 12:57:46 +00:00 */
|
|
5965
5994
|
timestamp?: string | undefined;
|
|
5966
|
-
/** table
|
|
5995
|
+
/** results table
|
|
5996
|
+
if there are none, equals null */
|
|
5967
5997
|
table?: Table | undefined;
|
|
5968
5998
|
[key: string]: any;
|
|
5969
5999
|
constructor(data?: IKnowledgeGraphExpandedElement);
|
|
@@ -5991,7 +6021,8 @@ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
|
|
|
5991
6021
|
example:
|
|
5992
6022
|
2019-11-15 12:57:46 +00:00 */
|
|
5993
6023
|
timestamp?: string | undefined;
|
|
5994
|
-
/** table
|
|
6024
|
+
/** results table
|
|
6025
|
+
if there are none, equals null */
|
|
5995
6026
|
table?: Table | undefined;
|
|
5996
6027
|
[key: string]: any;
|
|
5997
6028
|
}
|
|
@@ -6689,6 +6720,8 @@ example:
|
|
|
6689
6720
|
timestamp?: string | undefined;
|
|
6690
6721
|
/** URL */
|
|
6691
6722
|
url?: string | undefined;
|
|
6723
|
+
/** URL of the image */
|
|
6724
|
+
image_url?: string | undefined;
|
|
6692
6725
|
[key: string]: any;
|
|
6693
6726
|
constructor(data?: ITopStoriesElement);
|
|
6694
6727
|
init(_data?: any): void;
|
|
@@ -6717,6 +6750,8 @@ example:
|
|
|
6717
6750
|
timestamp?: string | undefined;
|
|
6718
6751
|
/** URL */
|
|
6719
6752
|
url?: string | undefined;
|
|
6753
|
+
/** URL of the image */
|
|
6754
|
+
image_url?: string | undefined;
|
|
6720
6755
|
[key: string]: any;
|
|
6721
6756
|
}
|
|
6722
6757
|
export declare class TopStoriesSerpElementItem extends BaseSerpElementItem implements ITopStoriesSerpElementItem {
|
|
@@ -6797,8 +6832,7 @@ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
|
|
|
6797
6832
|
example:
|
|
6798
6833
|
2019-11-15 12:57:46 +00:00 */
|
|
6799
6834
|
timestamp?: string | undefined;
|
|
6800
|
-
/**
|
|
6801
|
-
if there are none, equals null */
|
|
6835
|
+
/** table element */
|
|
6802
6836
|
table?: Table | undefined;
|
|
6803
6837
|
[key: string]: any;
|
|
6804
6838
|
constructor(data?: IPeopleAlsoAskExpandedElement);
|
|
@@ -6826,8 +6860,7 @@ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
|
|
|
6826
6860
|
example:
|
|
6827
6861
|
2019-11-15 12:57:46 +00:00 */
|
|
6828
6862
|
timestamp?: string | undefined;
|
|
6829
|
-
/**
|
|
6830
|
-
if there are none, equals null */
|
|
6863
|
+
/** table element */
|
|
6831
6864
|
table?: Table | undefined;
|
|
6832
6865
|
[key: string]: any;
|
|
6833
6866
|
}
|
|
@@ -10573,6 +10606,114 @@ indicates the source of information included in the top_stories_element */
|
|
|
10573
10606
|
source?: string | undefined;
|
|
10574
10607
|
[key: string]: any;
|
|
10575
10608
|
}
|
|
10609
|
+
export declare class CompareSitesSerpElementItem extends BaseSerpElementItem implements ICompareSitesSerpElementItem {
|
|
10610
|
+
/** group rank in SERP
|
|
10611
|
+
position within a group of elements with identical type values;
|
|
10612
|
+
positions of elements with different type values are omitted from rank_group;
|
|
10613
|
+
always equals 0 for desktop */
|
|
10614
|
+
rank_group?: number | undefined;
|
|
10615
|
+
/** absolute rank in SERP
|
|
10616
|
+
absolute position among all the elements in SERP
|
|
10617
|
+
always equals 0 for desktop */
|
|
10618
|
+
rank_absolute?: number | undefined;
|
|
10619
|
+
/** the alignment of the element in SERP
|
|
10620
|
+
can take the following values:
|
|
10621
|
+
left, right */
|
|
10622
|
+
position?: string | undefined;
|
|
10623
|
+
/** the XPath of the element */
|
|
10624
|
+
xpath?: string | undefined;
|
|
10625
|
+
/** title of the row */
|
|
10626
|
+
title?: string | undefined;
|
|
10627
|
+
/** additional items present in the element
|
|
10628
|
+
if there are none, equals null */
|
|
10629
|
+
items?: (CompareSitesElement | undefined)[] | undefined;
|
|
10630
|
+
/** rectangle parameters
|
|
10631
|
+
contains cartesian coordinates and pixel dimensions of the result’s snippet in SERP
|
|
10632
|
+
equals null if calculate_rectangles in the POST request is not set to true */
|
|
10633
|
+
rectangle?: Rectangle | undefined;
|
|
10634
|
+
[key: string]: any;
|
|
10635
|
+
constructor(data?: ICompareSitesSerpElementItem);
|
|
10636
|
+
init(_data?: any): void;
|
|
10637
|
+
static fromJS(data: any): CompareSitesSerpElementItem;
|
|
10638
|
+
toJSON(data?: any): any;
|
|
10639
|
+
}
|
|
10640
|
+
export interface ICompareSitesSerpElementItem extends IBaseSerpElementItem {
|
|
10641
|
+
/** group rank in SERP
|
|
10642
|
+
position within a group of elements with identical type values;
|
|
10643
|
+
positions of elements with different type values are omitted from rank_group;
|
|
10644
|
+
always equals 0 for desktop */
|
|
10645
|
+
rank_group?: number | undefined;
|
|
10646
|
+
/** absolute rank in SERP
|
|
10647
|
+
absolute position among all the elements in SERP
|
|
10648
|
+
always equals 0 for desktop */
|
|
10649
|
+
rank_absolute?: number | undefined;
|
|
10650
|
+
/** the alignment of the element in SERP
|
|
10651
|
+
can take the following values:
|
|
10652
|
+
left, right */
|
|
10653
|
+
position?: string | undefined;
|
|
10654
|
+
/** the XPath of the element */
|
|
10655
|
+
xpath?: string | undefined;
|
|
10656
|
+
/** title of the row */
|
|
10657
|
+
title?: string | undefined;
|
|
10658
|
+
/** additional items present in the element
|
|
10659
|
+
if there are none, equals null */
|
|
10660
|
+
items?: (CompareSitesElement | undefined)[] | undefined;
|
|
10661
|
+
/** rectangle parameters
|
|
10662
|
+
contains cartesian coordinates and pixel dimensions of the result’s snippet in SERP
|
|
10663
|
+
equals null if calculate_rectangles in the POST request is not set to true */
|
|
10664
|
+
rectangle?: Rectangle | undefined;
|
|
10665
|
+
[key: string]: any;
|
|
10666
|
+
}
|
|
10667
|
+
export declare class CoursesElement implements ICoursesElement {
|
|
10668
|
+
/** type of element */
|
|
10669
|
+
type?: string | undefined;
|
|
10670
|
+
/** title of a given link element */
|
|
10671
|
+
title?: string | undefined;
|
|
10672
|
+
/** URL */
|
|
10673
|
+
url?: string | undefined;
|
|
10674
|
+
/** website domain */
|
|
10675
|
+
domain?: string | undefined;
|
|
10676
|
+
/** source of the element
|
|
10677
|
+
indicates the source of information included in the top_stories_element */
|
|
10678
|
+
source?: string | undefined;
|
|
10679
|
+
/** description */
|
|
10680
|
+
description?: string | undefined;
|
|
10681
|
+
/** the date when the page source of the element was published */
|
|
10682
|
+
date?: string | undefined;
|
|
10683
|
+
/** URL of the image */
|
|
10684
|
+
image_url?: string | undefined;
|
|
10685
|
+
/** the item’s rating
|
|
10686
|
+
the popularity rate based on reviews and displayed in SERP */
|
|
10687
|
+
rating?: RatingInfo | undefined;
|
|
10688
|
+
[key: string]: any;
|
|
10689
|
+
constructor(data?: ICoursesElement);
|
|
10690
|
+
init(_data?: any): void;
|
|
10691
|
+
static fromJS(data: any): CoursesElement;
|
|
10692
|
+
toJSON(data?: any): any;
|
|
10693
|
+
}
|
|
10694
|
+
export interface ICoursesElement {
|
|
10695
|
+
/** type of element */
|
|
10696
|
+
type?: string | undefined;
|
|
10697
|
+
/** title of a given link element */
|
|
10698
|
+
title?: string | undefined;
|
|
10699
|
+
/** URL */
|
|
10700
|
+
url?: string | undefined;
|
|
10701
|
+
/** website domain */
|
|
10702
|
+
domain?: string | undefined;
|
|
10703
|
+
/** source of the element
|
|
10704
|
+
indicates the source of information included in the top_stories_element */
|
|
10705
|
+
source?: string | undefined;
|
|
10706
|
+
/** description */
|
|
10707
|
+
description?: string | undefined;
|
|
10708
|
+
/** the date when the page source of the element was published */
|
|
10709
|
+
date?: string | undefined;
|
|
10710
|
+
/** URL of the image */
|
|
10711
|
+
image_url?: string | undefined;
|
|
10712
|
+
/** the item’s rating
|
|
10713
|
+
the popularity rate based on reviews and displayed in SERP */
|
|
10714
|
+
rating?: RatingInfo | undefined;
|
|
10715
|
+
[key: string]: any;
|
|
10716
|
+
}
|
|
10576
10717
|
export declare class SerpGoogleOrganicTaskGetAdvancedResultInfo implements ISerpGoogleOrganicTaskGetAdvancedResultInfo {
|
|
10577
10718
|
/** keyword received in a POST array
|
|
10578
10719
|
the keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character) */
|
|
@@ -10599,7 +10740,7 @@ if the search engine provided results for a keyword that was corrected, we will
|
|
|
10599
10740
|
/** types of search results in SERP
|
|
10600
10741
|
contains types of search results (items) found in SERP.
|
|
10601
10742
|
possible item types:
|
|
10602
|
-
answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box,product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums */
|
|
10743
|
+
answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box,product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites */
|
|
10603
10744
|
item_types?: (string | undefined)[] | undefined;
|
|
10604
10745
|
/** total number of results in SERP */
|
|
10605
10746
|
se_results_count?: number | undefined;
|
|
@@ -10639,7 +10780,7 @@ if the search engine provided results for a keyword that was corrected, we will
|
|
|
10639
10780
|
/** types of search results in SERP
|
|
10640
10781
|
contains types of search results (items) found in SERP.
|
|
10641
10782
|
possible item types:
|
|
10642
|
-
answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box,product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums */
|
|
10783
|
+
answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box,product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites */
|
|
10643
10784
|
item_types?: (string | undefined)[] | undefined;
|
|
10644
10785
|
/** total number of results in SERP */
|
|
10645
10786
|
se_results_count?: number | undefined;
|
|
@@ -10871,7 +11012,7 @@ a domain or a subdomain should be specified without https:// and www.
|
|
|
10871
11012
|
note that the results of target-specific tasks will only include SERP elements that contain a url string;
|
|
10872
11013
|
you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;
|
|
10873
11014
|
examples:
|
|
10874
|
-
example.com –
|
|
11015
|
+
example.com – returns results for the website’s home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;
|
|
10875
11016
|
example.com* – returns results for the domain, including all its pages;
|
|
10876
11017
|
*example.com* – returns results for the entire domain, including all its pages and subdomains;
|
|
10877
11018
|
*example.com – returns results for the home page regardless of the subdomain, such as https://en.example.com;
|
|
@@ -10995,7 +11136,7 @@ a domain or a subdomain should be specified without https:// and www.
|
|
|
10995
11136
|
note that the results of target-specific tasks will only include SERP elements that contain a url string;
|
|
10996
11137
|
you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;
|
|
10997
11138
|
examples:
|
|
10998
|
-
example.com –
|
|
11139
|
+
example.com – returns results for the website’s home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;
|
|
10999
11140
|
example.com* – returns results for the domain, including all its pages;
|
|
11000
11141
|
*example.com* – returns results for the entire domain, including all its pages and subdomains;
|
|
11001
11142
|
*example.com – returns results for the home page regardless of the subdomain, such as https://en.example.com;
|
|
@@ -11232,7 +11373,7 @@ a domain or a subdomain should be specified without https:// and www.
|
|
|
11232
11373
|
note that the results of target-specific tasks will only include SERP elements that contain a url string;
|
|
11233
11374
|
you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;
|
|
11234
11375
|
examples:
|
|
11235
|
-
example.com –
|
|
11376
|
+
example.com – returns results for the website’s home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;
|
|
11236
11377
|
example.com* – returns results for the domain, including all its pages;
|
|
11237
11378
|
*example.com* – returns results for the entire domain, including all its pages and subdomains;
|
|
11238
11379
|
*example.com – returns results for the home page regardless of the subdomain, such as https://en.example.com;
|
|
@@ -11398,7 +11539,7 @@ a domain or a subdomain should be specified without https:// and www.
|
|
|
11398
11539
|
note that the results of target-specific tasks will only include SERP elements that contain a url string;
|
|
11399
11540
|
you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;
|
|
11400
11541
|
examples:
|
|
11401
|
-
example.com –
|
|
11542
|
+
example.com – returns results for the website’s home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;
|
|
11402
11543
|
example.com* – returns results for the domain, including all its pages;
|
|
11403
11544
|
*example.com* – returns results for the entire domain, including all its pages and subdomains;
|
|
11404
11545
|
*example.com – returns results for the home page regardless of the subdomain, such as https://en.example.com;
|
|
@@ -11491,7 +11632,7 @@ if the search engine provided results for a keyword that was corrected, we will
|
|
|
11491
11632
|
/** types of search results in SERP
|
|
11492
11633
|
contains types of search results (items) found in SERP.
|
|
11493
11634
|
possible item types:
|
|
11494
|
-
answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums */
|
|
11635
|
+
answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites */
|
|
11495
11636
|
item_types?: (string | undefined)[] | undefined;
|
|
11496
11637
|
/** total number of results in SERP */
|
|
11497
11638
|
se_results_count?: number | undefined;
|
|
@@ -11532,7 +11673,7 @@ if the search engine provided results for a keyword that was corrected, we will
|
|
|
11532
11673
|
/** types of search results in SERP
|
|
11533
11674
|
contains types of search results (items) found in SERP.
|
|
11534
11675
|
possible item types:
|
|
11535
|
-
answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums */
|
|
11676
|
+
answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites */
|
|
11536
11677
|
item_types?: (string | undefined)[] | undefined;
|
|
11537
11678
|
/** total number of results in SERP */
|
|
11538
11679
|
se_results_count?: number | undefined;
|
|
@@ -12915,7 +13056,7 @@ example:
|
|
|
12915
13056
|
required field if you don’t specify location_name or location_code
|
|
12916
13057
|
if you use this field, you don’t need to specify location_name or location_code
|
|
12917
13058
|
location_coordinate parameter should be specified in the “latitude,longitude,zoom” format
|
|
12918
|
-
if “zoom” is not specified,
|
|
13059
|
+
if “zoom” is not specified, 9z will be applied as a default value
|
|
12919
13060
|
the maximum number of decimal digits for “latitude” and “longitude”: 7
|
|
12920
13061
|
the minimum value for “zoom”: 4z
|
|
12921
13062
|
the maximum value for “zoom”: 18z
|
|
@@ -13043,7 +13184,7 @@ example:
|
|
|
13043
13184
|
required field if you don’t specify location_name or location_code
|
|
13044
13185
|
if you use this field, you don’t need to specify location_name or location_code
|
|
13045
13186
|
location_coordinate parameter should be specified in the “latitude,longitude,zoom” format
|
|
13046
|
-
if “zoom” is not specified,
|
|
13187
|
+
if “zoom” is not specified, 9z will be applied as a default value
|
|
13047
13188
|
the maximum number of decimal digits for “latitude” and “longitude”: 7
|
|
13048
13189
|
the minimum value for “zoom”: 4z
|
|
13049
13190
|
the maximum value for “zoom”: 18z
|
|
@@ -13539,7 +13680,7 @@ example:
|
|
|
13539
13680
|
required field if you don’t specify location_name or location_code
|
|
13540
13681
|
if you use this field, you don’t need to specify location_name or location_code
|
|
13541
13682
|
location_coordinate parameter should be specified in the “latitude,longitude,zoom” format
|
|
13542
|
-
if “zoom” is not specified,
|
|
13683
|
+
if “zoom” is not specified, 9z will be applied as a default value
|
|
13543
13684
|
the maximum number of decimal digits for “latitude” and “longitude”: 7
|
|
13544
13685
|
the minimum value for “zoom”: 4z
|
|
13545
13686
|
the maximum value for “zoom”: 18z
|
|
@@ -13642,7 +13783,7 @@ example:
|
|
|
13642
13783
|
required field if you don’t specify location_name or location_code
|
|
13643
13784
|
if you use this field, you don’t need to specify location_name or location_code
|
|
13644
13785
|
location_coordinate parameter should be specified in the “latitude,longitude,zoom” format
|
|
13645
|
-
if “zoom” is not specified,
|
|
13786
|
+
if “zoom” is not specified, 9z will be applied as a default value
|
|
13646
13787
|
the maximum number of decimal digits for “latitude” and “longitude”: 7
|
|
13647
13788
|
the minimum value for “zoom”: 4z
|
|
13648
13789
|
the maximum value for “zoom”: 18z
|
|
@@ -13845,7 +13986,7 @@ example:
|
|
|
13845
13986
|
required field if you don’t specify location_name or location_code
|
|
13846
13987
|
if you use this field, you don’t need to specify location_name or location_code
|
|
13847
13988
|
location_coordinate parameter should be specified in the “latitude,longitude,zoom” format
|
|
13848
|
-
if “zoom” is not specified,
|
|
13989
|
+
if “zoom” is not specified, 9z will be applied as a default value
|
|
13849
13990
|
the maximum number of decimal digits for “latitude” and “longitude”: 7
|
|
13850
13991
|
the minimum value for “zoom”: 4z
|
|
13851
13992
|
the maximum value for “zoom”: 18z
|
|
@@ -13948,7 +14089,7 @@ example:
|
|
|
13948
14089
|
required field if you don’t specify location_name or location_code
|
|
13949
14090
|
if you use this field, you don’t need to specify location_name or location_code
|
|
13950
14091
|
location_coordinate parameter should be specified in the “latitude,longitude,zoom” format
|
|
13951
|
-
if “zoom” is not specified,
|
|
14092
|
+
if “zoom” is not specified, 9z will be applied as a default value
|
|
13952
14093
|
the maximum number of decimal digits for “latitude” and “longitude”: 7
|
|
13953
14094
|
the minimum value for “zoom”: 4z
|
|
13954
14095
|
the maximum value for “zoom”: 18z
|
|
@@ -18051,6 +18192,12 @@ Note: only available for the following client:
|
|
|
18051
18192
|
gws-wiz
|
|
18052
18193
|
gws-wiz-serp */
|
|
18053
18194
|
thumbnail_url?: string | undefined;
|
|
18195
|
+
/** keywords highlighted in autocomplete
|
|
18196
|
+
contains a list of google autocomplete suggestions that are highlighted in the search bar;
|
|
18197
|
+
Note: array is only available for the following client:
|
|
18198
|
+
gws-wiz
|
|
18199
|
+
psy-ab
|
|
18200
|
+
gws-wiz-local */
|
|
18054
18201
|
highlighted?: (string | undefined)[] | undefined;
|
|
18055
18202
|
[key: string]: any;
|
|
18056
18203
|
constructor(data?: IAutocompleteSerpElementItem);
|
|
@@ -18088,6 +18235,12 @@ Note: only available for the following client:
|
|
|
18088
18235
|
gws-wiz
|
|
18089
18236
|
gws-wiz-serp */
|
|
18090
18237
|
thumbnail_url?: string | undefined;
|
|
18238
|
+
/** keywords highlighted in autocomplete
|
|
18239
|
+
contains a list of google autocomplete suggestions that are highlighted in the search bar;
|
|
18240
|
+
Note: array is only available for the following client:
|
|
18241
|
+
gws-wiz
|
|
18242
|
+
psy-ab
|
|
18243
|
+
gws-wiz-local */
|
|
18091
18244
|
highlighted?: (string | undefined)[] | undefined;
|
|
18092
18245
|
[key: string]: any;
|
|
18093
18246
|
}
|
|
@@ -27959,30 +28112,30 @@ export interface IDomainAnalyticsTechnologiesTechnologiesResponseInfo extends IB
|
|
|
27959
28112
|
}
|
|
27960
28113
|
export declare class DomainAnalyticsTechnologiesAggregationTechnologiesLiveRequestInfo implements IDomainAnalyticsTechnologiesAggregationTechnologiesLiveRequestInfo {
|
|
27961
28114
|
/** id of the target technology group
|
|
27962
|
-
required field if you don’t specify technology or
|
|
27963
|
-
at least one field (group, category, technology) must be set
|
|
28115
|
+
required field if you don’t specify technology, category or keyword
|
|
28116
|
+
at least one field (group, category, keyword, technology) must be set
|
|
27964
28117
|
you can find the full list of technology group ids on this page
|
|
27965
28118
|
example:
|
|
27966
28119
|
"marketing" */
|
|
27967
28120
|
group?: string | undefined;
|
|
27968
28121
|
/** id of the target technology category
|
|
27969
|
-
required field if you don’t specify group or technology
|
|
27970
|
-
at least one field (group, category, technology) must be set
|
|
28122
|
+
required field if you don’t specify group, keyword or technology
|
|
28123
|
+
at least one field (group, category, keyword, technology) must be set
|
|
27971
28124
|
you can find the full list of technology category ids on this page
|
|
27972
28125
|
example:
|
|
27973
28126
|
"crm" */
|
|
27974
28127
|
category?: string | undefined;
|
|
27975
28128
|
/** target technology
|
|
27976
|
-
required field if you don’t specify group or category
|
|
27977
|
-
at least one field (group, category, technology) must be set
|
|
28129
|
+
required field if you don’t specify group, keyword or category
|
|
28130
|
+
at least one field (group, category, keyword, technology) must be set
|
|
27978
28131
|
you can find the full list of technologies on this page
|
|
27979
28132
|
example:
|
|
27980
28133
|
"Salesforce" */
|
|
27981
28134
|
technology?: string | undefined;
|
|
27982
28135
|
/** target keyword in the domain’s meta keywords
|
|
27983
|
-
|
|
28136
|
+
required field if you don’t specify group, category or technology
|
|
28137
|
+
at least one field (group, category, keyword, technology) must be set
|
|
27984
28138
|
UTF-8 encoding
|
|
27985
|
-
each keyword should be at least 3 characters long
|
|
27986
28139
|
example:
|
|
27987
28140
|
"seo" */
|
|
27988
28141
|
keyword?: string | undefined;
|
|
@@ -28001,6 +28154,7 @@ the following operators are supported:
|
|
|
28001
28154
|
<, <=, >, >=, =, <>, in, not_in, like,not_like
|
|
28002
28155
|
you can use the % operator with like and not_like to match any string of zero or more characters
|
|
28003
28156
|
you can use the following parameters to filter the results: domain_rank, last_visited, country_iso_code, language_code, content_language_code
|
|
28157
|
+
Note: all filtering parameters are taken from the domain_technology_item of the domain_technologies endpoint;
|
|
28004
28158
|
example:
|
|
28005
28159
|
[["country_iso_code","=","US"],
|
|
28006
28160
|
"and",
|
|
@@ -28026,18 +28180,21 @@ default value:
|
|
|
28026
28180
|
optional field
|
|
28027
28181
|
you can use this field to limit the number of items with identical "group" in the results
|
|
28028
28182
|
default value: 5
|
|
28183
|
+
minimum value: 1
|
|
28029
28184
|
maximum value: 10000 */
|
|
28030
28185
|
internal_groups_list_limit?: number | undefined;
|
|
28031
28186
|
/** maximum number of returned technology categories within the same group
|
|
28032
28187
|
optional field
|
|
28033
28188
|
you can use this field to limit the number of items with identical "category" in the results
|
|
28034
28189
|
default value: 5
|
|
28190
|
+
minimum value: 1
|
|
28035
28191
|
maximum value: 10000 */
|
|
28036
28192
|
internal_categories_list_limit?: number | undefined;
|
|
28037
28193
|
/** maximum number of returned technologies within the same category
|
|
28038
28194
|
optional field
|
|
28039
28195
|
you can use this field to limit the number of items with identical "technology" in the results
|
|
28040
28196
|
default value: 10
|
|
28197
|
+
minimum value: 1
|
|
28041
28198
|
maximum value: 10000 */
|
|
28042
28199
|
internal_technologies_list_limit?: number | undefined;
|
|
28043
28200
|
/** maximum number of items with identical "category", "group", and "technology"
|
|
@@ -28045,6 +28202,7 @@ optional field
|
|
|
28045
28202
|
if you use this field, the values specified in internal_groups_list_limit, internal_categories_list_limit and internal_technologies_list_limit will be ignored;
|
|
28046
28203
|
you can use this field to limit the number of items with identical "category", "group", or "technology"
|
|
28047
28204
|
default value: 10
|
|
28205
|
+
minimum value: 1
|
|
28048
28206
|
maximum value: 10000 */
|
|
28049
28207
|
internal_list_limit?: number | undefined;
|
|
28050
28208
|
/** the maximum number of returned technologies
|
|
@@ -28072,30 +28230,30 @@ you will find the specified tag value in the data object of the response */
|
|
|
28072
28230
|
}
|
|
28073
28231
|
export interface IDomainAnalyticsTechnologiesAggregationTechnologiesLiveRequestInfo {
|
|
28074
28232
|
/** id of the target technology group
|
|
28075
|
-
required field if you don’t specify technology or
|
|
28076
|
-
at least one field (group, category, technology) must be set
|
|
28233
|
+
required field if you don’t specify technology, category or keyword
|
|
28234
|
+
at least one field (group, category, keyword, technology) must be set
|
|
28077
28235
|
you can find the full list of technology group ids on this page
|
|
28078
28236
|
example:
|
|
28079
28237
|
"marketing" */
|
|
28080
28238
|
group?: string | undefined;
|
|
28081
28239
|
/** id of the target technology category
|
|
28082
|
-
required field if you don’t specify group or technology
|
|
28083
|
-
at least one field (group, category, technology) must be set
|
|
28240
|
+
required field if you don’t specify group, keyword or technology
|
|
28241
|
+
at least one field (group, category, keyword, technology) must be set
|
|
28084
28242
|
you can find the full list of technology category ids on this page
|
|
28085
28243
|
example:
|
|
28086
28244
|
"crm" */
|
|
28087
28245
|
category?: string | undefined;
|
|
28088
28246
|
/** target technology
|
|
28089
|
-
required field if you don’t specify group or category
|
|
28090
|
-
at least one field (group, category, technology) must be set
|
|
28247
|
+
required field if you don’t specify group, keyword or category
|
|
28248
|
+
at least one field (group, category, keyword, technology) must be set
|
|
28091
28249
|
you can find the full list of technologies on this page
|
|
28092
28250
|
example:
|
|
28093
28251
|
"Salesforce" */
|
|
28094
28252
|
technology?: string | undefined;
|
|
28095
28253
|
/** target keyword in the domain’s meta keywords
|
|
28096
|
-
|
|
28254
|
+
required field if you don’t specify group, category or technology
|
|
28255
|
+
at least one field (group, category, keyword, technology) must be set
|
|
28097
28256
|
UTF-8 encoding
|
|
28098
|
-
each keyword should be at least 3 characters long
|
|
28099
28257
|
example:
|
|
28100
28258
|
"seo" */
|
|
28101
28259
|
keyword?: string | undefined;
|
|
@@ -28114,6 +28272,7 @@ the following operators are supported:
|
|
|
28114
28272
|
<, <=, >, >=, =, <>, in, not_in, like,not_like
|
|
28115
28273
|
you can use the % operator with like and not_like to match any string of zero or more characters
|
|
28116
28274
|
you can use the following parameters to filter the results: domain_rank, last_visited, country_iso_code, language_code, content_language_code
|
|
28275
|
+
Note: all filtering parameters are taken from the domain_technology_item of the domain_technologies endpoint;
|
|
28117
28276
|
example:
|
|
28118
28277
|
[["country_iso_code","=","US"],
|
|
28119
28278
|
"and",
|
|
@@ -28139,18 +28298,21 @@ default value:
|
|
|
28139
28298
|
optional field
|
|
28140
28299
|
you can use this field to limit the number of items with identical "group" in the results
|
|
28141
28300
|
default value: 5
|
|
28301
|
+
minimum value: 1
|
|
28142
28302
|
maximum value: 10000 */
|
|
28143
28303
|
internal_groups_list_limit?: number | undefined;
|
|
28144
28304
|
/** maximum number of returned technology categories within the same group
|
|
28145
28305
|
optional field
|
|
28146
28306
|
you can use this field to limit the number of items with identical "category" in the results
|
|
28147
28307
|
default value: 5
|
|
28308
|
+
minimum value: 1
|
|
28148
28309
|
maximum value: 10000 */
|
|
28149
28310
|
internal_categories_list_limit?: number | undefined;
|
|
28150
28311
|
/** maximum number of returned technologies within the same category
|
|
28151
28312
|
optional field
|
|
28152
28313
|
you can use this field to limit the number of items with identical "technology" in the results
|
|
28153
28314
|
default value: 10
|
|
28315
|
+
minimum value: 1
|
|
28154
28316
|
maximum value: 10000 */
|
|
28155
28317
|
internal_technologies_list_limit?: number | undefined;
|
|
28156
28318
|
/** maximum number of items with identical "category", "group", and "technology"
|
|
@@ -28158,6 +28320,7 @@ optional field
|
|
|
28158
28320
|
if you use this field, the values specified in internal_groups_list_limit, internal_categories_list_limit and internal_technologies_list_limit will be ignored;
|
|
28159
28321
|
you can use this field to limit the number of items with identical "category", "group", or "technology"
|
|
28160
28322
|
default value: 10
|
|
28323
|
+
minimum value: 1
|
|
28161
28324
|
maximum value: 10000 */
|
|
28162
28325
|
internal_list_limit?: number | undefined;
|
|
28163
28326
|
/** the maximum number of returned technologies
|
|
@@ -28290,30 +28453,30 @@ example:
|
|
|
28290
28453
|
[{"path": "content.cms","name": "wordpress"}, {"path": "marketing.crm","name": "salesforce"}] */
|
|
28291
28454
|
technology_paths?: string[] | undefined;
|
|
28292
28455
|
/** ids of the target technology groups
|
|
28293
|
-
required field if you don’t specify technologies, technology_paths or
|
|
28456
|
+
required field if you don’t specify technologies, technology_paths, categories, or keywords
|
|
28294
28457
|
you can find the full list of technology group ids on this page
|
|
28295
28458
|
note: you can specify up to 10 technology groups in this array
|
|
28296
28459
|
example:
|
|
28297
28460
|
["sales", "marketing"] */
|
|
28298
28461
|
groups?: string[] | undefined;
|
|
28299
28462
|
/** ids of the target technology categories
|
|
28300
|
-
required field if you don’t specify groups, technology_paths or
|
|
28463
|
+
required field if you don’t specify groups, technology_paths, technologies, or keywords
|
|
28301
28464
|
you can find the full list of technology category ids on this page
|
|
28302
28465
|
note: you can specify up to 10 technology categories in this array
|
|
28303
28466
|
example:
|
|
28304
28467
|
["payment_processors","crm"] */
|
|
28305
28468
|
categories?: string[] | undefined;
|
|
28306
28469
|
/** target technologies
|
|
28307
|
-
required field if you don’t specify groups, technology_paths or
|
|
28470
|
+
required field if you don’t specify groups, technology_paths, categories, or keywords
|
|
28308
28471
|
you can find the full list of technologies you can specify here on this page
|
|
28309
28472
|
note: you can specify up to 10 technologies in this array
|
|
28310
28473
|
example:
|
|
28311
28474
|
["Google Pay","Salesforce"] */
|
|
28312
28475
|
technologies?: string[] | undefined;
|
|
28313
28476
|
/** target keywords in the domain’s title, description or meta keywords
|
|
28314
|
-
|
|
28315
|
-
|
|
28316
|
-
|
|
28477
|
+
required field if you don’t specify groups, technology_paths, categories, or technologies
|
|
28478
|
+
you can specify the maximum of 10 keywords;
|
|
28479
|
+
UTF-8 encoding;
|
|
28317
28480
|
example:
|
|
28318
28481
|
["seo","software"] */
|
|
28319
28482
|
keywords?: string[] | undefined;
|
|
@@ -28343,6 +28506,7 @@ optional field
|
|
|
28343
28506
|
you can use this field to limit the number of elements within the following arrays:
|
|
28344
28507
|
countries, languages, content_languages, keywords
|
|
28345
28508
|
default value: 10
|
|
28509
|
+
minimum value: 1
|
|
28346
28510
|
maximum value: 10000 */
|
|
28347
28511
|
internal_list_limit?: number | undefined;
|
|
28348
28512
|
/** user-defined task identifier
|
|
@@ -28368,30 +28532,30 @@ example:
|
|
|
28368
28532
|
[{"path": "content.cms","name": "wordpress"}, {"path": "marketing.crm","name": "salesforce"}] */
|
|
28369
28533
|
technology_paths?: string[] | undefined;
|
|
28370
28534
|
/** ids of the target technology groups
|
|
28371
|
-
required field if you don’t specify technologies, technology_paths or
|
|
28535
|
+
required field if you don’t specify technologies, technology_paths, categories, or keywords
|
|
28372
28536
|
you can find the full list of technology group ids on this page
|
|
28373
28537
|
note: you can specify up to 10 technology groups in this array
|
|
28374
28538
|
example:
|
|
28375
28539
|
["sales", "marketing"] */
|
|
28376
28540
|
groups?: string[] | undefined;
|
|
28377
28541
|
/** ids of the target technology categories
|
|
28378
|
-
required field if you don’t specify groups, technology_paths or
|
|
28542
|
+
required field if you don’t specify groups, technology_paths, technologies, or keywords
|
|
28379
28543
|
you can find the full list of technology category ids on this page
|
|
28380
28544
|
note: you can specify up to 10 technology categories in this array
|
|
28381
28545
|
example:
|
|
28382
28546
|
["payment_processors","crm"] */
|
|
28383
28547
|
categories?: string[] | undefined;
|
|
28384
28548
|
/** target technologies
|
|
28385
|
-
required field if you don’t specify groups, technology_paths or
|
|
28549
|
+
required field if you don’t specify groups, technology_paths, categories, or keywords
|
|
28386
28550
|
you can find the full list of technologies you can specify here on this page
|
|
28387
28551
|
note: you can specify up to 10 technologies in this array
|
|
28388
28552
|
example:
|
|
28389
28553
|
["Google Pay","Salesforce"] */
|
|
28390
28554
|
technologies?: string[] | undefined;
|
|
28391
28555
|
/** target keywords in the domain’s title, description or meta keywords
|
|
28392
|
-
|
|
28393
|
-
|
|
28394
|
-
|
|
28556
|
+
required field if you don’t specify groups, technology_paths, categories, or technologies
|
|
28557
|
+
you can specify the maximum of 10 keywords;
|
|
28558
|
+
UTF-8 encoding;
|
|
28395
28559
|
example:
|
|
28396
28560
|
["seo","software"] */
|
|
28397
28561
|
keywords?: string[] | undefined;
|
|
@@ -28421,6 +28585,7 @@ optional field
|
|
|
28421
28585
|
you can use this field to limit the number of elements within the following arrays:
|
|
28422
28586
|
countries, languages, content_languages, keywords
|
|
28423
28587
|
default value: 10
|
|
28588
|
+
minimum value: 1
|
|
28424
28589
|
maximum value: 10000 */
|
|
28425
28590
|
internal_list_limit?: number | undefined;
|
|
28426
28591
|
/** user-defined task identifier
|
|
@@ -28689,7 +28854,8 @@ export interface IDomainAnalyticsTechnologiesTechnologyStatsLiveResponseInfo ext
|
|
|
28689
28854
|
}
|
|
28690
28855
|
export declare class DomainAnalyticsTechnologiesDomainsByTechnologyLiveRequestInfo implements IDomainAnalyticsTechnologiesDomainsByTechnologyLiveRequestInfo {
|
|
28691
28856
|
/** target technology paths
|
|
28692
|
-
required field if you don’t specify groups, technologies
|
|
28857
|
+
required field if you don’t specify groups, technologies, keywords or categories
|
|
28858
|
+
at least one field (technology_paths, groups, technologies, keywords or categories) must be set;
|
|
28693
28859
|
each technology path should be specified as a separate object containing “path” and “name”, where “path” is specified as “$group_id.$category_id” and “name” – as the name of the target technology;
|
|
28694
28860
|
each object with a technology path should be separated with a comma
|
|
28695
28861
|
you can find the full list of technology group ids, category ids and technology names on this page
|
|
@@ -28698,30 +28864,31 @@ example:
|
|
|
28698
28864
|
[{"path": "content.cms","name": "wordpress"}, {"path": "marketing.crm","name": "salesforce"}] */
|
|
28699
28865
|
technology_paths?: string[] | undefined;
|
|
28700
28866
|
/** ids of the target technology groups
|
|
28701
|
-
required field if you don’t specify technologies, technology_paths or categories
|
|
28867
|
+
required field if you don’t specify technologies, technology_paths, keywords or categories
|
|
28702
28868
|
you can find the full list of technology group ids on this page
|
|
28703
28869
|
note: you can specify up to 10 technology groups in this array
|
|
28704
28870
|
example:
|
|
28705
28871
|
["sales", "marketing"] */
|
|
28706
28872
|
groups?: string[] | undefined;
|
|
28707
28873
|
/** ids of the target technology categories
|
|
28708
|
-
required field if you don’t specify groups, technology_paths or technologies
|
|
28874
|
+
required field if you don’t specify groups, technology_paths, keywords or technologies
|
|
28709
28875
|
you can find the full list of technology category ids on this page
|
|
28710
28876
|
note: you can specify up to 10 technology categories in this array
|
|
28711
28877
|
example:
|
|
28712
28878
|
["payment_processors","crm"] */
|
|
28713
28879
|
categories?: string[] | undefined;
|
|
28714
28880
|
/** target technologies
|
|
28715
|
-
required field if you don’t specify groups, technology_paths or categories
|
|
28881
|
+
required field if you don’t specify groups, technology_paths, keywords or categories
|
|
28716
28882
|
you can find the full list of technologies you can specify here on this page
|
|
28717
28883
|
note: you can specify up to 10 technologies in this array
|
|
28718
28884
|
example:
|
|
28719
28885
|
["Google Pay","Salesforce"] */
|
|
28720
28886
|
technologies?: string[] | undefined;
|
|
28721
28887
|
/** target keywords in the domain’s title, description or meta keywords
|
|
28888
|
+
required field if you don’t specify groups, technology_paths, technologies or categories
|
|
28722
28889
|
optional field
|
|
28723
|
-
|
|
28724
|
-
|
|
28890
|
+
you can specify the maximum of 10 keywords;
|
|
28891
|
+
UTF-8 encoding;
|
|
28725
28892
|
example:
|
|
28726
28893
|
["seo","software"] */
|
|
28727
28894
|
keywords?: string[] | undefined;
|
|
@@ -28794,7 +28961,8 @@ Note: if the offset_token is specified in the request, all other parameters shou
|
|
|
28794
28961
|
}
|
|
28795
28962
|
export interface IDomainAnalyticsTechnologiesDomainsByTechnologyLiveRequestInfo {
|
|
28796
28963
|
/** target technology paths
|
|
28797
|
-
required field if you don’t specify groups, technologies
|
|
28964
|
+
required field if you don’t specify groups, technologies, keywords or categories
|
|
28965
|
+
at least one field (technology_paths, groups, technologies, keywords or categories) must be set;
|
|
28798
28966
|
each technology path should be specified as a separate object containing “path” and “name”, where “path” is specified as “$group_id.$category_id” and “name” – as the name of the target technology;
|
|
28799
28967
|
each object with a technology path should be separated with a comma
|
|
28800
28968
|
you can find the full list of technology group ids, category ids and technology names on this page
|
|
@@ -28803,30 +28971,31 @@ example:
|
|
|
28803
28971
|
[{"path": "content.cms","name": "wordpress"}, {"path": "marketing.crm","name": "salesforce"}] */
|
|
28804
28972
|
technology_paths?: string[] | undefined;
|
|
28805
28973
|
/** ids of the target technology groups
|
|
28806
|
-
required field if you don’t specify technologies, technology_paths or categories
|
|
28974
|
+
required field if you don’t specify technologies, technology_paths, keywords or categories
|
|
28807
28975
|
you can find the full list of technology group ids on this page
|
|
28808
28976
|
note: you can specify up to 10 technology groups in this array
|
|
28809
28977
|
example:
|
|
28810
28978
|
["sales", "marketing"] */
|
|
28811
28979
|
groups?: string[] | undefined;
|
|
28812
28980
|
/** ids of the target technology categories
|
|
28813
|
-
required field if you don’t specify groups, technology_paths or technologies
|
|
28981
|
+
required field if you don’t specify groups, technology_paths, keywords or technologies
|
|
28814
28982
|
you can find the full list of technology category ids on this page
|
|
28815
28983
|
note: you can specify up to 10 technology categories in this array
|
|
28816
28984
|
example:
|
|
28817
28985
|
["payment_processors","crm"] */
|
|
28818
28986
|
categories?: string[] | undefined;
|
|
28819
28987
|
/** target technologies
|
|
28820
|
-
required field if you don’t specify groups, technology_paths or categories
|
|
28988
|
+
required field if you don’t specify groups, technology_paths, keywords or categories
|
|
28821
28989
|
you can find the full list of technologies you can specify here on this page
|
|
28822
28990
|
note: you can specify up to 10 technologies in this array
|
|
28823
28991
|
example:
|
|
28824
28992
|
["Google Pay","Salesforce"] */
|
|
28825
28993
|
technologies?: string[] | undefined;
|
|
28826
28994
|
/** target keywords in the domain’s title, description or meta keywords
|
|
28995
|
+
required field if you don’t specify groups, technology_paths, technologies or categories
|
|
28827
28996
|
optional field
|
|
28828
|
-
|
|
28829
|
-
|
|
28997
|
+
you can specify the maximum of 10 keywords;
|
|
28998
|
+
UTF-8 encoding;
|
|
28830
28999
|
example:
|
|
28831
29000
|
["seo","software"] */
|
|
28832
29001
|
keywords?: string[] | undefined;
|
|
@@ -29059,7 +29228,6 @@ example:
|
|
|
29059
29228
|
/** target keywords in the domain’s title, description or meta keywords
|
|
29060
29229
|
optional field
|
|
29061
29230
|
UTF-8 encoding
|
|
29062
|
-
each keyword should be at least 3 characters long
|
|
29063
29231
|
maximum number of keywords you can specify: 10
|
|
29064
29232
|
example:
|
|
29065
29233
|
["seo","software"] */
|
|
@@ -29143,7 +29311,6 @@ example:
|
|
|
29143
29311
|
/** target keywords in the domain’s title, description or meta keywords
|
|
29144
29312
|
optional field
|
|
29145
29313
|
UTF-8 encoding
|
|
29146
|
-
each keyword should be at least 3 characters long
|
|
29147
29314
|
maximum number of keywords you can specify: 10
|
|
29148
29315
|
example:
|
|
29149
29316
|
["seo","software"] */
|
|
@@ -30799,124 +30966,140 @@ optional field
|
|
|
30799
30966
|
if set to false, the subdomains will be ignored
|
|
30800
30967
|
default value: true */
|
|
30801
30968
|
include_subdomains?: boolean | undefined;
|
|
30802
|
-
/**
|
|
30803
|
-
optional field
|
|
30804
|
-
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
|
|
30805
|
-
default value: false */
|
|
30806
|
-
ignore_synonyms?: boolean | undefined;
|
|
30807
|
-
/** the maximum number of keywords in the results array
|
|
30808
|
-
optional field
|
|
30809
|
-
default value: 100
|
|
30810
|
-
maximum value: 1000 */
|
|
30811
|
-
limit?: number | undefined;
|
|
30812
|
-
/** offset in the results array of returned keywords
|
|
30813
|
-
optional field
|
|
30814
|
-
default value: 0
|
|
30815
|
-
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
|
|
30816
|
-
offset?: number | undefined;
|
|
30817
|
-
/** offset token for subsequent requests
|
|
30818
|
-
optional field
|
|
30819
|
-
provided in the identical filed of the response to each request;
|
|
30820
|
-
use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;
|
|
30821
|
-
by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;
|
|
30822
|
-
offset_token values are unique for each subsequent task
|
|
30823
|
-
Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. */
|
|
30824
|
-
offset_token?: string | undefined;
|
|
30825
|
-
/** array of results filtering parameters
|
|
30826
|
-
optional field
|
|
30827
|
-
you can add several filters at once (8 filters maximum)
|
|
30828
|
-
you should set a logical operator and, or between the conditions
|
|
30829
|
-
the following operators are supported:
|
|
30830
|
-
regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
|
|
30831
|
-
you can use the % operator with like and not_like to match any string of zero or more characters
|
|
30832
|
-
note that you can not filter the results by relevance
|
|
30833
|
-
example:
|
|
30834
|
-
["keyword_info.search_volume",">",0]
|
|
30835
|
-
[["impressions_info.daily_impressions_average","in",[0,1000]],
|
|
30836
|
-
"and",
|
|
30837
|
-
["impressions_info.ad_position_average","<",3]][["impressions_info.ad_position_average",">",0],
|
|
30838
|
-
"and",
|
|
30839
|
-
[["impressions_info.cpc_max","<",0.5],"or",["impressions_info.daily_clicks_max",">=",10]]]
|
|
30840
|
-
for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
|
|
30841
|
-
filters?: (any | undefined)[] | undefined;
|
|
30842
|
-
/** results sorting rules
|
|
30843
|
-
optional field
|
|
30844
|
-
you can use the same values as in the filters array to sort the results
|
|
30845
|
-
possible sorting types:
|
|
30846
|
-
asc – results will be sorted in the ascending order
|
|
30847
|
-
desc – results will be sorted in the descending order
|
|
30848
|
-
you should use a comma to set up a sorting parameter
|
|
30849
|
-
example:
|
|
30850
|
-
["keyword_info.competition,desc"]
|
|
30851
|
-
default rule:
|
|
30852
|
-
["relevance,desc"]
|
|
30853
|
-
relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint.note that you can set no more than three sorting rules in a single request
|
|
30854
|
-
you should use a comma to separate several sorting rules
|
|
30855
|
-
example:
|
|
30856
|
-
["keyword_info.search_volume,desc","keyword_info.cpc,asc"] */
|
|
30857
|
-
order_by?: string[] | undefined;
|
|
30858
|
-
/** user-defined task identifier
|
|
30969
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
30859
30970
|
optional field
|
|
30860
|
-
the
|
|
30861
|
-
|
|
30862
|
-
|
|
30863
|
-
|
|
30864
|
-
|
|
30865
|
-
|
|
30866
|
-
|
|
30867
|
-
|
|
30868
|
-
|
|
30869
|
-
|
|
30870
|
-
|
|
30871
|
-
/**
|
|
30872
|
-
|
|
30873
|
-
|
|
30874
|
-
|
|
30875
|
-
|
|
30876
|
-
/**
|
|
30877
|
-
|
|
30878
|
-
|
|
30879
|
-
you
|
|
30880
|
-
|
|
30881
|
-
|
|
30882
|
-
|
|
30883
|
-
|
|
30884
|
-
|
|
30885
|
-
|
|
30886
|
-
|
|
30887
|
-
|
|
30888
|
-
|
|
30889
|
-
|
|
30890
|
-
|
|
30891
|
-
|
|
30892
|
-
|
|
30893
|
-
|
|
30894
|
-
|
|
30895
|
-
you can
|
|
30896
|
-
|
|
30897
|
-
|
|
30898
|
-
|
|
30899
|
-
|
|
30900
|
-
|
|
30901
|
-
|
|
30902
|
-
|
|
30903
|
-
|
|
30904
|
-
|
|
30905
|
-
|
|
30906
|
-
|
|
30907
|
-
|
|
30908
|
-
|
|
30909
|
-
|
|
30910
|
-
|
|
30911
|
-
|
|
30912
|
-
|
|
30913
|
-
|
|
30914
|
-
|
|
30915
|
-
|
|
30916
|
-
|
|
30917
|
-
|
|
30918
|
-
|
|
30919
|
-
|
|
30971
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
30972
|
+
default value: false
|
|
30973
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
30974
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
30975
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
30976
|
+
include_clickstream_data?: boolean | undefined;
|
|
30977
|
+
/** ignore highly similar keywords
|
|
30978
|
+
optional field
|
|
30979
|
+
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
|
|
30980
|
+
default value: false */
|
|
30981
|
+
ignore_synonyms?: boolean | undefined;
|
|
30982
|
+
/** the maximum number of keywords in the results array
|
|
30983
|
+
optional field
|
|
30984
|
+
default value: 100
|
|
30985
|
+
maximum value: 1000 */
|
|
30986
|
+
limit?: number | undefined;
|
|
30987
|
+
/** offset in the results array of returned keywords
|
|
30988
|
+
optional field
|
|
30989
|
+
default value: 0
|
|
30990
|
+
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
|
|
30991
|
+
offset?: number | undefined;
|
|
30992
|
+
/** offset token for subsequent requests
|
|
30993
|
+
optional field
|
|
30994
|
+
provided in the identical filed of the response to each request;
|
|
30995
|
+
use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;
|
|
30996
|
+
by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;
|
|
30997
|
+
offset_token values are unique for each subsequent task
|
|
30998
|
+
Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. */
|
|
30999
|
+
offset_token?: string | undefined;
|
|
31000
|
+
/** array of results filtering parameters
|
|
31001
|
+
optional field
|
|
31002
|
+
you can add several filters at once (8 filters maximum)
|
|
31003
|
+
you should set a logical operator and, or between the conditions
|
|
31004
|
+
the following operators are supported:
|
|
31005
|
+
regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
|
|
31006
|
+
you can use the % operator with like and not_like to match any string of zero or more characters
|
|
31007
|
+
note that you can not filter the results by relevance
|
|
31008
|
+
example:
|
|
31009
|
+
["keyword_info.search_volume",">",0]
|
|
31010
|
+
[["impressions_info.daily_impressions_average","in",[0,1000]],
|
|
31011
|
+
"and",
|
|
31012
|
+
["impressions_info.ad_position_average","<",3]][["impressions_info.ad_position_average",">",0],
|
|
31013
|
+
"and",
|
|
31014
|
+
[["impressions_info.cpc_max","<",0.5],"or",["impressions_info.daily_clicks_max",">=",10]]]
|
|
31015
|
+
for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
|
|
31016
|
+
filters?: (any | undefined)[] | undefined;
|
|
31017
|
+
/** results sorting rules
|
|
31018
|
+
optional field
|
|
31019
|
+
you can use the same values as in the filters array to sort the results
|
|
31020
|
+
possible sorting types:
|
|
31021
|
+
asc – results will be sorted in the ascending order
|
|
31022
|
+
desc – results will be sorted in the descending order
|
|
31023
|
+
you should use a comma to set up a sorting parameter
|
|
31024
|
+
example:
|
|
31025
|
+
["keyword_info.competition,desc"]
|
|
31026
|
+
default rule:
|
|
31027
|
+
["relevance,desc"]
|
|
31028
|
+
relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint.note that you can set no more than three sorting rules in a single request
|
|
31029
|
+
you should use a comma to separate several sorting rules
|
|
31030
|
+
example:
|
|
31031
|
+
["keyword_info.search_volume,desc","keyword_info.cpc,asc"] */
|
|
31032
|
+
order_by?: string[] | undefined;
|
|
31033
|
+
/** user-defined task identifier
|
|
31034
|
+
optional field
|
|
31035
|
+
the character limit is 255
|
|
31036
|
+
you can use this parameter to identify the task and match it with the result
|
|
31037
|
+
you will find the specified tag value in the data object of the response */
|
|
31038
|
+
tag?: string | undefined;
|
|
31039
|
+
[key: string]: any;
|
|
31040
|
+
constructor(data?: IDataforseoLabsGoogleKeywordsForSiteLiveRequestInfo);
|
|
31041
|
+
init(_data?: any): void;
|
|
31042
|
+
static fromJS(data: any): DataforseoLabsGoogleKeywordsForSiteLiveRequestInfo;
|
|
31043
|
+
toJSON(data?: any): any;
|
|
31044
|
+
}
|
|
31045
|
+
export interface IDataforseoLabsGoogleKeywordsForSiteLiveRequestInfo {
|
|
31046
|
+
/** target domain
|
|
31047
|
+
required field
|
|
31048
|
+
the domain name of the target website
|
|
31049
|
+
the domain should be specified without https:// or www. */
|
|
31050
|
+
target?: string;
|
|
31051
|
+
/** full name of the location
|
|
31052
|
+
required field if you don’t specify location_code
|
|
31053
|
+
Note: it is required to specify either location_name or location_code
|
|
31054
|
+
you can receive the list of available locations with their location_name by making a separate request to the
|
|
31055
|
+
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
|
|
31056
|
+
example:
|
|
31057
|
+
United Kingdom */
|
|
31058
|
+
location_name?: string | undefined;
|
|
31059
|
+
/** unique location identifier
|
|
31060
|
+
required field if you don’t specify location_name
|
|
31061
|
+
Note: it is required to specify either location_name or location_code
|
|
31062
|
+
you can receive the list of available locations with their location_code by making a separate request to the
|
|
31063
|
+
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
|
|
31064
|
+
example:
|
|
31065
|
+
2840 */
|
|
31066
|
+
location_code?: number | undefined;
|
|
31067
|
+
/** full name of the language
|
|
31068
|
+
optional field
|
|
31069
|
+
if you use this field, you don’t need to specify language_code
|
|
31070
|
+
you can receive the list of available languages with their language_name by making a separate request to the
|
|
31071
|
+
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
|
|
31072
|
+
ignore this field to get the results for all available languages
|
|
31073
|
+
example:
|
|
31074
|
+
English */
|
|
31075
|
+
language_name?: string | undefined;
|
|
31076
|
+
/** language code
|
|
31077
|
+
optional field
|
|
31078
|
+
if you use this field, you don’t need to specify language_name
|
|
31079
|
+
you can receive the list of available languages with their language_code by making a separate request to the
|
|
31080
|
+
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
|
|
31081
|
+
ignore this field to get the results for all available languages
|
|
31082
|
+
example:
|
|
31083
|
+
en */
|
|
31084
|
+
language_code?: string | undefined;
|
|
31085
|
+
/** include data from SERP for each keyword
|
|
31086
|
+
optional field
|
|
31087
|
+
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
31088
|
+
default value: false */
|
|
31089
|
+
include_serp_info?: boolean | undefined;
|
|
31090
|
+
/** indicates if the subdomains will be included in the search
|
|
31091
|
+
optional field
|
|
31092
|
+
if set to false, the subdomains will be ignored
|
|
31093
|
+
default value: true */
|
|
31094
|
+
include_subdomains?: boolean | undefined;
|
|
31095
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
31096
|
+
optional field
|
|
31097
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
31098
|
+
default value: false
|
|
31099
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
31100
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
31101
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
31102
|
+
include_clickstream_data?: boolean | undefined;
|
|
30920
31103
|
/** ignore highly similar keywords
|
|
30921
31104
|
optional field
|
|
30922
31105
|
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
|
|
@@ -31085,6 +31268,52 @@ represents the (approximate) number of searches on this keyword idea (as availab
|
|
|
31085
31268
|
monthly_searches?: (MonthlySearches | undefined)[] | undefined;
|
|
31086
31269
|
[key: string]: any;
|
|
31087
31270
|
}
|
|
31271
|
+
export declare class ClickstreamKeywordInfo implements IClickstreamKeywordInfo {
|
|
31272
|
+
/** monthly average clickstream search volume rate */
|
|
31273
|
+
search_volume?: number | undefined;
|
|
31274
|
+
/** date and time when the clickstream dataset was updated
|
|
31275
|
+
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” */
|
|
31276
|
+
last_updated_time?: string | undefined;
|
|
31277
|
+
/** distribution of estimated clickstream-based metrics by gender
|
|
31278
|
+
learn more about how the metric is calculated in this help center article */
|
|
31279
|
+
gender_distribution?: {
|
|
31280
|
+
[key: string]: number;
|
|
31281
|
+
} | undefined;
|
|
31282
|
+
/** distribution of clickstream-based metrics by age
|
|
31283
|
+
learn more about how the metric is calculated in this help center article */
|
|
31284
|
+
age_distribution?: {
|
|
31285
|
+
[key: string]: number;
|
|
31286
|
+
} | undefined;
|
|
31287
|
+
/** monthly clickstream search volume rates
|
|
31288
|
+
array of objects with clickstream search volume rates in a certain month of a year */
|
|
31289
|
+
monthly_searches?: (MonthlySearches | undefined)[] | undefined;
|
|
31290
|
+
[key: string]: any;
|
|
31291
|
+
constructor(data?: IClickstreamKeywordInfo);
|
|
31292
|
+
init(_data?: any): void;
|
|
31293
|
+
static fromJS(data: any): ClickstreamKeywordInfo;
|
|
31294
|
+
toJSON(data?: any): any;
|
|
31295
|
+
}
|
|
31296
|
+
export interface IClickstreamKeywordInfo {
|
|
31297
|
+
/** monthly average clickstream search volume rate */
|
|
31298
|
+
search_volume?: number | undefined;
|
|
31299
|
+
/** date and time when the clickstream dataset was updated
|
|
31300
|
+
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” */
|
|
31301
|
+
last_updated_time?: string | undefined;
|
|
31302
|
+
/** distribution of estimated clickstream-based metrics by gender
|
|
31303
|
+
learn more about how the metric is calculated in this help center article */
|
|
31304
|
+
gender_distribution?: {
|
|
31305
|
+
[key: string]: number;
|
|
31306
|
+
} | undefined;
|
|
31307
|
+
/** distribution of clickstream-based metrics by age
|
|
31308
|
+
learn more about how the metric is calculated in this help center article */
|
|
31309
|
+
age_distribution?: {
|
|
31310
|
+
[key: string]: number;
|
|
31311
|
+
} | undefined;
|
|
31312
|
+
/** monthly clickstream search volume rates
|
|
31313
|
+
array of objects with clickstream search volume rates in a certain month of a year */
|
|
31314
|
+
monthly_searches?: (MonthlySearches | undefined)[] | undefined;
|
|
31315
|
+
[key: string]: any;
|
|
31316
|
+
}
|
|
31088
31317
|
export declare class KeywordProperties implements IKeywordProperties {
|
|
31089
31318
|
/** search engine type */
|
|
31090
31319
|
se_type?: string | undefined;
|
|
@@ -31440,6 +31669,9 @@ export declare class KeywordDataInfo implements IKeywordDataInfo {
|
|
|
31440
31669
|
language_code?: string | undefined;
|
|
31441
31670
|
/** keyword data for the returned keyword idea */
|
|
31442
31671
|
keyword_info?: KeywordInfo | undefined;
|
|
31672
|
+
/** clickstream data for the returned keyword
|
|
31673
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true */
|
|
31674
|
+
clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
|
|
31443
31675
|
/** additional information about the keyword */
|
|
31444
31676
|
keyword_properties?: KeywordProperties | undefined;
|
|
31445
31677
|
/** impressions data for the returned keyword idea
|
|
@@ -31473,6 +31705,9 @@ export interface IKeywordDataInfo {
|
|
|
31473
31705
|
language_code?: string | undefined;
|
|
31474
31706
|
/** keyword data for the returned keyword idea */
|
|
31475
31707
|
keyword_info?: KeywordInfo | undefined;
|
|
31708
|
+
/** clickstream data for the returned keyword
|
|
31709
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true */
|
|
31710
|
+
clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
|
|
31476
31711
|
/** additional information about the keyword */
|
|
31477
31712
|
keyword_properties?: KeywordProperties | undefined;
|
|
31478
31713
|
/** impressions data for the returned keyword idea
|
|
@@ -31630,6 +31865,14 @@ optional field
|
|
|
31630
31865
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
31631
31866
|
default value: false */
|
|
31632
31867
|
include_serp_info?: boolean | undefined;
|
|
31868
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
31869
|
+
optional field
|
|
31870
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
31871
|
+
default value: false
|
|
31872
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
31873
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
31874
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
31875
|
+
include_clickstream_data?: boolean | undefined;
|
|
31633
31876
|
/** ignore highly similar keywords
|
|
31634
31877
|
optional field
|
|
31635
31878
|
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
|
|
@@ -31650,13 +31893,13 @@ the following operators are supported:
|
|
|
31650
31893
|
regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
|
|
31651
31894
|
you can use the % operator with like and not_like to match any string of zero or more characters
|
|
31652
31895
|
example:
|
|
31653
|
-
["keyword_info.search_volume",">",0]
|
|
31896
|
+
["keyword_data.keyword_info.search_volume",">",0]
|
|
31654
31897
|
[["keyword_info.search_volume","in",[0,1000]],
|
|
31655
31898
|
"and",
|
|
31656
|
-
["keyword_info.competition_level","=","LOW"]]
|
|
31657
|
-
[["keyword_info.search_volume",">",100],
|
|
31899
|
+
["keyword_data.keyword_info.competition_level","=","LOW"]]
|
|
31900
|
+
[["keyword_data.keyword_info.search_volume",">",100],
|
|
31658
31901
|
"and",
|
|
31659
|
-
[["keyword_info.cpc","<",0.5],
|
|
31902
|
+
[["keyword_data.keyword_info.cpc","<",0.5],
|
|
31660
31903
|
"or",
|
|
31661
31904
|
["keyword_info.high_top_of_page_bid","<=",0.5]]]
|
|
31662
31905
|
for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
|
|
@@ -31760,6 +32003,14 @@ optional field
|
|
|
31760
32003
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
31761
32004
|
default value: false */
|
|
31762
32005
|
include_serp_info?: boolean | undefined;
|
|
32006
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
32007
|
+
optional field
|
|
32008
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
32009
|
+
default value: false
|
|
32010
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
32011
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
32012
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
32013
|
+
include_clickstream_data?: boolean | undefined;
|
|
31763
32014
|
/** ignore highly similar keywords
|
|
31764
32015
|
optional field
|
|
31765
32016
|
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
|
|
@@ -31780,13 +32031,13 @@ the following operators are supported:
|
|
|
31780
32031
|
regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like
|
|
31781
32032
|
you can use the % operator with like and not_like to match any string of zero or more characters
|
|
31782
32033
|
example:
|
|
31783
|
-
["keyword_info.search_volume",">",0]
|
|
32034
|
+
["keyword_data.keyword_info.search_volume",">",0]
|
|
31784
32035
|
[["keyword_info.search_volume","in",[0,1000]],
|
|
31785
32036
|
"and",
|
|
31786
|
-
["keyword_info.competition_level","=","LOW"]]
|
|
31787
|
-
[["keyword_info.search_volume",">",100],
|
|
32037
|
+
["keyword_data.keyword_info.competition_level","=","LOW"]]
|
|
32038
|
+
[["keyword_data.keyword_info.search_volume",">",100],
|
|
31788
32039
|
"and",
|
|
31789
|
-
[["keyword_info.cpc","<",0.5],
|
|
32040
|
+
[["keyword_data.keyword_info.cpc","<",0.5],
|
|
31790
32041
|
"or",
|
|
31791
32042
|
["keyword_info.high_top_of_page_bid","<=",0.5]]]
|
|
31792
32043
|
for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
|
|
@@ -31982,6 +32233,14 @@ optional field
|
|
|
31982
32233
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
31983
32234
|
default value: false */
|
|
31984
32235
|
include_serp_info?: boolean | undefined;
|
|
32236
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
32237
|
+
optional field
|
|
32238
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
32239
|
+
default value: false
|
|
32240
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
32241
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
32242
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
32243
|
+
include_clickstream_data?: boolean | undefined;
|
|
31985
32244
|
/** search for the exact phrase
|
|
31986
32245
|
optional field
|
|
31987
32246
|
if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase
|
|
@@ -32109,6 +32368,14 @@ optional field
|
|
|
32109
32368
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
32110
32369
|
default value: false */
|
|
32111
32370
|
include_serp_info?: boolean | undefined;
|
|
32371
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
32372
|
+
optional field
|
|
32373
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
32374
|
+
default value: false
|
|
32375
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
32376
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
32377
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
32378
|
+
include_clickstream_data?: boolean | undefined;
|
|
32112
32379
|
/** search for the exact phrase
|
|
32113
32380
|
optional field
|
|
32114
32381
|
if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase
|
|
@@ -32189,9 +32456,11 @@ fields in this object are identical to those of the items array */
|
|
|
32189
32456
|
seed_keyword_data?: {
|
|
32190
32457
|
[key: string]: string;
|
|
32191
32458
|
} | undefined;
|
|
32192
|
-
/** location code in a POST array
|
|
32459
|
+
/** location code in a POST array
|
|
32460
|
+
if there is no data, then the value is null */
|
|
32193
32461
|
location_code?: number | undefined;
|
|
32194
|
-
/** language code in a POST array
|
|
32462
|
+
/** language code in a POST array
|
|
32463
|
+
if there is no data, then the value is null */
|
|
32195
32464
|
language_code?: string | undefined;
|
|
32196
32465
|
/** total amount of results in our database relevant to your request */
|
|
32197
32466
|
total_count?: number | undefined;
|
|
@@ -32221,9 +32490,11 @@ fields in this object are identical to those of the items array */
|
|
|
32221
32490
|
seed_keyword_data?: {
|
|
32222
32491
|
[key: string]: string;
|
|
32223
32492
|
} | undefined;
|
|
32224
|
-
/** location code in a POST array
|
|
32493
|
+
/** location code in a POST array
|
|
32494
|
+
if there is no data, then the value is null */
|
|
32225
32495
|
location_code?: number | undefined;
|
|
32226
|
-
/** language code in a POST array
|
|
32496
|
+
/** language code in a POST array
|
|
32497
|
+
if there is no data, then the value is null */
|
|
32227
32498
|
language_code?: string | undefined;
|
|
32228
32499
|
/** total amount of results in our database relevant to your request */
|
|
32229
32500
|
total_count?: number | undefined;
|
|
@@ -32325,6 +32596,14 @@ optional field
|
|
|
32325
32596
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
32326
32597
|
default value: false */
|
|
32327
32598
|
include_serp_info?: boolean | undefined;
|
|
32599
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
32600
|
+
optional field
|
|
32601
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
32602
|
+
default value: false
|
|
32603
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
32604
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
32605
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
32606
|
+
include_clickstream_data?: boolean | undefined;
|
|
32328
32607
|
/** the maximum number of keywords in the results array
|
|
32329
32608
|
optional field
|
|
32330
32609
|
default value: 700
|
|
@@ -32450,6 +32729,14 @@ optional field
|
|
|
32450
32729
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
32451
32730
|
default value: false */
|
|
32452
32731
|
include_serp_info?: boolean | undefined;
|
|
32732
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
32733
|
+
optional field
|
|
32734
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
32735
|
+
default value: false
|
|
32736
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
32737
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
32738
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
32739
|
+
include_clickstream_data?: boolean | undefined;
|
|
32453
32740
|
/** the maximum number of keywords in the results array
|
|
32454
32741
|
optional field
|
|
32455
32742
|
default value: 700
|
|
@@ -32640,6 +32927,14 @@ optional field
|
|
|
32640
32927
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
32641
32928
|
default value: false */
|
|
32642
32929
|
include_serp_info?: boolean | undefined;
|
|
32930
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
32931
|
+
optional field
|
|
32932
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
32933
|
+
default value: false
|
|
32934
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
32935
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
32936
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
32937
|
+
include_clickstream_data?: boolean | undefined;
|
|
32643
32938
|
/** user-defined task identifier
|
|
32644
32939
|
optional field
|
|
32645
32940
|
the character limit is 255
|
|
@@ -32699,6 +32994,14 @@ optional field
|
|
|
32699
32994
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
32700
32995
|
default value: false */
|
|
32701
32996
|
include_serp_info?: boolean | undefined;
|
|
32997
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
32998
|
+
optional field
|
|
32999
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
33000
|
+
default value: false
|
|
33001
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
33002
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
33003
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
33004
|
+
include_clickstream_data?: boolean | undefined;
|
|
32702
33005
|
/** user-defined task identifier
|
|
32703
33006
|
optional field
|
|
32704
33007
|
the character limit is 255
|
|
@@ -32724,6 +33027,9 @@ if false, the results are returned for Google search sites only */
|
|
|
32724
33027
|
search_partners?: boolean | undefined;
|
|
32725
33028
|
/** keyword data for the returned keyword idea */
|
|
32726
33029
|
keyword_info?: KeywordInfo | undefined;
|
|
33030
|
+
/** clickstream data for the returned keyword
|
|
33031
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true */
|
|
33032
|
+
clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
|
|
32727
33033
|
/** additional information about the keyword */
|
|
32728
33034
|
keyword_properties?: KeywordProperties | undefined;
|
|
32729
33035
|
/** impressions data for the returned keyword idea
|
|
@@ -32758,6 +33064,9 @@ if false, the results are returned for Google search sites only */
|
|
|
32758
33064
|
search_partners?: boolean | undefined;
|
|
32759
33065
|
/** keyword data for the returned keyword idea */
|
|
32760
33066
|
keyword_info?: KeywordInfo | undefined;
|
|
33067
|
+
/** clickstream data for the returned keyword
|
|
33068
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true */
|
|
33069
|
+
clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
|
|
32761
33070
|
/** additional information about the keyword */
|
|
32762
33071
|
keyword_properties?: KeywordProperties | undefined;
|
|
32763
33072
|
/** impressions data for the returned keyword idea
|
|
@@ -33267,6 +33576,14 @@ if set to false, the subcategories will be ignored
|
|
|
33267
33576
|
default value: false
|
|
33268
33577
|
learn more about the parameter in this help center article */
|
|
33269
33578
|
include_subcategories?: boolean | undefined;
|
|
33579
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
33580
|
+
optional field
|
|
33581
|
+
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
|
|
33582
|
+
default value: false
|
|
33583
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
33584
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
33585
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
33586
|
+
include_clickstream_data?: boolean | undefined;
|
|
33270
33587
|
/** display results by item type
|
|
33271
33588
|
optional field
|
|
33272
33589
|
indicates the type of search results included in the response
|
|
@@ -33274,7 +33591,7 @@ Note: if the item_types array contains item types that are different from the or
|
|
|
33274
33591
|
possible values:
|
|
33275
33592
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
33276
33593
|
default value:
|
|
33277
|
-
["organic", "paid"
|
|
33594
|
+
["organic", "paid"] */
|
|
33278
33595
|
item_types?: string[] | undefined;
|
|
33279
33596
|
/** array of results filtering parameters
|
|
33280
33597
|
optional field
|
|
@@ -33375,6 +33692,14 @@ if set to false, the subcategories will be ignored
|
|
|
33375
33692
|
default value: false
|
|
33376
33693
|
learn more about the parameter in this help center article */
|
|
33377
33694
|
include_subcategories?: boolean | undefined;
|
|
33695
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
33696
|
+
optional field
|
|
33697
|
+
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
|
|
33698
|
+
default value: false
|
|
33699
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
33700
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
33701
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
33702
|
+
include_clickstream_data?: boolean | undefined;
|
|
33378
33703
|
/** display results by item type
|
|
33379
33704
|
optional field
|
|
33380
33705
|
indicates the type of search results included in the response
|
|
@@ -33382,7 +33707,7 @@ Note: if the item_types array contains item types that are different from the or
|
|
|
33382
33707
|
possible values:
|
|
33383
33708
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
33384
33709
|
default value:
|
|
33385
|
-
["organic", "paid"
|
|
33710
|
+
["organic", "paid"] */
|
|
33386
33711
|
item_types?: string[] | undefined;
|
|
33387
33712
|
/** array of results filtering parameters
|
|
33388
33713
|
optional field
|
|
@@ -33435,6 +33760,156 @@ you will find the specified tag value in the data object of the response */
|
|
|
33435
33760
|
tag?: string | undefined;
|
|
33436
33761
|
[key: string]: any;
|
|
33437
33762
|
}
|
|
33763
|
+
export declare class DataforseoLabsMetricsInfo implements IDataforseoLabsMetricsInfo {
|
|
33764
|
+
/** number of organic SERPs where the domain or subdomain ranks #1 */
|
|
33765
|
+
pos_1?: number | undefined;
|
|
33766
|
+
/** number of organic SERPs where the domain or subdomain ranks #2-3 */
|
|
33767
|
+
pos_2_3?: number | undefined;
|
|
33768
|
+
/** number of organic SERPs where the domain or subdomain ranks #4-10 */
|
|
33769
|
+
pos_4_10?: number | undefined;
|
|
33770
|
+
/** number of organic SERPs where the domain or subdomain ranks #11-20 */
|
|
33771
|
+
pos_11_20?: number | undefined;
|
|
33772
|
+
/** number of organic SERPs where the domain or subdomain ranks #21-30 */
|
|
33773
|
+
pos_21_30?: number | undefined;
|
|
33774
|
+
/** number of organic SERPs where the domain or subdomain ranks #31-40 */
|
|
33775
|
+
pos_31_40?: number | undefined;
|
|
33776
|
+
/** number of organic SERPs where the domain or subdomain ranks #41-50 */
|
|
33777
|
+
pos_41_50?: number | undefined;
|
|
33778
|
+
/** number of organic SERPs where the domain or subdomain ranks #51-60 */
|
|
33779
|
+
pos_51_60?: number | undefined;
|
|
33780
|
+
/** number of organic SERPs where the domain or subdomain ranks #61-70 */
|
|
33781
|
+
pos_61_70?: number | undefined;
|
|
33782
|
+
/** number of organic SERPs where the domain or subdomain ranks #71-80 */
|
|
33783
|
+
pos_71_80?: number | undefined;
|
|
33784
|
+
/** number of organic SERPs where the domain or subdomain ranks #81-90 */
|
|
33785
|
+
pos_81_90?: number | undefined;
|
|
33786
|
+
/** number of organic SERPs where the domain or subdomain ranks #91-100 */
|
|
33787
|
+
pos_91_100?: number | undefined;
|
|
33788
|
+
/** estimated traffic volume
|
|
33789
|
+
estimated organic monthly traffic to the domain or subdomain
|
|
33790
|
+
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain or subdomain ranks for
|
|
33791
|
+
learn more about how the metric is calculated in this help center article */
|
|
33792
|
+
etv?: number | undefined;
|
|
33793
|
+
/** estimated traffic volume based on impressions
|
|
33794
|
+
estimated organic monthly traffic to the domain or subdomain
|
|
33795
|
+
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain or subdomain ranks for
|
|
33796
|
+
learn more about how the metric is calculated in this help center article */
|
|
33797
|
+
impressions_etv?: number | undefined;
|
|
33798
|
+
/** total count of organic SERPs that contain the domain or subdomain */
|
|
33799
|
+
count?: number | undefined;
|
|
33800
|
+
/** estimated cost of converting organic search traffic into paid
|
|
33801
|
+
represents the estimated monthly cost (USD) of running ads for all keywords in the category that the domain or subdomain ranks for
|
|
33802
|
+
the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search
|
|
33803
|
+
learn more about how the metric is calculated in this help center article */
|
|
33804
|
+
estimated_paid_traffic_cost?: number | undefined;
|
|
33805
|
+
/** number of new ranked elements
|
|
33806
|
+
indicates how many new ranked elements were found for the indicated target */
|
|
33807
|
+
is_new?: number | undefined;
|
|
33808
|
+
/** rank went up
|
|
33809
|
+
indicates how many ranked elements of the indicated target went up */
|
|
33810
|
+
is_up?: number | undefined;
|
|
33811
|
+
/** rank went down
|
|
33812
|
+
indicates how many ranked elements of the indicated target went down */
|
|
33813
|
+
is_down?: number | undefined;
|
|
33814
|
+
/** lost ranked elements
|
|
33815
|
+
indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check */
|
|
33816
|
+
is_lost?: number | undefined;
|
|
33817
|
+
/** estimated traffic volume based on clickstream data
|
|
33818
|
+
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
|
|
33819
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true
|
|
33820
|
+
learn more about how the metric is calculated in this help center article */
|
|
33821
|
+
clickstream_etv?: number | undefined;
|
|
33822
|
+
/** distribution of estimated clickstream-based metrics by gender
|
|
33823
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true
|
|
33824
|
+
learn more about how the metric is calculated in this help center article */
|
|
33825
|
+
clickstream_gender_distribution?: {
|
|
33826
|
+
[key: string]: number;
|
|
33827
|
+
} | undefined;
|
|
33828
|
+
/** distribution of clickstream-based metrics by age
|
|
33829
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true
|
|
33830
|
+
learn more about how the metric is calculated in this help center article */
|
|
33831
|
+
clickstream_age_distribution?: {
|
|
33832
|
+
[key: string]: number;
|
|
33833
|
+
} | undefined;
|
|
33834
|
+
[key: string]: any;
|
|
33835
|
+
constructor(data?: IDataforseoLabsMetricsInfo);
|
|
33836
|
+
init(_data?: any): void;
|
|
33837
|
+
static fromJS(data: any): DataforseoLabsMetricsInfo;
|
|
33838
|
+
toJSON(data?: any): any;
|
|
33839
|
+
}
|
|
33840
|
+
export interface IDataforseoLabsMetricsInfo {
|
|
33841
|
+
/** number of organic SERPs where the domain or subdomain ranks #1 */
|
|
33842
|
+
pos_1?: number | undefined;
|
|
33843
|
+
/** number of organic SERPs where the domain or subdomain ranks #2-3 */
|
|
33844
|
+
pos_2_3?: number | undefined;
|
|
33845
|
+
/** number of organic SERPs where the domain or subdomain ranks #4-10 */
|
|
33846
|
+
pos_4_10?: number | undefined;
|
|
33847
|
+
/** number of organic SERPs where the domain or subdomain ranks #11-20 */
|
|
33848
|
+
pos_11_20?: number | undefined;
|
|
33849
|
+
/** number of organic SERPs where the domain or subdomain ranks #21-30 */
|
|
33850
|
+
pos_21_30?: number | undefined;
|
|
33851
|
+
/** number of organic SERPs where the domain or subdomain ranks #31-40 */
|
|
33852
|
+
pos_31_40?: number | undefined;
|
|
33853
|
+
/** number of organic SERPs where the domain or subdomain ranks #41-50 */
|
|
33854
|
+
pos_41_50?: number | undefined;
|
|
33855
|
+
/** number of organic SERPs where the domain or subdomain ranks #51-60 */
|
|
33856
|
+
pos_51_60?: number | undefined;
|
|
33857
|
+
/** number of organic SERPs where the domain or subdomain ranks #61-70 */
|
|
33858
|
+
pos_61_70?: number | undefined;
|
|
33859
|
+
/** number of organic SERPs where the domain or subdomain ranks #71-80 */
|
|
33860
|
+
pos_71_80?: number | undefined;
|
|
33861
|
+
/** number of organic SERPs where the domain or subdomain ranks #81-90 */
|
|
33862
|
+
pos_81_90?: number | undefined;
|
|
33863
|
+
/** number of organic SERPs where the domain or subdomain ranks #91-100 */
|
|
33864
|
+
pos_91_100?: number | undefined;
|
|
33865
|
+
/** estimated traffic volume
|
|
33866
|
+
estimated organic monthly traffic to the domain or subdomain
|
|
33867
|
+
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain or subdomain ranks for
|
|
33868
|
+
learn more about how the metric is calculated in this help center article */
|
|
33869
|
+
etv?: number | undefined;
|
|
33870
|
+
/** estimated traffic volume based on impressions
|
|
33871
|
+
estimated organic monthly traffic to the domain or subdomain
|
|
33872
|
+
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain or subdomain ranks for
|
|
33873
|
+
learn more about how the metric is calculated in this help center article */
|
|
33874
|
+
impressions_etv?: number | undefined;
|
|
33875
|
+
/** total count of organic SERPs that contain the domain or subdomain */
|
|
33876
|
+
count?: number | undefined;
|
|
33877
|
+
/** estimated cost of converting organic search traffic into paid
|
|
33878
|
+
represents the estimated monthly cost (USD) of running ads for all keywords in the category that the domain or subdomain ranks for
|
|
33879
|
+
the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search
|
|
33880
|
+
learn more about how the metric is calculated in this help center article */
|
|
33881
|
+
estimated_paid_traffic_cost?: number | undefined;
|
|
33882
|
+
/** number of new ranked elements
|
|
33883
|
+
indicates how many new ranked elements were found for the indicated target */
|
|
33884
|
+
is_new?: number | undefined;
|
|
33885
|
+
/** rank went up
|
|
33886
|
+
indicates how many ranked elements of the indicated target went up */
|
|
33887
|
+
is_up?: number | undefined;
|
|
33888
|
+
/** rank went down
|
|
33889
|
+
indicates how many ranked elements of the indicated target went down */
|
|
33890
|
+
is_down?: number | undefined;
|
|
33891
|
+
/** lost ranked elements
|
|
33892
|
+
indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check */
|
|
33893
|
+
is_lost?: number | undefined;
|
|
33894
|
+
/** estimated traffic volume based on clickstream data
|
|
33895
|
+
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
|
|
33896
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true
|
|
33897
|
+
learn more about how the metric is calculated in this help center article */
|
|
33898
|
+
clickstream_etv?: number | undefined;
|
|
33899
|
+
/** distribution of estimated clickstream-based metrics by gender
|
|
33900
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true
|
|
33901
|
+
learn more about how the metric is calculated in this help center article */
|
|
33902
|
+
clickstream_gender_distribution?: {
|
|
33903
|
+
[key: string]: number;
|
|
33904
|
+
} | undefined;
|
|
33905
|
+
/** distribution of clickstream-based metrics by age
|
|
33906
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true
|
|
33907
|
+
learn more about how the metric is calculated in this help center article */
|
|
33908
|
+
clickstream_age_distribution?: {
|
|
33909
|
+
[key: string]: number;
|
|
33910
|
+
} | undefined;
|
|
33911
|
+
[key: string]: any;
|
|
33912
|
+
}
|
|
33438
33913
|
export declare class DataforseoLabsGoogleCategoriesForDomainLiveItem implements IDataforseoLabsGoogleCategoriesForDomainLiveItem {
|
|
33439
33914
|
/** search engine type */
|
|
33440
33915
|
se_type?: string | undefined;
|
|
@@ -33443,7 +33918,7 @@ you can download the full list of possible categories */
|
|
|
33443
33918
|
categories?: number[] | undefined;
|
|
33444
33919
|
/** ranking data relevant to the specified domain or subdomain */
|
|
33445
33920
|
metrics?: {
|
|
33446
|
-
[key: string]:
|
|
33921
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
33447
33922
|
} | undefined;
|
|
33448
33923
|
[key: string]: any;
|
|
33449
33924
|
constructor(data?: IDataforseoLabsGoogleCategoriesForDomainLiveItem);
|
|
@@ -33459,7 +33934,7 @@ you can download the full list of possible categories */
|
|
|
33459
33934
|
categories?: number[] | undefined;
|
|
33460
33935
|
/** ranking data relevant to the specified domain or subdomain */
|
|
33461
33936
|
metrics?: {
|
|
33462
|
-
[key: string]:
|
|
33937
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
33463
33938
|
} | undefined;
|
|
33464
33939
|
[key: string]: any;
|
|
33465
33940
|
}
|
|
@@ -33578,6 +34053,14 @@ optional field
|
|
|
33578
34053
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
33579
34054
|
default value: false */
|
|
33580
34055
|
include_serp_info?: boolean | undefined;
|
|
34056
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
34057
|
+
optional field
|
|
34058
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
34059
|
+
default value: false
|
|
34060
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
34061
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
34062
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
34063
|
+
include_clickstream_data?: boolean | undefined;
|
|
33581
34064
|
/** ignore highly similar keywords
|
|
33582
34065
|
optional field
|
|
33583
34066
|
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
|
|
@@ -33697,6 +34180,14 @@ optional field
|
|
|
33697
34180
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
33698
34181
|
default value: false */
|
|
33699
34182
|
include_serp_info?: boolean | undefined;
|
|
34183
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
34184
|
+
optional field
|
|
34185
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
34186
|
+
default value: false
|
|
34187
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
34188
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
34189
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
34190
|
+
include_clickstream_data?: boolean | undefined;
|
|
33700
34191
|
/** ignore highly similar keywords
|
|
33701
34192
|
optional field
|
|
33702
34193
|
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
|
|
@@ -34149,13 +34640,13 @@ indicates how many new ranked elements were found for the domain */
|
|
|
34149
34640
|
/** historical ranking and traffic data of the domain */
|
|
34150
34641
|
metrics_history?: {
|
|
34151
34642
|
[key: string]: {
|
|
34152
|
-
[key: string]:
|
|
34643
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
34153
34644
|
};
|
|
34154
34645
|
} | undefined;
|
|
34155
34646
|
/** metrics difference between first_date and second_date
|
|
34156
34647
|
calculated by subtracting domain metrics as of the greater date from domain metrics as of the smaller date */
|
|
34157
34648
|
metrics_difference?: {
|
|
34158
|
-
[key: string]:
|
|
34649
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
34159
34650
|
} | undefined;
|
|
34160
34651
|
[key: string]: any;
|
|
34161
34652
|
constructor(data?: IDataforseoLabsGoogleDomainMetricsByCategoriesLiveItem);
|
|
@@ -34185,13 +34676,13 @@ indicates how many new ranked elements were found for the domain */
|
|
|
34185
34676
|
/** historical ranking and traffic data of the domain */
|
|
34186
34677
|
metrics_history?: {
|
|
34187
34678
|
[key: string]: {
|
|
34188
|
-
[key: string]:
|
|
34679
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
34189
34680
|
};
|
|
34190
34681
|
} | undefined;
|
|
34191
34682
|
/** metrics difference between first_date and second_date
|
|
34192
34683
|
calculated by subtracting domain metrics as of the greater date from domain metrics as of the smaller date */
|
|
34193
34684
|
metrics_difference?: {
|
|
34194
|
-
[key: string]:
|
|
34685
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
34195
34686
|
} | undefined;
|
|
34196
34687
|
[key: string]: any;
|
|
34197
34688
|
}
|
|
@@ -34299,6 +34790,14 @@ optional field
|
|
|
34299
34790
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
34300
34791
|
default value: false */
|
|
34301
34792
|
include_serp_info?: boolean | undefined;
|
|
34793
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
34794
|
+
optional field
|
|
34795
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
34796
|
+
default value: false
|
|
34797
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
34798
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
34799
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
34800
|
+
include_clickstream_data?: boolean | undefined;
|
|
34302
34801
|
/** ignore highly similar keywords
|
|
34303
34802
|
optional field
|
|
34304
34803
|
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
|
|
@@ -34408,6 +34907,14 @@ optional field
|
|
|
34408
34907
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
34409
34908
|
default value: false */
|
|
34410
34909
|
include_serp_info?: boolean | undefined;
|
|
34910
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
34911
|
+
optional field
|
|
34912
|
+
if the parameter is set to true, you will receive clickstream_keyword_info object with clickstream data in the response
|
|
34913
|
+
default value: false
|
|
34914
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
34915
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
34916
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
34917
|
+
include_clickstream_data?: boolean | undefined;
|
|
34411
34918
|
/** ignore highly similar keywords
|
|
34412
34919
|
optional field
|
|
34413
34920
|
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
|
|
@@ -34700,7 +35207,7 @@ NameCheap, Inc. */
|
|
|
34700
35207
|
registrar?: string | undefined;
|
|
34701
35208
|
/** ranking data relevant to the specified domain */
|
|
34702
35209
|
metrics?: {
|
|
34703
|
-
[key: string]:
|
|
35210
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
34704
35211
|
} | undefined;
|
|
34705
35212
|
/** backlink data for the returned domain */
|
|
34706
35213
|
backlinks_info?: BacklinksInfo | undefined;
|
|
@@ -34757,7 +35264,7 @@ NameCheap, Inc. */
|
|
|
34757
35264
|
registrar?: string | undefined;
|
|
34758
35265
|
/** ranking data relevant to the specified domain */
|
|
34759
35266
|
metrics?: {
|
|
34760
|
-
[key: string]:
|
|
35267
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
34761
35268
|
} | undefined;
|
|
34762
35269
|
/** backlink data for the returned domain */
|
|
34763
35270
|
backlinks_info?: BacklinksInfo | undefined;
|
|
@@ -34876,8 +35383,16 @@ Note: if the item_types array contains item types that are different from organi
|
|
|
34876
35383
|
possible values:
|
|
34877
35384
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
34878
35385
|
default value:
|
|
34879
|
-
["organic", "paid"
|
|
35386
|
+
["organic", "paid"] */
|
|
34880
35387
|
item_types?: string[] | undefined;
|
|
35388
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
35389
|
+
optional field
|
|
35390
|
+
if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
|
|
35391
|
+
default value: false
|
|
35392
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
35393
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
35394
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
35395
|
+
include_clickstream_data?: boolean | undefined;
|
|
34881
35396
|
/** the maximum number of returned keywords
|
|
34882
35397
|
optional field
|
|
34883
35398
|
default value: 100
|
|
@@ -35009,8 +35524,16 @@ Note: if the item_types array contains item types that are different from organi
|
|
|
35009
35524
|
possible values:
|
|
35010
35525
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
35011
35526
|
default value:
|
|
35012
|
-
["organic", "paid"
|
|
35527
|
+
["organic", "paid"] */
|
|
35013
35528
|
item_types?: string[] | undefined;
|
|
35529
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
35530
|
+
optional field
|
|
35531
|
+
if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
|
|
35532
|
+
default value: false
|
|
35533
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
35534
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
35535
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
35536
|
+
include_clickstream_data?: boolean | undefined;
|
|
35014
35537
|
/** the maximum number of returned keywords
|
|
35015
35538
|
optional field
|
|
35016
35539
|
default value: 100
|
|
@@ -35216,6 +35739,11 @@ learn more about how the metric is calculated in this help center article */
|
|
|
35216
35739
|
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
|
|
35217
35740
|
learn more about how the metric is calculated in this help center article */
|
|
35218
35741
|
estimated_paid_traffic_cost?: number | undefined;
|
|
35742
|
+
/** estimated traffic volume based on clickstream data
|
|
35743
|
+
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
|
|
35744
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true
|
|
35745
|
+
learn more about how the metric is calculated in this help center article */
|
|
35746
|
+
clickstream_etv?: number | undefined;
|
|
35219
35747
|
/** changes in rankings
|
|
35220
35748
|
contains information about the ranking changes of the SERP element since the previous_updated_time */
|
|
35221
35749
|
rank_changes?: RankChanges | undefined;
|
|
@@ -35304,6 +35832,11 @@ learn more about how the metric is calculated in this help center article */
|
|
|
35304
35832
|
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
|
|
35305
35833
|
learn more about how the metric is calculated in this help center article */
|
|
35306
35834
|
estimated_paid_traffic_cost?: number | undefined;
|
|
35835
|
+
/** estimated traffic volume based on clickstream data
|
|
35836
|
+
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
|
|
35837
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true
|
|
35838
|
+
learn more about how the metric is calculated in this help center article */
|
|
35839
|
+
clickstream_etv?: number | undefined;
|
|
35307
35840
|
/** changes in rankings
|
|
35308
35841
|
contains information about the ranking changes of the SERP element since the previous_updated_time */
|
|
35309
35842
|
rank_changes?: RankChanges | undefined;
|
|
@@ -35469,6 +36002,11 @@ learn more about how the metric is calculated in this help center article */
|
|
|
35469
36002
|
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
|
|
35470
36003
|
learn more about how the metric is calculated in this help center article */
|
|
35471
36004
|
estimated_paid_traffic_cost?: number | undefined;
|
|
36005
|
+
/** estimated traffic volume based on clickstream data
|
|
36006
|
+
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
|
|
36007
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true
|
|
36008
|
+
learn more about how the metric is calculated in this help center article */
|
|
36009
|
+
clickstream_etv?: number | undefined;
|
|
35472
36010
|
/** changes in rankings
|
|
35473
36011
|
contains information about the ranking changes of the SERP element since the previous_updated_time */
|
|
35474
36012
|
rank_changes?: RankChanges | undefined;
|
|
@@ -35538,6 +36076,11 @@ learn more about how the metric is calculated in this help center article */
|
|
|
35538
36076
|
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
|
|
35539
36077
|
learn more about how the metric is calculated in this help center article */
|
|
35540
36078
|
estimated_paid_traffic_cost?: number | undefined;
|
|
36079
|
+
/** estimated traffic volume based on clickstream data
|
|
36080
|
+
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
|
|
36081
|
+
to retrieve results for this field, the parameter include_clickstream_data must be set to true
|
|
36082
|
+
learn more about how the metric is calculated in this help center article */
|
|
36083
|
+
clickstream_etv?: number | undefined;
|
|
35541
36084
|
/** changes in rankings
|
|
35542
36085
|
contains information about the ranking changes of the SERP element since the previous_updated_time */
|
|
35543
36086
|
rank_changes?: RankChanges | undefined;
|
|
@@ -35565,12 +36108,12 @@ if there is no data, then the value is null */
|
|
|
35565
36108
|
/** ranking data relevant to the specified domain
|
|
35566
36109
|
ranking data is provided by the rank_group parameters that show the result’s rank considering only equivalent SERP elements */
|
|
35567
36110
|
metrics?: {
|
|
35568
|
-
[key: string]:
|
|
36111
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
35569
36112
|
} | undefined;
|
|
35570
36113
|
/** ranking data relevant to the specified domain
|
|
35571
36114
|
ranking data is provided by the rank_absolute parameters that indicate the result’s position among all SERP elements */
|
|
35572
36115
|
metrics_absolute?: {
|
|
35573
|
-
[key: string]:
|
|
36116
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
35574
36117
|
} | undefined;
|
|
35575
36118
|
/** contains ranked keywords and related data */
|
|
35576
36119
|
items?: (DataforseoLabsGoogleRankedKeywordsLiveItem | undefined)[] | undefined;
|
|
@@ -35598,12 +36141,12 @@ if there is no data, then the value is null */
|
|
|
35598
36141
|
/** ranking data relevant to the specified domain
|
|
35599
36142
|
ranking data is provided by the rank_group parameters that show the result’s rank considering only equivalent SERP elements */
|
|
35600
36143
|
metrics?: {
|
|
35601
|
-
[key: string]:
|
|
36144
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
35602
36145
|
} | undefined;
|
|
35603
36146
|
/** ranking data relevant to the specified domain
|
|
35604
36147
|
ranking data is provided by the rank_absolute parameters that indicate the result’s position among all SERP elements */
|
|
35605
36148
|
metrics_absolute?: {
|
|
35606
|
-
[key: string]:
|
|
36149
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
35607
36150
|
} | undefined;
|
|
35608
36151
|
/** contains ranked keywords and related data */
|
|
35609
36152
|
items?: (DataforseoLabsGoogleRankedKeywordsLiveItem | undefined)[] | undefined;
|
|
@@ -35689,7 +36232,7 @@ optional field
|
|
|
35689
36232
|
possible values:
|
|
35690
36233
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
35691
36234
|
default value:
|
|
35692
|
-
["organic", "paid"
|
|
36235
|
+
["organic", "paid"] */
|
|
35693
36236
|
item_types?: string[] | undefined;
|
|
35694
36237
|
/** the maximum number of returned domains
|
|
35695
36238
|
optional field
|
|
@@ -35796,7 +36339,7 @@ optional field
|
|
|
35796
36339
|
possible values:
|
|
35797
36340
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
35798
36341
|
default value:
|
|
35799
|
-
["organic", "paid"
|
|
36342
|
+
["organic", "paid"] */
|
|
35800
36343
|
item_types?: string[] | undefined;
|
|
35801
36344
|
/** the maximum number of returned domains
|
|
35802
36345
|
optional field
|
|
@@ -36044,8 +36587,16 @@ Note: if the item_types array contains item types that are different from organi
|
|
|
36044
36587
|
possible values:
|
|
36045
36588
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
36046
36589
|
default value:
|
|
36047
|
-
["organic", "paid"
|
|
36590
|
+
["organic", "paid"] */
|
|
36048
36591
|
item_types?: string[] | undefined;
|
|
36592
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
36593
|
+
optional field
|
|
36594
|
+
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
|
|
36595
|
+
default value: false
|
|
36596
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
36597
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
36598
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
36599
|
+
include_clickstream_data?: boolean | undefined;
|
|
36049
36600
|
/** array of results filtering parameters
|
|
36050
36601
|
optional field
|
|
36051
36602
|
you can add several filters at once (8 filters maximum)
|
|
@@ -36177,8 +36728,16 @@ Note: if the item_types array contains item types that are different from organi
|
|
|
36177
36728
|
possible values:
|
|
36178
36729
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
36179
36730
|
default value:
|
|
36180
|
-
["organic", "paid"
|
|
36731
|
+
["organic", "paid"] */
|
|
36181
36732
|
item_types?: string[] | undefined;
|
|
36733
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
36734
|
+
optional field
|
|
36735
|
+
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
|
|
36736
|
+
default value: false
|
|
36737
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
36738
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
36739
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
36740
|
+
include_clickstream_data?: boolean | undefined;
|
|
36182
36741
|
/** array of results filtering parameters
|
|
36183
36742
|
optional field
|
|
36184
36743
|
you can add several filters at once (8 filters maximum)
|
|
@@ -36279,19 +36838,19 @@ the value for a given domain may differ when combined with different target webs
|
|
|
36279
36838
|
/** metrics for all keywords of the domain
|
|
36280
36839
|
full overview of ranking and traffic data relevant to all keywords that the provided domain is ranking for */
|
|
36281
36840
|
full_domain_metrics?: {
|
|
36282
|
-
[key: string]:
|
|
36841
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
36283
36842
|
} | undefined;
|
|
36284
36843
|
/** metrics for intersecting keywords
|
|
36285
36844
|
ranking and traffic data relevant to the keywords that the provided domain shares with the target domain
|
|
36286
36845
|
note: in this array ranking and traffic data is provided for the target considering the keywords target shares in search with the competitor’s domain */
|
|
36287
36846
|
metrics?: {
|
|
36288
|
-
[key: string]:
|
|
36847
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
36289
36848
|
} | undefined;
|
|
36290
36849
|
/** metrics for intersecting keywords
|
|
36291
36850
|
ranking and traffic data relevant to the keywords that the provided domain shares with the target domain
|
|
36292
36851
|
note: in this array ranking and traffic data is provided for the returned competitor’s domain */
|
|
36293
36852
|
competitor_metrics?: {
|
|
36294
|
-
[key: string]:
|
|
36853
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
36295
36854
|
} | undefined;
|
|
36296
36855
|
[key: string]: any;
|
|
36297
36856
|
constructor(data?: IDataforseoLabsCompetitorsDomainLiveItem);
|
|
@@ -36317,19 +36876,19 @@ the value for a given domain may differ when combined with different target webs
|
|
|
36317
36876
|
/** metrics for all keywords of the domain
|
|
36318
36877
|
full overview of ranking and traffic data relevant to all keywords that the provided domain is ranking for */
|
|
36319
36878
|
full_domain_metrics?: {
|
|
36320
|
-
[key: string]:
|
|
36879
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
36321
36880
|
} | undefined;
|
|
36322
36881
|
/** metrics for intersecting keywords
|
|
36323
36882
|
ranking and traffic data relevant to the keywords that the provided domain shares with the target domain
|
|
36324
36883
|
note: in this array ranking and traffic data is provided for the target considering the keywords target shares in search with the competitor’s domain */
|
|
36325
36884
|
metrics?: {
|
|
36326
|
-
[key: string]:
|
|
36885
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
36327
36886
|
} | undefined;
|
|
36328
36887
|
/** metrics for intersecting keywords
|
|
36329
36888
|
ranking and traffic data relevant to the keywords that the provided domain shares with the target domain
|
|
36330
36889
|
note: in this array ranking and traffic data is provided for the returned competitor’s domain */
|
|
36331
36890
|
competitor_metrics?: {
|
|
36332
|
-
[key: string]:
|
|
36891
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
36333
36892
|
} | undefined;
|
|
36334
36893
|
[key: string]: any;
|
|
36335
36894
|
}
|
|
@@ -36463,6 +37022,14 @@ optional field
|
|
|
36463
37022
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
36464
37023
|
default value: false */
|
|
36465
37024
|
include_serp_info?: boolean | undefined;
|
|
37025
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
37026
|
+
optional field
|
|
37027
|
+
if the parameter is set to true, you will receive clickstream_keyword_info, and clickstream_etv fields with clickstream data in the response
|
|
37028
|
+
default value: false
|
|
37029
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
37030
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
37031
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
37032
|
+
include_clickstream_data?: boolean | undefined;
|
|
36466
37033
|
/** the maximum number of returned keywords
|
|
36467
37034
|
optional field
|
|
36468
37035
|
default value: 100
|
|
@@ -36582,6 +37149,14 @@ optional field
|
|
|
36582
37149
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
36583
37150
|
default value: false */
|
|
36584
37151
|
include_serp_info?: boolean | undefined;
|
|
37152
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
37153
|
+
optional field
|
|
37154
|
+
if the parameter is set to true, you will receive clickstream_keyword_info, and clickstream_etv fields with clickstream data in the response
|
|
37155
|
+
default value: false
|
|
37156
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
37157
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
37158
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
37159
|
+
include_clickstream_data?: boolean | undefined;
|
|
36585
37160
|
/** the maximum number of returned keywords
|
|
36586
37161
|
optional field
|
|
36587
37162
|
default value: 100
|
|
@@ -36638,10 +37213,10 @@ export declare class DataforseoLabsGoogleDomainIntersectionLiveItem implements I
|
|
|
36638
37213
|
se_type?: string | undefined;
|
|
36639
37214
|
/** keyword data for the returned keyword */
|
|
36640
37215
|
keyword_data?: KeywordDataInfo | undefined;
|
|
36641
|
-
/** contains data on the first domain
|
|
37216
|
+
/** contains data on the first domain's SERP element found for the returned keyword
|
|
36642
37217
|
the list of supported SERP elements can be found below */
|
|
36643
37218
|
first_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
|
|
36644
|
-
/** contains data on the second domain
|
|
37219
|
+
/** contains data on the second domain's SERP element found for the returned keyword
|
|
36645
37220
|
the list of supported SERP elements can be found below */
|
|
36646
37221
|
second_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
|
|
36647
37222
|
[key: string]: any;
|
|
@@ -36655,10 +37230,10 @@ export interface IDataforseoLabsGoogleDomainIntersectionLiveItem {
|
|
|
36655
37230
|
se_type?: string | undefined;
|
|
36656
37231
|
/** keyword data for the returned keyword */
|
|
36657
37232
|
keyword_data?: KeywordDataInfo | undefined;
|
|
36658
|
-
/** contains data on the first domain
|
|
37233
|
+
/** contains data on the first domain's SERP element found for the returned keyword
|
|
36659
37234
|
the list of supported SERP elements can be found below */
|
|
36660
37235
|
first_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
|
|
36661
|
-
/** contains data on the second domain
|
|
37236
|
+
/** contains data on the second domain's SERP element found for the returned keyword
|
|
36662
37237
|
the list of supported SERP elements can be found below */
|
|
36663
37238
|
second_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
|
|
36664
37239
|
[key: string]: any;
|
|
@@ -36782,8 +37357,16 @@ Note: if the item_types array contains item types that are different from organi
|
|
|
36782
37357
|
possible values:
|
|
36783
37358
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
36784
37359
|
default value:
|
|
36785
|
-
["organic", "paid"
|
|
37360
|
+
["organic", "paid"] */
|
|
36786
37361
|
item_types?: string[] | undefined;
|
|
37362
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
37363
|
+
optional field
|
|
37364
|
+
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
|
|
37365
|
+
default value: false
|
|
37366
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
37367
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
37368
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
37369
|
+
include_clickstream_data?: boolean | undefined;
|
|
36787
37370
|
/** data collection mode
|
|
36788
37371
|
optional field
|
|
36789
37372
|
you can use this field to filter the results;
|
|
@@ -36895,8 +37478,16 @@ Note: if the item_types array contains item types that are different from organi
|
|
|
36895
37478
|
possible values:
|
|
36896
37479
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
36897
37480
|
default value:
|
|
36898
|
-
["organic", "paid"
|
|
37481
|
+
["organic", "paid"] */
|
|
36899
37482
|
item_types?: string[] | undefined;
|
|
37483
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
37484
|
+
optional field
|
|
37485
|
+
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
|
|
37486
|
+
default value: false
|
|
37487
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
37488
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
37489
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
37490
|
+
include_clickstream_data?: boolean | undefined;
|
|
36900
37491
|
/** data collection mode
|
|
36901
37492
|
optional field
|
|
36902
37493
|
you can use this field to filter the results;
|
|
@@ -36962,7 +37553,7 @@ export declare class DataforseoLabsSubdomainsLiveItem implements IDataforseoLabs
|
|
|
36962
37553
|
subdomain?: string | undefined;
|
|
36963
37554
|
/** ranking data relevant to subdomain */
|
|
36964
37555
|
metrics?: {
|
|
36965
|
-
[key: string]:
|
|
37556
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
36966
37557
|
} | undefined;
|
|
36967
37558
|
[key: string]: any;
|
|
36968
37559
|
constructor(data?: IDataforseoLabsSubdomainsLiveItem);
|
|
@@ -36977,7 +37568,7 @@ export interface IDataforseoLabsSubdomainsLiveItem {
|
|
|
36977
37568
|
subdomain?: string | undefined;
|
|
36978
37569
|
/** ranking data relevant to subdomain */
|
|
36979
37570
|
metrics?: {
|
|
36980
|
-
[key: string]:
|
|
37571
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
36981
37572
|
} | undefined;
|
|
36982
37573
|
[key: string]: any;
|
|
36983
37574
|
}
|
|
@@ -37096,13 +37687,21 @@ Note: if the item_types array contains item types that are different from organi
|
|
|
37096
37687
|
possible values:
|
|
37097
37688
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
37098
37689
|
default value:
|
|
37099
|
-
["organic", "paid"
|
|
37690
|
+
["organic", "paid"] */
|
|
37100
37691
|
item_types?: string[] | undefined;
|
|
37101
37692
|
/** the maximum number of returned pages
|
|
37102
37693
|
optional field
|
|
37103
37694
|
default value: 100
|
|
37104
37695
|
maximum value: 1000 */
|
|
37105
37696
|
limit?: number | undefined;
|
|
37697
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
37698
|
+
optional field
|
|
37699
|
+
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
|
|
37700
|
+
default value: false
|
|
37701
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
37702
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
37703
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
37704
|
+
include_clickstream_data?: boolean | undefined;
|
|
37106
37705
|
/** offset in the results array of returned pages
|
|
37107
37706
|
optional field
|
|
37108
37707
|
default value: 0
|
|
@@ -37209,13 +37808,21 @@ Note: if the item_types array contains item types that are different from organi
|
|
|
37209
37808
|
possible values:
|
|
37210
37809
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
37211
37810
|
default value:
|
|
37212
|
-
["organic", "paid"
|
|
37811
|
+
["organic", "paid"] */
|
|
37213
37812
|
item_types?: string[] | undefined;
|
|
37214
37813
|
/** the maximum number of returned pages
|
|
37215
37814
|
optional field
|
|
37216
37815
|
default value: 100
|
|
37217
37816
|
maximum value: 1000 */
|
|
37218
37817
|
limit?: number | undefined;
|
|
37818
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
37819
|
+
optional field
|
|
37820
|
+
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
|
|
37821
|
+
default value: false
|
|
37822
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
37823
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
37824
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
37825
|
+
include_clickstream_data?: boolean | undefined;
|
|
37219
37826
|
/** offset in the results array of returned pages
|
|
37220
37827
|
optional field
|
|
37221
37828
|
default value: 0
|
|
@@ -37276,7 +37883,7 @@ export declare class DataforseoLabsRelevantPagesLiveItem implements IDataforseoL
|
|
|
37276
37883
|
page_address?: string | undefined;
|
|
37277
37884
|
/** rankings and traffic metrics for the relevant page */
|
|
37278
37885
|
metrics?: {
|
|
37279
|
-
[key: string]:
|
|
37886
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
37280
37887
|
} | undefined;
|
|
37281
37888
|
[key: string]: any;
|
|
37282
37889
|
constructor(data?: IDataforseoLabsRelevantPagesLiveItem);
|
|
@@ -37291,7 +37898,7 @@ export interface IDataforseoLabsRelevantPagesLiveItem {
|
|
|
37291
37898
|
page_address?: string | undefined;
|
|
37292
37899
|
/** rankings and traffic metrics for the relevant page */
|
|
37293
37900
|
metrics?: {
|
|
37294
|
-
[key: string]:
|
|
37901
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
37295
37902
|
} | undefined;
|
|
37296
37903
|
[key: string]: any;
|
|
37297
37904
|
}
|
|
@@ -37508,7 +38115,7 @@ export declare class DataforseoLabsDomainRankOverviewLiveItem implements IDatafo
|
|
|
37508
38115
|
language_code?: string | undefined;
|
|
37509
38116
|
/** ranking data relevant to the specified domain */
|
|
37510
38117
|
metrics?: {
|
|
37511
|
-
[key: string]:
|
|
38118
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
37512
38119
|
} | undefined;
|
|
37513
38120
|
[key: string]: any;
|
|
37514
38121
|
constructor(data?: IDataforseoLabsDomainRankOverviewLiveItem);
|
|
@@ -37525,7 +38132,7 @@ export interface IDataforseoLabsDomainRankOverviewLiveItem {
|
|
|
37525
38132
|
language_code?: string | undefined;
|
|
37526
38133
|
/** ranking data relevant to the specified domain */
|
|
37527
38134
|
metrics?: {
|
|
37528
|
-
[key: string]:
|
|
38135
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
37529
38136
|
} | undefined;
|
|
37530
38137
|
[key: string]: any;
|
|
37531
38138
|
}
|
|
@@ -40156,6 +40763,14 @@ optional field
|
|
|
40156
40763
|
if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded;
|
|
40157
40764
|
default value: false */
|
|
40158
40765
|
ignore_synonyms?: boolean | undefined;
|
|
40766
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
40767
|
+
optional field
|
|
40768
|
+
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
|
|
40769
|
+
default value: false
|
|
40770
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
40771
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
40772
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
40773
|
+
include_clickstream_data?: boolean | undefined;
|
|
40159
40774
|
/** user-defined task identifier
|
|
40160
40775
|
optional field
|
|
40161
40776
|
the character limit is 255
|
|
@@ -40231,6 +40846,14 @@ optional field
|
|
|
40231
40846
|
if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded;
|
|
40232
40847
|
default value: false */
|
|
40233
40848
|
ignore_synonyms?: boolean | undefined;
|
|
40849
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
40850
|
+
optional field
|
|
40851
|
+
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
|
|
40852
|
+
default value: false
|
|
40853
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
40854
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
40855
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
40856
|
+
include_clickstream_data?: boolean | undefined;
|
|
40234
40857
|
/** user-defined task identifier
|
|
40235
40858
|
optional field
|
|
40236
40859
|
the character limit is 255
|
|
@@ -40248,7 +40871,7 @@ export declare class DataforseoLabsGoogleHistoricalRankOverviewLiveItem implemen
|
|
|
40248
40871
|
month?: number | undefined;
|
|
40249
40872
|
/** ranking data relevant to the specified domain */
|
|
40250
40873
|
metrics?: {
|
|
40251
|
-
[key: string]:
|
|
40874
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
40252
40875
|
} | undefined;
|
|
40253
40876
|
[key: string]: any;
|
|
40254
40877
|
constructor(data?: IDataforseoLabsGoogleHistoricalRankOverviewLiveItem);
|
|
@@ -40265,7 +40888,7 @@ export interface IDataforseoLabsGoogleHistoricalRankOverviewLiveItem {
|
|
|
40265
40888
|
month?: number | undefined;
|
|
40266
40889
|
/** ranking data relevant to the specified domain */
|
|
40267
40890
|
metrics?: {
|
|
40268
|
-
[key: string]:
|
|
40891
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
40269
40892
|
} | undefined;
|
|
40270
40893
|
[key: string]: any;
|
|
40271
40894
|
}
|
|
@@ -40410,7 +41033,7 @@ optional field
|
|
|
40410
41033
|
possible values:
|
|
40411
41034
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
40412
41035
|
default value:
|
|
40413
|
-
["organic", "paid"
|
|
41036
|
+
["organic", "paid"] */
|
|
40414
41037
|
item_types?: string[] | undefined;
|
|
40415
41038
|
/** the maximum number of returned keywords
|
|
40416
41039
|
optional field
|
|
@@ -40440,6 +41063,14 @@ optional field
|
|
|
40440
41063
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
40441
41064
|
default value: false */
|
|
40442
41065
|
include_serp_info?: boolean | undefined;
|
|
41066
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
41067
|
+
optional field
|
|
41068
|
+
if the parameter is set to true, you will receive clickstream_keyword_info, and clickstream_etv fields with clickstream data in the response
|
|
41069
|
+
default value: false
|
|
41070
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
41071
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
41072
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
41073
|
+
include_clickstream_data?: boolean | undefined;
|
|
40443
41074
|
/** ignore highly similar keywords
|
|
40444
41075
|
optional field
|
|
40445
41076
|
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
|
|
@@ -40568,7 +41199,7 @@ optional field
|
|
|
40568
41199
|
possible values:
|
|
40569
41200
|
["organic", "paid", "featured_snippet", "local_pack"]
|
|
40570
41201
|
default value:
|
|
40571
|
-
["organic", "paid"
|
|
41202
|
+
["organic", "paid"] */
|
|
40572
41203
|
item_types?: string[] | undefined;
|
|
40573
41204
|
/** the maximum number of returned keywords
|
|
40574
41205
|
optional field
|
|
@@ -40598,6 +41229,14 @@ optional field
|
|
|
40598
41229
|
if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
|
|
40599
41230
|
default value: false */
|
|
40600
41231
|
include_serp_info?: boolean | undefined;
|
|
41232
|
+
/** include or exclude data from clickstream-based metrics in the result
|
|
41233
|
+
optional field
|
|
41234
|
+
if the parameter is set to true, you will receive clickstream_keyword_info, and clickstream_etv fields with clickstream data in the response
|
|
41235
|
+
default value: false
|
|
41236
|
+
with this parameter enabled, you will be charged double the price for the request
|
|
41237
|
+
Note: clickstream data is available for roughly 15% of keywords in the response
|
|
41238
|
+
learn more about how clickstream-based metrics are calculated in this help center article */
|
|
41239
|
+
include_clickstream_data?: boolean | undefined;
|
|
40601
41240
|
/** ignore highly similar keywords
|
|
40602
41241
|
optional field
|
|
40603
41242
|
if set to true only core keywords will be returned, all highly similar keywords will be excluded;
|
|
@@ -45005,7 +45644,7 @@ you will find the specified tag value in the data object of the response */
|
|
|
45005
45644
|
tag?: string | undefined;
|
|
45006
45645
|
[key: string]: any;
|
|
45007
45646
|
}
|
|
45008
|
-
export declare class
|
|
45647
|
+
export declare class DataforseoLabsLiveItem implements IDataforseoLabsLiveItem {
|
|
45009
45648
|
/** search engine type */
|
|
45010
45649
|
se_type?: string | undefined;
|
|
45011
45650
|
/** keyword data for the returned keyword */
|
|
@@ -45013,12 +45652,12 @@ export declare class DataforseoLabsBingRankedKeywordsLiveItem implements IDatafo
|
|
|
45013
45652
|
/** contains data on the domain’s SERP element found for the returned keyword */
|
|
45014
45653
|
ranked_serp_element?: RankedSerpElement | undefined;
|
|
45015
45654
|
[key: string]: any;
|
|
45016
|
-
constructor(data?:
|
|
45655
|
+
constructor(data?: IDataforseoLabsLiveItem);
|
|
45017
45656
|
init(_data?: any): void;
|
|
45018
|
-
static fromJS(data: any):
|
|
45657
|
+
static fromJS(data: any): DataforseoLabsLiveItem;
|
|
45019
45658
|
toJSON(data?: any): any;
|
|
45020
45659
|
}
|
|
45021
|
-
export interface
|
|
45660
|
+
export interface IDataforseoLabsLiveItem {
|
|
45022
45661
|
/** search engine type */
|
|
45023
45662
|
se_type?: string | undefined;
|
|
45024
45663
|
/** keyword data for the returned keyword */
|
|
@@ -45045,15 +45684,15 @@ if there is no data, then the value is null */
|
|
|
45045
45684
|
/** ranking data relevant to the specified domain
|
|
45046
45685
|
ranking data is provided by the rank_group parameters that show the result’s rank considering only equivalent SERP elements */
|
|
45047
45686
|
metrics?: {
|
|
45048
|
-
[key: string]:
|
|
45687
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
45049
45688
|
} | undefined;
|
|
45050
45689
|
/** ranking data relevant to the specified domain
|
|
45051
45690
|
ranking data is provided by the rank_absolute parameters that indicate the result’s position among all SERP elements */
|
|
45052
45691
|
metrics_absolute?: {
|
|
45053
|
-
[key: string]:
|
|
45692
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
45054
45693
|
} | undefined;
|
|
45055
45694
|
/** contains ranked keywords and related data */
|
|
45056
|
-
items?: (
|
|
45695
|
+
items?: (DataforseoLabsLiveItem | undefined)[] | undefined;
|
|
45057
45696
|
[key: string]: any;
|
|
45058
45697
|
constructor(data?: IDataforseoLabsBingRankedKeywordsLiveResultInfo);
|
|
45059
45698
|
init(_data?: any): void;
|
|
@@ -45078,15 +45717,15 @@ if there is no data, then the value is null */
|
|
|
45078
45717
|
/** ranking data relevant to the specified domain
|
|
45079
45718
|
ranking data is provided by the rank_group parameters that show the result’s rank considering only equivalent SERP elements */
|
|
45080
45719
|
metrics?: {
|
|
45081
|
-
[key: string]:
|
|
45720
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
45082
45721
|
} | undefined;
|
|
45083
45722
|
/** ranking data relevant to the specified domain
|
|
45084
45723
|
ranking data is provided by the rank_absolute parameters that indicate the result’s position among all SERP elements */
|
|
45085
45724
|
metrics_absolute?: {
|
|
45086
|
-
[key: string]:
|
|
45725
|
+
[key: string]: DataforseoLabsMetricsInfo;
|
|
45087
45726
|
} | undefined;
|
|
45088
45727
|
/** contains ranked keywords and related data */
|
|
45089
|
-
items?: (
|
|
45728
|
+
items?: (DataforseoLabsLiveItem | undefined)[] | undefined;
|
|
45090
45729
|
[key: string]: any;
|
|
45091
45730
|
}
|
|
45092
45731
|
export declare class DataforseoLabsBingRankedKeywordsLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsBingRankedKeywordsLiveTaskInfo {
|
|
@@ -46798,7 +47437,7 @@ export declare class AppRankedSerpElementInfo implements IAppRankedSerpElementIn
|
|
|
46798
47437
|
se_type?: string | undefined;
|
|
46799
47438
|
/** contains data on the SERP element
|
|
46800
47439
|
the list of supported SERP elements can be found below */
|
|
46801
|
-
serp_item?:
|
|
47440
|
+
serp_item?: AppDataGooglePlaySearchOrganicSerpElementItem | undefined;
|
|
46802
47441
|
/** direct URL to search engine results
|
|
46803
47442
|
you can use it to make sure that we provided accurate results */
|
|
46804
47443
|
check_url?: string | undefined;
|
|
@@ -46826,7 +47465,7 @@ export interface IAppRankedSerpElementInfo {
|
|
|
46826
47465
|
se_type?: string | undefined;
|
|
46827
47466
|
/** contains data on the SERP element
|
|
46828
47467
|
the list of supported SERP elements can be found below */
|
|
46829
|
-
serp_item?:
|
|
47468
|
+
serp_item?: AppDataGooglePlaySearchOrganicSerpElementItem | undefined;
|
|
46830
47469
|
/** direct URL to search engine results
|
|
46831
47470
|
you can use it to make sure that we provided accurate results */
|
|
46832
47471
|
check_url?: string | undefined;
|
|
@@ -46845,7 +47484,7 @@ in this case, will equal null */
|
|
|
46845
47484
|
previous_updated_time?: string | undefined;
|
|
46846
47485
|
[key: string]: any;
|
|
46847
47486
|
}
|
|
46848
|
-
export declare class
|
|
47487
|
+
export declare class DataforseoLabsGoogleKeywordsForAppLiveItem implements IDataforseoLabsGoogleKeywordsForAppLiveItem {
|
|
46849
47488
|
/** search engine type */
|
|
46850
47489
|
se_type?: string | undefined;
|
|
46851
47490
|
/** keyword data for the returned keyword */
|
|
@@ -46853,12 +47492,12 @@ export declare class DataforseoLabsleKeywordsForAppLiveItem implements IDatafors
|
|
|
46853
47492
|
/** contains data on the domain’s SERP element found for the returned keyword */
|
|
46854
47493
|
ranked_serp_element?: AppRankedSerpElementInfo | undefined;
|
|
46855
47494
|
[key: string]: any;
|
|
46856
|
-
constructor(data?:
|
|
47495
|
+
constructor(data?: IDataforseoLabsGoogleKeywordsForAppLiveItem);
|
|
46857
47496
|
init(_data?: any): void;
|
|
46858
|
-
static fromJS(data: any):
|
|
47497
|
+
static fromJS(data: any): DataforseoLabsGoogleKeywordsForAppLiveItem;
|
|
46859
47498
|
toJSON(data?: any): any;
|
|
46860
47499
|
}
|
|
46861
|
-
export interface
|
|
47500
|
+
export interface IDataforseoLabsGoogleKeywordsForAppLiveItem {
|
|
46862
47501
|
/** search engine type */
|
|
46863
47502
|
se_type?: string | undefined;
|
|
46864
47503
|
/** keyword data for the returned keyword */
|
|
@@ -46881,7 +47520,7 @@ export declare class DataforseoLabsGoogleKeywordsForAppLiveResultInfo implements
|
|
|
46881
47520
|
/** the number of results returned in the items array */
|
|
46882
47521
|
items_count?: number | undefined;
|
|
46883
47522
|
/** contains data related to the ranking keywords for the app specified in the app_id field */
|
|
46884
|
-
items?: (
|
|
47523
|
+
items?: (DataforseoLabsGoogleKeywordsForAppLiveItem | undefined)[] | undefined;
|
|
46885
47524
|
[key: string]: any;
|
|
46886
47525
|
constructor(data?: IDataforseoLabsGoogleKeywordsForAppLiveResultInfo);
|
|
46887
47526
|
init(_data?: any): void;
|
|
@@ -46902,7 +47541,7 @@ export interface IDataforseoLabsGoogleKeywordsForAppLiveResultInfo {
|
|
|
46902
47541
|
/** the number of results returned in the items array */
|
|
46903
47542
|
items_count?: number | undefined;
|
|
46904
47543
|
/** contains data related to the ranking keywords for the app specified in the app_id field */
|
|
46905
|
-
items?: (
|
|
47544
|
+
items?: (DataforseoLabsGoogleKeywordsForAppLiveItem | undefined)[] | undefined;
|
|
46906
47545
|
[key: string]: any;
|
|
46907
47546
|
}
|
|
46908
47547
|
export declare class DataforseoLabsGoogleKeywordsForAppLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleKeywordsForAppLiveTaskInfo {
|
|
@@ -47461,7 +48100,7 @@ you will find the specified tag value in the data object of the response */
|
|
|
47461
48100
|
tag?: string | undefined;
|
|
47462
48101
|
[key: string]: any;
|
|
47463
48102
|
}
|
|
47464
|
-
export declare class
|
|
48103
|
+
export declare class DataforseoLabsGoogleAppIntersectionLiveItem implements IDataforseoLabsGoogleAppIntersectionLiveItem {
|
|
47465
48104
|
/** search engine type */
|
|
47466
48105
|
se_type?: string | undefined;
|
|
47467
48106
|
/** keyword data for the returned keyword */
|
|
@@ -47470,15 +48109,15 @@ export declare class DataforseoLabsleAppIntersectionLiveItem implements IDatafor
|
|
|
47470
48109
|
data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task;
|
|
47471
48110
|
depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively */
|
|
47472
48111
|
intersection_result?: {
|
|
47473
|
-
[key: string]:
|
|
48112
|
+
[key: string]: AppDataGooglePlaySearchOrganicSerpElementItem;
|
|
47474
48113
|
} | undefined;
|
|
47475
48114
|
[key: string]: any;
|
|
47476
|
-
constructor(data?:
|
|
48115
|
+
constructor(data?: IDataforseoLabsGoogleAppIntersectionLiveItem);
|
|
47477
48116
|
init(_data?: any): void;
|
|
47478
|
-
static fromJS(data: any):
|
|
48117
|
+
static fromJS(data: any): DataforseoLabsGoogleAppIntersectionLiveItem;
|
|
47479
48118
|
toJSON(data?: any): any;
|
|
47480
48119
|
}
|
|
47481
|
-
export interface
|
|
48120
|
+
export interface IDataforseoLabsGoogleAppIntersectionLiveItem {
|
|
47482
48121
|
/** search engine type */
|
|
47483
48122
|
se_type?: string | undefined;
|
|
47484
48123
|
/** keyword data for the returned keyword */
|
|
@@ -47487,7 +48126,7 @@ export interface IDataforseoLabsleAppIntersectionLiveItem {
|
|
|
47487
48126
|
data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task;
|
|
47488
48127
|
depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively */
|
|
47489
48128
|
intersection_result?: {
|
|
47490
|
-
[key: string]:
|
|
48129
|
+
[key: string]: AppDataGooglePlaySearchOrganicSerpElementItem;
|
|
47491
48130
|
} | undefined;
|
|
47492
48131
|
[key: string]: any;
|
|
47493
48132
|
}
|
|
@@ -47507,7 +48146,7 @@ export declare class DataforseoLabsGoogleAppIntersectionLiveResultInfo implement
|
|
|
47507
48146
|
/** the number of results returned in the items array */
|
|
47508
48147
|
items_count?: number | undefined;
|
|
47509
48148
|
/** contains data related to the ranking keywords for the app specified in the app_id field */
|
|
47510
|
-
items?: (
|
|
48149
|
+
items?: (DataforseoLabsGoogleAppIntersectionLiveItem | undefined)[] | undefined;
|
|
47511
48150
|
[key: string]: any;
|
|
47512
48151
|
constructor(data?: IDataforseoLabsGoogleAppIntersectionLiveResultInfo);
|
|
47513
48152
|
init(_data?: any): void;
|
|
@@ -47530,7 +48169,7 @@ export interface IDataforseoLabsGoogleAppIntersectionLiveResultInfo {
|
|
|
47530
48169
|
/** the number of results returned in the items array */
|
|
47531
48170
|
items_count?: number | undefined;
|
|
47532
48171
|
/** contains data related to the ranking keywords for the app specified in the app_id field */
|
|
47533
|
-
items?: (
|
|
48172
|
+
items?: (DataforseoLabsGoogleAppIntersectionLiveItem | undefined)[] | undefined;
|
|
47534
48173
|
[key: string]: any;
|
|
47535
48174
|
}
|
|
47536
48175
|
export declare class DataforseoLabsGoogleAppIntersectionLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleAppIntersectionLiveTaskInfo {
|
|
@@ -47997,7 +48636,7 @@ export declare class DataforseoLabsAppleKeywordsForAppLiveResultInfo implements
|
|
|
47997
48636
|
/** the number of results returned in the items array */
|
|
47998
48637
|
items_count?: number | undefined;
|
|
47999
48638
|
/** contains data related to the ranking keywords for the app specified in the app_id field */
|
|
48000
|
-
items?: (
|
|
48639
|
+
items?: (DataforseoLabsLiveItem | undefined)[] | undefined;
|
|
48001
48640
|
[key: string]: any;
|
|
48002
48641
|
constructor(data?: IDataforseoLabsAppleKeywordsForAppLiveResultInfo);
|
|
48003
48642
|
init(_data?: any): void;
|
|
@@ -48018,7 +48657,7 @@ export interface IDataforseoLabsAppleKeywordsForAppLiveResultInfo {
|
|
|
48018
48657
|
/** the number of results returned in the items array */
|
|
48019
48658
|
items_count?: number | undefined;
|
|
48020
48659
|
/** contains data related to the ranking keywords for the app specified in the app_id field */
|
|
48021
|
-
items?: (
|
|
48660
|
+
items?: (DataforseoLabsLiveItem | undefined)[] | undefined;
|
|
48022
48661
|
[key: string]: any;
|
|
48023
48662
|
}
|
|
48024
48663
|
export declare class DataforseoLabsAppleKeywordsForAppLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsAppleKeywordsForAppLiveTaskInfo {
|
|
@@ -48577,6 +49216,36 @@ you will find the specified tag value in the data object of the response */
|
|
|
48577
49216
|
tag?: string | undefined;
|
|
48578
49217
|
[key: string]: any;
|
|
48579
49218
|
}
|
|
49219
|
+
export declare class DataforseoLabsAppleAppIntersectionLiveItem implements IDataforseoLabsAppleAppIntersectionLiveItem {
|
|
49220
|
+
/** search engine type */
|
|
49221
|
+
se_type?: string | undefined;
|
|
49222
|
+
/** keyword data for the returned keyword */
|
|
49223
|
+
keyword_data?: KeywordDataKeywordDataInfo | undefined;
|
|
49224
|
+
/** contains SERP data for the returned keyword
|
|
49225
|
+
data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task;
|
|
49226
|
+
depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively */
|
|
49227
|
+
intersection_result?: {
|
|
49228
|
+
[key: string]: AppDataAppStoreSearchOrganicSerpElementItem;
|
|
49229
|
+
} | undefined;
|
|
49230
|
+
[key: string]: any;
|
|
49231
|
+
constructor(data?: IDataforseoLabsAppleAppIntersectionLiveItem);
|
|
49232
|
+
init(_data?: any): void;
|
|
49233
|
+
static fromJS(data: any): DataforseoLabsAppleAppIntersectionLiveItem;
|
|
49234
|
+
toJSON(data?: any): any;
|
|
49235
|
+
}
|
|
49236
|
+
export interface IDataforseoLabsAppleAppIntersectionLiveItem {
|
|
49237
|
+
/** search engine type */
|
|
49238
|
+
se_type?: string | undefined;
|
|
49239
|
+
/** keyword data for the returned keyword */
|
|
49240
|
+
keyword_data?: KeywordDataKeywordDataInfo | undefined;
|
|
49241
|
+
/** contains SERP data for the returned keyword
|
|
49242
|
+
data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task;
|
|
49243
|
+
depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively */
|
|
49244
|
+
intersection_result?: {
|
|
49245
|
+
[key: string]: AppDataAppStoreSearchOrganicSerpElementItem;
|
|
49246
|
+
} | undefined;
|
|
49247
|
+
[key: string]: any;
|
|
49248
|
+
}
|
|
48580
49249
|
export declare class DataforseoLabsAppleAppIntersectionLiveResultInfo implements IDataforseoLabsAppleAppIntersectionLiveResultInfo {
|
|
48581
49250
|
/** search engine type */
|
|
48582
49251
|
se_type?: string | undefined;
|
|
@@ -48593,7 +49262,7 @@ export declare class DataforseoLabsAppleAppIntersectionLiveResultInfo implements
|
|
|
48593
49262
|
/** the number of results returned in the items array */
|
|
48594
49263
|
items_count?: number | undefined;
|
|
48595
49264
|
/** contains data related to the ranking keywords for the app specified in the app_id field */
|
|
48596
|
-
items?: (
|
|
49265
|
+
items?: (DataforseoLabsAppleAppIntersectionLiveItem | undefined)[] | undefined;
|
|
48597
49266
|
[key: string]: any;
|
|
48598
49267
|
constructor(data?: IDataforseoLabsAppleAppIntersectionLiveResultInfo);
|
|
48599
49268
|
init(_data?: any): void;
|
|
@@ -48616,7 +49285,7 @@ export interface IDataforseoLabsAppleAppIntersectionLiveResultInfo {
|
|
|
48616
49285
|
/** the number of results returned in the items array */
|
|
48617
49286
|
items_count?: number | undefined;
|
|
48618
49287
|
/** contains data related to the ranking keywords for the app specified in the app_id field */
|
|
48619
|
-
items?: (
|
|
49288
|
+
items?: (DataforseoLabsAppleAppIntersectionLiveItem | undefined)[] | undefined;
|
|
48620
49289
|
[key: string]: any;
|
|
48621
49290
|
}
|
|
48622
49291
|
export declare class DataforseoLabsAppleAppIntersectionLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsAppleAppIntersectionLiveTaskInfo {
|
|
@@ -49113,6 +49782,80 @@ export interface IKeywordsDataGoogleAdsLocationsResponseInfo extends IBaseRespon
|
|
|
49113
49782
|
tasks?: (KeywordsDataGoogleAdsLocationsTaskInfo | undefined)[] | undefined;
|
|
49114
49783
|
[key: string]: any;
|
|
49115
49784
|
}
|
|
49785
|
+
export declare class KeywordsDataGoogleAdsLocationsCountryResultInfo implements IKeywordsDataGoogleAdsLocationsCountryResultInfo {
|
|
49786
|
+
/** location code */
|
|
49787
|
+
location_code?: number | undefined;
|
|
49788
|
+
/** full name of the location */
|
|
49789
|
+
location_name?: string | undefined;
|
|
49790
|
+
/** the code of the superordinate location
|
|
49791
|
+
example:
|
|
49792
|
+
"location_code": 9041134,
|
|
49793
|
+
"location_name": "Vienna International Airport,Lower Austria,Austria",
|
|
49794
|
+
"location_code_parent": 20044
|
|
49795
|
+
where location_code_parent corresponds to:
|
|
49796
|
+
"location_code": 20044,
|
|
49797
|
+
"location_name": "Lower Austria,Austria" */
|
|
49798
|
+
location_code_parent?: number | undefined;
|
|
49799
|
+
/** ISO country code of the location */
|
|
49800
|
+
country_iso_code?: string | undefined;
|
|
49801
|
+
/** location type
|
|
49802
|
+
possible values according to Google’s target types */
|
|
49803
|
+
location_type?: string | undefined;
|
|
49804
|
+
[key: string]: any;
|
|
49805
|
+
constructor(data?: IKeywordsDataGoogleAdsLocationsCountryResultInfo);
|
|
49806
|
+
init(_data?: any): void;
|
|
49807
|
+
static fromJS(data: any): KeywordsDataGoogleAdsLocationsCountryResultInfo;
|
|
49808
|
+
toJSON(data?: any): any;
|
|
49809
|
+
}
|
|
49810
|
+
export interface IKeywordsDataGoogleAdsLocationsCountryResultInfo {
|
|
49811
|
+
/** location code */
|
|
49812
|
+
location_code?: number | undefined;
|
|
49813
|
+
/** full name of the location */
|
|
49814
|
+
location_name?: string | undefined;
|
|
49815
|
+
/** the code of the superordinate location
|
|
49816
|
+
example:
|
|
49817
|
+
"location_code": 9041134,
|
|
49818
|
+
"location_name": "Vienna International Airport,Lower Austria,Austria",
|
|
49819
|
+
"location_code_parent": 20044
|
|
49820
|
+
where location_code_parent corresponds to:
|
|
49821
|
+
"location_code": 20044,
|
|
49822
|
+
"location_name": "Lower Austria,Austria" */
|
|
49823
|
+
location_code_parent?: number | undefined;
|
|
49824
|
+
/** ISO country code of the location */
|
|
49825
|
+
country_iso_code?: string | undefined;
|
|
49826
|
+
/** location type
|
|
49827
|
+
possible values according to Google’s target types */
|
|
49828
|
+
location_type?: string | undefined;
|
|
49829
|
+
[key: string]: any;
|
|
49830
|
+
}
|
|
49831
|
+
export declare class KeywordsDataGoogleAdsLocationsCountryTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataGoogleAdsLocationsCountryTaskInfo {
|
|
49832
|
+
/** array of results */
|
|
49833
|
+
result?: (KeywordsDataGoogleAdsLocationsCountryResultInfo | undefined)[] | undefined;
|
|
49834
|
+
[key: string]: any;
|
|
49835
|
+
constructor(data?: IKeywordsDataGoogleAdsLocationsCountryTaskInfo);
|
|
49836
|
+
init(_data?: any): void;
|
|
49837
|
+
static fromJS(data: any): KeywordsDataGoogleAdsLocationsCountryTaskInfo;
|
|
49838
|
+
toJSON(data?: any): any;
|
|
49839
|
+
}
|
|
49840
|
+
export interface IKeywordsDataGoogleAdsLocationsCountryTaskInfo extends IBaseResponseTaskInfo {
|
|
49841
|
+
/** array of results */
|
|
49842
|
+
result?: (KeywordsDataGoogleAdsLocationsCountryResultInfo | undefined)[] | undefined;
|
|
49843
|
+
[key: string]: any;
|
|
49844
|
+
}
|
|
49845
|
+
export declare class KeywordsDataGoogleAdsLocationsCountryResponseInfo extends BaseResponseInfo implements IKeywordsDataGoogleAdsLocationsCountryResponseInfo {
|
|
49846
|
+
/** array of tasks */
|
|
49847
|
+
tasks?: (KeywordsDataGoogleAdsLocationsCountryTaskInfo | undefined)[] | undefined;
|
|
49848
|
+
[key: string]: any;
|
|
49849
|
+
constructor(data?: IKeywordsDataGoogleAdsLocationsCountryResponseInfo);
|
|
49850
|
+
init(_data?: any): void;
|
|
49851
|
+
static fromJS(data: any): KeywordsDataGoogleAdsLocationsCountryResponseInfo;
|
|
49852
|
+
toJSON(data?: any): any;
|
|
49853
|
+
}
|
|
49854
|
+
export interface IKeywordsDataGoogleAdsLocationsCountryResponseInfo extends IBaseResponseInfo {
|
|
49855
|
+
/** array of tasks */
|
|
49856
|
+
tasks?: (KeywordsDataGoogleAdsLocationsCountryTaskInfo | undefined)[] | undefined;
|
|
49857
|
+
[key: string]: any;
|
|
49858
|
+
}
|
|
49116
49859
|
export declare class KeywordsDataGoogleAdsLanguagesResultInfo implements IKeywordsDataGoogleAdsLanguagesResultInfo {
|
|
49117
49860
|
/** language name */
|
|
49118
49861
|
language_name?: string | undefined;
|
|
@@ -52478,14 +53221,17 @@ possible values for news, youtube, images, froogle:
|
|
|
52478
53221
|
time_range?: string | undefined;
|
|
52479
53222
|
/** types of items returned
|
|
52480
53223
|
optional field
|
|
52481
|
-
|
|
52482
|
-
you can set only one item to speed up the execution of the request
|
|
53224
|
+
to speed up the execution of the request, specify one item at a time;
|
|
52483
53225
|
possible values:
|
|
52484
53226
|
"item_types": [
|
|
52485
53227
|
"google_trends_graph",
|
|
52486
53228
|
"google_trends_map",
|
|
52487
53229
|
"google_trends_topics_list",
|
|
52488
53230
|
"google_trends_queries_list"
|
|
53231
|
+
]
|
|
53232
|
+
default value:
|
|
53233
|
+
"item_types": [
|
|
53234
|
+
"google_trends_graph"
|
|
52489
53235
|
] */
|
|
52490
53236
|
item_types?: string[] | undefined;
|
|
52491
53237
|
/** return URL for sending task results
|
|
@@ -52593,14 +53339,17 @@ possible values for news, youtube, images, froogle:
|
|
|
52593
53339
|
time_range?: string | undefined;
|
|
52594
53340
|
/** types of items returned
|
|
52595
53341
|
optional field
|
|
52596
|
-
|
|
52597
|
-
you can set only one item to speed up the execution of the request
|
|
53342
|
+
to speed up the execution of the request, specify one item at a time;
|
|
52598
53343
|
possible values:
|
|
52599
53344
|
"item_types": [
|
|
52600
53345
|
"google_trends_graph",
|
|
52601
53346
|
"google_trends_map",
|
|
52602
53347
|
"google_trends_topics_list",
|
|
52603
53348
|
"google_trends_queries_list"
|
|
53349
|
+
]
|
|
53350
|
+
default value:
|
|
53351
|
+
"item_types": [
|
|
53352
|
+
"google_trends_graph"
|
|
52604
53353
|
] */
|
|
52605
53354
|
item_types?: string[] | undefined;
|
|
52606
53355
|
/** return URL for sending task results
|
|
@@ -54786,7 +55535,7 @@ export interface IKeywordsDataBingLanguagesResponseInfo extends IBaseResponseInf
|
|
|
54786
55535
|
export declare class KeywordsDataBingSearchVolumeTaskPostRequestInfo implements IKeywordsDataBingSearchVolumeTaskPostRequestInfo {
|
|
54787
55536
|
/** keywords
|
|
54788
55537
|
required field
|
|
54789
|
-
The maximum number of keywords you can specify:
|
|
55538
|
+
The maximum number of keywords you can specify: 1000
|
|
54790
55539
|
The maximum number of characters for each keyword: 100
|
|
54791
55540
|
the specified keywords will be converted to lowercase, data will be provided in a separate array */
|
|
54792
55541
|
keywords?: string[];
|
|
@@ -54892,7 +55641,7 @@ you will find the specified tag value in the data object of the response */
|
|
|
54892
55641
|
export interface IKeywordsDataBingSearchVolumeTaskPostRequestInfo {
|
|
54893
55642
|
/** keywords
|
|
54894
55643
|
required field
|
|
54895
|
-
The maximum number of keywords you can specify:
|
|
55644
|
+
The maximum number of keywords you can specify: 1000
|
|
54896
55645
|
The maximum number of characters for each keyword: 100
|
|
54897
55646
|
the specified keywords will be converted to lowercase, data will be provided in a separate array */
|
|
54898
55647
|
keywords?: string[];
|
|
@@ -55196,7 +55945,7 @@ export interface IKeywordsDataBingSearchVolumeTaskGetResponseInfo extends IBaseR
|
|
|
55196
55945
|
export declare class KeywordsDataBingSearchVolumeLiveRequestInfo implements IKeywordsDataBingSearchVolumeLiveRequestInfo {
|
|
55197
55946
|
/** keywords
|
|
55198
55947
|
required field
|
|
55199
|
-
The maximum number of keywords you can specify:
|
|
55948
|
+
The maximum number of keywords you can specify: 1000
|
|
55200
55949
|
The maximum number of characters for each keyword: 100
|
|
55201
55950
|
the specified keywords will be converted to lowercase, data will be provided in a separate array */
|
|
55202
55951
|
keywords?: string[];
|
|
@@ -55282,7 +56031,7 @@ you will find the specified tag value in the data object of the response */
|
|
|
55282
56031
|
export interface IKeywordsDataBingSearchVolumeLiveRequestInfo {
|
|
55283
56032
|
/** keywords
|
|
55284
56033
|
required field
|
|
55285
|
-
The maximum number of keywords you can specify:
|
|
56034
|
+
The maximum number of keywords you can specify: 1000
|
|
55286
56035
|
The maximum number of characters for each keyword: 100
|
|
55287
56036
|
the specified keywords will be converted to lowercase, data will be provided in a separate array */
|
|
55288
56037
|
keywords?: string[];
|
|
@@ -56968,9 +57717,9 @@ export interface IKeywordsDataBingKeywordPerformanceLocationsAndLanguagesRespons
|
|
|
56968
57717
|
export declare class KeywordsDataBingKeywordPerformanceTaskPostRequestInfo implements IKeywordsDataBingKeywordPerformanceTaskPostRequestInfo {
|
|
56969
57718
|
/** keywords
|
|
56970
57719
|
required field
|
|
56971
|
-
The maximum number of keywords you can specify:
|
|
56972
|
-
The maximum number of characters for each keyword: 80
|
|
56973
|
-
The maximum number of words for each keyword phrase: 10
|
|
57720
|
+
The maximum number of keywords you can specify: 1000
|
|
57721
|
+
The maximum number of characters for each keyword: 80
|
|
57722
|
+
The maximum number of words for each keyword phrase: 10
|
|
56974
57723
|
the specified keywords will be converted to lowercase, data will be provided in a separate array */
|
|
56975
57724
|
keywords?: string[];
|
|
56976
57725
|
/** device type
|
|
@@ -57056,9 +57805,9 @@ you will find the specified tag value in the data object of the response */
|
|
|
57056
57805
|
export interface IKeywordsDataBingKeywordPerformanceTaskPostRequestInfo {
|
|
57057
57806
|
/** keywords
|
|
57058
57807
|
required field
|
|
57059
|
-
The maximum number of keywords you can specify:
|
|
57060
|
-
The maximum number of characters for each keyword: 80
|
|
57061
|
-
The maximum number of words for each keyword phrase: 10
|
|
57808
|
+
The maximum number of keywords you can specify: 1000
|
|
57809
|
+
The maximum number of characters for each keyword: 80
|
|
57810
|
+
The maximum number of words for each keyword phrase: 10
|
|
57062
57811
|
the specified keywords will be converted to lowercase, data will be provided in a separate array */
|
|
57063
57812
|
keywords?: string[];
|
|
57064
57813
|
/** device type
|
|
@@ -57416,9 +58165,9 @@ export interface IKeywordsDataBingKeywordPerformanceTaskGetResponseInfo extends
|
|
|
57416
58165
|
export declare class KeywordsDataBingKeywordPerformanceLiveRequestInfo implements IKeywordsDataBingKeywordPerformanceLiveRequestInfo {
|
|
57417
58166
|
/** keywords
|
|
57418
58167
|
required field
|
|
57419
|
-
The maximum number of keywords you can specify:
|
|
57420
|
-
The maximum number of characters for each keyword: 80
|
|
57421
|
-
The maximum number of words for each keyword phrase: 10
|
|
58168
|
+
The maximum number of keywords you can specify: 1000
|
|
58169
|
+
The maximum number of characters for each keyword: 80
|
|
58170
|
+
The maximum number of words for each keyword phrase: 10
|
|
57422
58171
|
the specified keywords will be converted to lowercase, data will be provided in a separate array */
|
|
57423
58172
|
keywords?: string[];
|
|
57424
58173
|
/** device type
|
|
@@ -57484,9 +58233,9 @@ you will find the specified tag value in the data object of the response */
|
|
|
57484
58233
|
export interface IKeywordsDataBingKeywordPerformanceLiveRequestInfo {
|
|
57485
58234
|
/** keywords
|
|
57486
58235
|
required field
|
|
57487
|
-
The maximum number of keywords you can specify:
|
|
57488
|
-
The maximum number of characters for each keyword: 80
|
|
57489
|
-
The maximum number of words for each keyword phrase: 10
|
|
58236
|
+
The maximum number of keywords you can specify: 1000
|
|
58237
|
+
The maximum number of characters for each keyword: 80
|
|
58238
|
+
The maximum number of words for each keyword phrase: 10
|
|
57490
58239
|
the specified keywords will be converted to lowercase, data will be provided in a separate array */
|
|
57491
58240
|
keywords?: string[];
|
|
57492
58241
|
/** device type
|
|
@@ -69335,41 +70084,19 @@ export interface ITestSummary {
|
|
|
69335
70084
|
info?: number | undefined;
|
|
69336
70085
|
[key: string]: any;
|
|
69337
70086
|
}
|
|
69338
|
-
export declare class MicrodataTestResultsInfo implements IMicrodataTestResultsInfo {
|
|
69339
|
-
/** level of microdata error
|
|
69340
|
-
can take the following values: fatal, error, warning, info */
|
|
69341
|
-
level?: string | undefined;
|
|
69342
|
-
/** message associated with an error
|
|
69343
|
-
message providing the details of the detected error */
|
|
69344
|
-
message?: string | undefined;
|
|
69345
|
-
[key: string]: any;
|
|
69346
|
-
constructor(data?: IMicrodataTestResultsInfo);
|
|
69347
|
-
init(_data?: any): void;
|
|
69348
|
-
static fromJS(data: any): MicrodataTestResultsInfo;
|
|
69349
|
-
toJSON(data?: any): any;
|
|
69350
|
-
}
|
|
69351
|
-
export interface IMicrodataTestResultsInfo {
|
|
69352
|
-
/** level of microdata error
|
|
69353
|
-
can take the following values: fatal, error, warning, info */
|
|
69354
|
-
level?: string | undefined;
|
|
69355
|
-
/** message associated with an error
|
|
69356
|
-
message providing the details of the detected error */
|
|
69357
|
-
message?: string | undefined;
|
|
69358
|
-
[key: string]: any;
|
|
69359
|
-
}
|
|
69360
70087
|
export declare class MicrodataFieldsInfo implements IMicrodataFieldsInfo {
|
|
69361
70088
|
/** field name
|
|
69362
70089
|
name of the data field */
|
|
69363
70090
|
name?: string | undefined;
|
|
69364
70091
|
/** parent microdata types
|
|
69365
70092
|
for a full list of available types, please visit schema.org */
|
|
69366
|
-
types?:
|
|
70093
|
+
types?: any | undefined;
|
|
69367
70094
|
/** microdata value
|
|
69368
70095
|
microdata value specified on a target web page */
|
|
69369
70096
|
value?: string | undefined;
|
|
69370
70097
|
/** microdata validation test results
|
|
69371
70098
|
sub-type microdata test results that contain detected errors and related messages */
|
|
69372
|
-
test_results?:
|
|
70099
|
+
test_results?: any | undefined;
|
|
69373
70100
|
/** microdata fields
|
|
69374
70101
|
an array of objects containing data fields related to the certain microdata type */
|
|
69375
70102
|
fields?: (MicrodataFieldsInfo | undefined)[] | undefined;
|
|
@@ -69385,13 +70112,13 @@ name of the data field */
|
|
|
69385
70112
|
name?: string | undefined;
|
|
69386
70113
|
/** parent microdata types
|
|
69387
70114
|
for a full list of available types, please visit schema.org */
|
|
69388
|
-
types?:
|
|
70115
|
+
types?: any | undefined;
|
|
69389
70116
|
/** microdata value
|
|
69390
70117
|
microdata value specified on a target web page */
|
|
69391
70118
|
value?: string | undefined;
|
|
69392
70119
|
/** microdata validation test results
|
|
69393
70120
|
sub-type microdata test results that contain detected errors and related messages */
|
|
69394
|
-
test_results?:
|
|
70121
|
+
test_results?: any | undefined;
|
|
69395
70122
|
/** microdata fields
|
|
69396
70123
|
an array of objects containing data fields related to the certain microdata type */
|
|
69397
70124
|
fields?: (MicrodataFieldsInfo | undefined)[] | undefined;
|
|
@@ -69633,7 +70360,8 @@ browser_screen_scale_factor: 3
|
|
|
69633
70360
|
tablet preset will apply the following values:
|
|
69634
70361
|
browser_screen_width: 1024
|
|
69635
70362
|
browser_screen_height: 1366
|
|
69636
|
-
browser_screen_scale_factor: 2
|
|
70363
|
+
browser_screen_scale_factor: 2
|
|
70364
|
+
Note: in this endpoint, the enable_browser_rendering, enable_javascript, load_resources, and enable_xhr parameters are always enabled. */
|
|
69637
70365
|
browser_preset?: string | undefined;
|
|
69638
70366
|
/** browser screen width
|
|
69639
70367
|
optional field
|
|
@@ -69667,12 +70395,6 @@ set to true if you want to disable the popup requesting cookie consent from the
|
|
|
69667
70395
|
default value:
|
|
69668
70396
|
false */
|
|
69669
70397
|
disable_cookie_popup?: boolean | undefined;
|
|
69670
|
-
/** load javascript on a page
|
|
69671
|
-
optional field
|
|
69672
|
-
set to true if you want to load the scripts available on a page
|
|
69673
|
-
default value: false
|
|
69674
|
-
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
|
|
69675
|
-
enable_javascript?: boolean | undefined;
|
|
69676
70398
|
/** custom javascript
|
|
69677
70399
|
optional field
|
|
69678
70400
|
Note that the execution time for the script you enter here should be 700 ms maximum
|
|
@@ -69687,6 +70409,11 @@ as a response you will receive the following data:
|
|
|
69687
70409
|
}
|
|
69688
70410
|
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
|
|
69689
70411
|
custom_js?: string | undefined;
|
|
70412
|
+
/** switch proxy pool
|
|
70413
|
+
optional field
|
|
70414
|
+
if true, additional proxy pools will be used to obtain the requested data;
|
|
70415
|
+
the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors */
|
|
70416
|
+
switch_pool?: boolean | undefined;
|
|
69690
70417
|
/** proxy pool
|
|
69691
70418
|
optional field
|
|
69692
70419
|
you can choose a location of the proxy pool that will be used to obtain the requested data;
|
|
@@ -69733,7 +70460,8 @@ browser_screen_scale_factor: 3
|
|
|
69733
70460
|
tablet preset will apply the following values:
|
|
69734
70461
|
browser_screen_width: 1024
|
|
69735
70462
|
browser_screen_height: 1366
|
|
69736
|
-
browser_screen_scale_factor: 2
|
|
70463
|
+
browser_screen_scale_factor: 2
|
|
70464
|
+
Note: in this endpoint, the enable_browser_rendering, enable_javascript, load_resources, and enable_xhr parameters are always enabled. */
|
|
69737
70465
|
browser_preset?: string | undefined;
|
|
69738
70466
|
/** browser screen width
|
|
69739
70467
|
optional field
|
|
@@ -69767,12 +70495,6 @@ set to true if you want to disable the popup requesting cookie consent from the
|
|
|
69767
70495
|
default value:
|
|
69768
70496
|
false */
|
|
69769
70497
|
disable_cookie_popup?: boolean | undefined;
|
|
69770
|
-
/** load javascript on a page
|
|
69771
|
-
optional field
|
|
69772
|
-
set to true if you want to load the scripts available on a page
|
|
69773
|
-
default value: false
|
|
69774
|
-
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
|
|
69775
|
-
enable_javascript?: boolean | undefined;
|
|
69776
70498
|
/** custom javascript
|
|
69777
70499
|
optional field
|
|
69778
70500
|
Note that the execution time for the script you enter here should be 700 ms maximum
|
|
@@ -69787,6 +70509,11 @@ as a response you will receive the following data:
|
|
|
69787
70509
|
}
|
|
69788
70510
|
Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
|
|
69789
70511
|
custom_js?: string | undefined;
|
|
70512
|
+
/** switch proxy pool
|
|
70513
|
+
optional field
|
|
70514
|
+
if true, additional proxy pools will be used to obtain the requested data;
|
|
70515
|
+
the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors */
|
|
70516
|
+
switch_pool?: boolean | undefined;
|
|
69790
70517
|
/** proxy pool
|
|
69791
70518
|
optional field
|
|
69792
70519
|
you can choose a location of the proxy pool that will be used to obtain the requested data;
|
|
@@ -69996,11 +70723,11 @@ export interface ITableContentItemInfo {
|
|
|
69996
70723
|
[key: string]: any;
|
|
69997
70724
|
}
|
|
69998
70725
|
export declare class TableContent implements ITableContent {
|
|
69999
|
-
/** content of the header
|
|
70726
|
+
/** parsed content of the header */
|
|
70000
70727
|
header?: (TableContentItemInfo | undefined)[] | undefined;
|
|
70001
70728
|
/** content of the body of the table */
|
|
70002
70729
|
body?: (TableContentItemInfo | undefined)[] | undefined;
|
|
70003
|
-
/**
|
|
70730
|
+
/** content of the footer of the table */
|
|
70004
70731
|
footer?: (TableContentItemInfo | undefined)[] | undefined;
|
|
70005
70732
|
[key: string]: any;
|
|
70006
70733
|
constructor(data?: ITableContent);
|
|
@@ -70009,11 +70736,11 @@ export declare class TableContent implements ITableContent {
|
|
|
70009
70736
|
toJSON(data?: any): any;
|
|
70010
70737
|
}
|
|
70011
70738
|
export interface ITableContent {
|
|
70012
|
-
/** content of the header
|
|
70739
|
+
/** parsed content of the header */
|
|
70013
70740
|
header?: (TableContentItemInfo | undefined)[] | undefined;
|
|
70014
70741
|
/** content of the body of the table */
|
|
70015
70742
|
body?: (TableContentItemInfo | undefined)[] | undefined;
|
|
70016
|
-
/**
|
|
70743
|
+
/** content of the footer of the table */
|
|
70017
70744
|
footer?: (TableContentItemInfo | undefined)[] | undefined;
|
|
70018
70745
|
[key: string]: any;
|
|
70019
70746
|
}
|
|
@@ -70110,9 +70837,9 @@ you can find more information about content priority calculation in this help ce
|
|
|
70110
70837
|
[key: string]: any;
|
|
70111
70838
|
}
|
|
70112
70839
|
export declare class PageContentInfo implements IPageContentInfo {
|
|
70113
|
-
/**
|
|
70840
|
+
/** content of the header of the table */
|
|
70114
70841
|
header?: PageSectionContentInfo | undefined;
|
|
70115
|
-
/** content of the footer
|
|
70842
|
+
/** parsed content of the footer */
|
|
70116
70843
|
footer?: PageSectionContentInfo | undefined;
|
|
70117
70844
|
/** main topic on the page
|
|
70118
70845
|
you can find more information about topic priority calculation in this help center article */
|
|
@@ -70127,9 +70854,9 @@ you can find more information about topic priority calculation in this help cent
|
|
|
70127
70854
|
toJSON(data?: any): any;
|
|
70128
70855
|
}
|
|
70129
70856
|
export interface IPageContentInfo {
|
|
70130
|
-
/**
|
|
70857
|
+
/** content of the header of the table */
|
|
70131
70858
|
header?: PageSectionContentInfo | undefined;
|
|
70132
|
-
/** content of the footer
|
|
70859
|
+
/** parsed content of the footer */
|
|
70133
70860
|
footer?: PageSectionContentInfo | undefined;
|
|
70134
70861
|
/** main topic on the page
|
|
70135
70862
|
you can find more information about topic priority calculation in this help center article */
|
|
@@ -70332,6 +71059,17 @@ default value:
|
|
|
70332
71059
|
false
|
|
70333
71060
|
if you use this field, enable_javascript must be set to true; */
|
|
70334
71061
|
enable_xhr?: boolean | undefined;
|
|
71062
|
+
/** switch proxy pool
|
|
71063
|
+
optional field
|
|
71064
|
+
if true, additional proxy pools will be used to obtain the requested data;
|
|
71065
|
+
the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors */
|
|
71066
|
+
switch_pool?: boolean | undefined;
|
|
71067
|
+
/** proxy pool
|
|
71068
|
+
optional field
|
|
71069
|
+
you can choose a location of the proxy pool that will be used to obtain the requested data;
|
|
71070
|
+
the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors
|
|
71071
|
+
possible values: us, de */
|
|
71072
|
+
ip_pool_for_scan?: string | undefined;
|
|
70335
71073
|
[key: string]: any;
|
|
70336
71074
|
constructor(data?: IOnPageContentParsingLiveRequestInfo);
|
|
70337
71075
|
init(_data?: any): void;
|
|
@@ -70445,6 +71183,17 @@ default value:
|
|
|
70445
71183
|
false
|
|
70446
71184
|
if you use this field, enable_javascript must be set to true; */
|
|
70447
71185
|
enable_xhr?: boolean | undefined;
|
|
71186
|
+
/** switch proxy pool
|
|
71187
|
+
optional field
|
|
71188
|
+
if true, additional proxy pools will be used to obtain the requested data;
|
|
71189
|
+
the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors */
|
|
71190
|
+
switch_pool?: boolean | undefined;
|
|
71191
|
+
/** proxy pool
|
|
71192
|
+
optional field
|
|
71193
|
+
you can choose a location of the proxy pool that will be used to obtain the requested data;
|
|
71194
|
+
the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors
|
|
71195
|
+
possible values: us, de */
|
|
71196
|
+
ip_pool_for_scan?: string | undefined;
|
|
70448
71197
|
[key: string]: any;
|
|
70449
71198
|
}
|
|
70450
71199
|
export declare class RowCells implements IRowCells {
|
|
@@ -70651,6 +71400,17 @@ Note: only integer threshold values can be modified; */
|
|
|
70651
71400
|
checks_threshold?: {
|
|
70652
71401
|
[key: string]: number;
|
|
70653
71402
|
} | undefined;
|
|
71403
|
+
/** switch proxy pool
|
|
71404
|
+
optional field
|
|
71405
|
+
if true, additional proxy pools will be used to obtain the requested data;
|
|
71406
|
+
the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors */
|
|
71407
|
+
switch_pool?: boolean | undefined;
|
|
71408
|
+
/** proxy pool
|
|
71409
|
+
optional field
|
|
71410
|
+
you can choose a location of the proxy pool that will be used to obtain the requested data;
|
|
71411
|
+
the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors
|
|
71412
|
+
possible values: us, de */
|
|
71413
|
+
ip_pool_for_scan?: string | undefined;
|
|
70654
71414
|
[key: string]: any;
|
|
70655
71415
|
constructor(data?: IOnPageInstantPagesRequestInfo);
|
|
70656
71416
|
init(_data?: any): void;
|
|
@@ -70783,6 +71543,17 @@ Note: only integer threshold values can be modified; */
|
|
|
70783
71543
|
checks_threshold?: {
|
|
70784
71544
|
[key: string]: number;
|
|
70785
71545
|
} | undefined;
|
|
71546
|
+
/** switch proxy pool
|
|
71547
|
+
optional field
|
|
71548
|
+
if true, additional proxy pools will be used to obtain the requested data;
|
|
71549
|
+
the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors */
|
|
71550
|
+
switch_pool?: boolean | undefined;
|
|
71551
|
+
/** proxy pool
|
|
71552
|
+
optional field
|
|
71553
|
+
you can choose a location of the proxy pool that will be used to obtain the requested data;
|
|
71554
|
+
the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors
|
|
71555
|
+
possible values: us, de */
|
|
71556
|
+
ip_pool_for_scan?: string | undefined;
|
|
70786
71557
|
[key: string]: any;
|
|
70787
71558
|
}
|
|
70788
71559
|
export declare class OnPageInstantPagesResultInfo implements IOnPageInstantPagesResultInfo {
|
|
@@ -75717,6 +76488,74 @@ export interface IMerchantGoogleProductsTasksReadyResponseInfo extends IBaseResp
|
|
|
75717
76488
|
tasks?: (MerchantGoogleProductsTasksReadyTaskInfo | undefined)[] | undefined;
|
|
75718
76489
|
[key: string]: any;
|
|
75719
76490
|
}
|
|
76491
|
+
export declare class MerchantTasksReadyResultInfo implements IMerchantTasksReadyResultInfo {
|
|
76492
|
+
/** task identifier of the completed task
|
|
76493
|
+
unique task identifier in our system in the UUID format */
|
|
76494
|
+
id?: string | undefined;
|
|
76495
|
+
/** search engine specified when setting the task */
|
|
76496
|
+
se?: string | undefined;
|
|
76497
|
+
/** type of search engine */
|
|
76498
|
+
se_type?: string | undefined;
|
|
76499
|
+
/** date when the task was posted (in the UTC format) */
|
|
76500
|
+
date_posted?: string | undefined;
|
|
76501
|
+
/** user-defined task identifier */
|
|
76502
|
+
tag?: string | undefined;
|
|
76503
|
+
/** URL for collecting the results of the Amazon Reviews Advanced task */
|
|
76504
|
+
endpoint_advanced?: string | undefined;
|
|
76505
|
+
/** URL for collecting the results of the Amazon Reviews HTML task */
|
|
76506
|
+
endpoint_html?: string | undefined;
|
|
76507
|
+
[key: string]: any;
|
|
76508
|
+
constructor(data?: IMerchantTasksReadyResultInfo);
|
|
76509
|
+
init(_data?: any): void;
|
|
76510
|
+
static fromJS(data: any): MerchantTasksReadyResultInfo;
|
|
76511
|
+
toJSON(data?: any): any;
|
|
76512
|
+
}
|
|
76513
|
+
export interface IMerchantTasksReadyResultInfo {
|
|
76514
|
+
/** task identifier of the completed task
|
|
76515
|
+
unique task identifier in our system in the UUID format */
|
|
76516
|
+
id?: string | undefined;
|
|
76517
|
+
/** search engine specified when setting the task */
|
|
76518
|
+
se?: string | undefined;
|
|
76519
|
+
/** type of search engine */
|
|
76520
|
+
se_type?: string | undefined;
|
|
76521
|
+
/** date when the task was posted (in the UTC format) */
|
|
76522
|
+
date_posted?: string | undefined;
|
|
76523
|
+
/** user-defined task identifier */
|
|
76524
|
+
tag?: string | undefined;
|
|
76525
|
+
/** URL for collecting the results of the Amazon Reviews Advanced task */
|
|
76526
|
+
endpoint_advanced?: string | undefined;
|
|
76527
|
+
/** URL for collecting the results of the Amazon Reviews HTML task */
|
|
76528
|
+
endpoint_html?: string | undefined;
|
|
76529
|
+
[key: string]: any;
|
|
76530
|
+
}
|
|
76531
|
+
export declare class MerchantTasksReadyTaskInfo extends BaseResponseTaskInfo implements IMerchantTasksReadyTaskInfo {
|
|
76532
|
+
/** array of results */
|
|
76533
|
+
result?: (MerchantTasksReadyResultInfo | undefined)[] | undefined;
|
|
76534
|
+
[key: string]: any;
|
|
76535
|
+
constructor(data?: IMerchantTasksReadyTaskInfo);
|
|
76536
|
+
init(_data?: any): void;
|
|
76537
|
+
static fromJS(data: any): MerchantTasksReadyTaskInfo;
|
|
76538
|
+
toJSON(data?: any): any;
|
|
76539
|
+
}
|
|
76540
|
+
export interface IMerchantTasksReadyTaskInfo extends IBaseResponseTaskInfo {
|
|
76541
|
+
/** array of results */
|
|
76542
|
+
result?: (MerchantTasksReadyResultInfo | undefined)[] | undefined;
|
|
76543
|
+
[key: string]: any;
|
|
76544
|
+
}
|
|
76545
|
+
export declare class MerchantTasksReadyResponseInfo extends BaseResponseInfo implements IMerchantTasksReadyResponseInfo {
|
|
76546
|
+
/** array of tasks */
|
|
76547
|
+
tasks?: (MerchantTasksReadyTaskInfo | undefined)[] | undefined;
|
|
76548
|
+
[key: string]: any;
|
|
76549
|
+
constructor(data?: IMerchantTasksReadyResponseInfo);
|
|
76550
|
+
init(_data?: any): void;
|
|
76551
|
+
static fromJS(data: any): MerchantTasksReadyResponseInfo;
|
|
76552
|
+
toJSON(data?: any): any;
|
|
76553
|
+
}
|
|
76554
|
+
export interface IMerchantTasksReadyResponseInfo extends IBaseResponseInfo {
|
|
76555
|
+
/** array of tasks */
|
|
76556
|
+
tasks?: (MerchantTasksReadyTaskInfo | undefined)[] | undefined;
|
|
76557
|
+
[key: string]: any;
|
|
76558
|
+
}
|
|
75720
76559
|
export declare class DeliveryInfo implements IDeliveryInfo {
|
|
75721
76560
|
/** delivery information
|
|
75722
76561
|
message accompanying the delivery information as posted by the seller */
|
|
@@ -81561,6 +82400,76 @@ export interface IAppDataGoogleLocationsResponseInfo extends IBaseResponseInfo {
|
|
|
81561
82400
|
tasks?: (AppDataGoogleLocationsTaskInfo | undefined)[] | undefined;
|
|
81562
82401
|
[key: string]: any;
|
|
81563
82402
|
}
|
|
82403
|
+
export declare class AppDataGoogleLocationsCountryResultInfo implements IAppDataGoogleLocationsCountryResultInfo {
|
|
82404
|
+
/** location code */
|
|
82405
|
+
location_code?: number | undefined;
|
|
82406
|
+
/** full name of the location */
|
|
82407
|
+
location_name?: string | undefined;
|
|
82408
|
+
/** the name of the superordinate location
|
|
82409
|
+
example:
|
|
82410
|
+
"location_code": 1006473,
|
|
82411
|
+
"location_name": "Altrincham,England,United Kingdom",
|
|
82412
|
+
"location_name_parent": "England,United Kingdom", where location_name_parent corresponds to:
|
|
82413
|
+
"location_code": 20339,
|
|
82414
|
+
"location_name": "England,United Kingdom" */
|
|
82415
|
+
location_name_parent?: string | undefined;
|
|
82416
|
+
/** ISO country code of the location */
|
|
82417
|
+
country_iso_code?: string | undefined;
|
|
82418
|
+
/** location type */
|
|
82419
|
+
location_type?: string | undefined;
|
|
82420
|
+
[key: string]: any;
|
|
82421
|
+
constructor(data?: IAppDataGoogleLocationsCountryResultInfo);
|
|
82422
|
+
init(_data?: any): void;
|
|
82423
|
+
static fromJS(data: any): AppDataGoogleLocationsCountryResultInfo;
|
|
82424
|
+
toJSON(data?: any): any;
|
|
82425
|
+
}
|
|
82426
|
+
export interface IAppDataGoogleLocationsCountryResultInfo {
|
|
82427
|
+
/** location code */
|
|
82428
|
+
location_code?: number | undefined;
|
|
82429
|
+
/** full name of the location */
|
|
82430
|
+
location_name?: string | undefined;
|
|
82431
|
+
/** the name of the superordinate location
|
|
82432
|
+
example:
|
|
82433
|
+
"location_code": 1006473,
|
|
82434
|
+
"location_name": "Altrincham,England,United Kingdom",
|
|
82435
|
+
"location_name_parent": "England,United Kingdom", where location_name_parent corresponds to:
|
|
82436
|
+
"location_code": 20339,
|
|
82437
|
+
"location_name": "England,United Kingdom" */
|
|
82438
|
+
location_name_parent?: string | undefined;
|
|
82439
|
+
/** ISO country code of the location */
|
|
82440
|
+
country_iso_code?: string | undefined;
|
|
82441
|
+
/** location type */
|
|
82442
|
+
location_type?: string | undefined;
|
|
82443
|
+
[key: string]: any;
|
|
82444
|
+
}
|
|
82445
|
+
export declare class AppDataGoogleLocationsCountryTaskInfo extends BaseResponseTaskInfo implements IAppDataGoogleLocationsCountryTaskInfo {
|
|
82446
|
+
/** array of results */
|
|
82447
|
+
result?: (AppDataGoogleLocationsCountryResultInfo | undefined)[] | undefined;
|
|
82448
|
+
[key: string]: any;
|
|
82449
|
+
constructor(data?: IAppDataGoogleLocationsCountryTaskInfo);
|
|
82450
|
+
init(_data?: any): void;
|
|
82451
|
+
static fromJS(data: any): AppDataGoogleLocationsCountryTaskInfo;
|
|
82452
|
+
toJSON(data?: any): any;
|
|
82453
|
+
}
|
|
82454
|
+
export interface IAppDataGoogleLocationsCountryTaskInfo extends IBaseResponseTaskInfo {
|
|
82455
|
+
/** array of results */
|
|
82456
|
+
result?: (AppDataGoogleLocationsCountryResultInfo | undefined)[] | undefined;
|
|
82457
|
+
[key: string]: any;
|
|
82458
|
+
}
|
|
82459
|
+
export declare class AppDataGoogleLocationsCountryResponseInfo extends BaseResponseInfo implements IAppDataGoogleLocationsCountryResponseInfo {
|
|
82460
|
+
/** array of tasks */
|
|
82461
|
+
tasks?: (AppDataGoogleLocationsCountryTaskInfo | undefined)[] | undefined;
|
|
82462
|
+
[key: string]: any;
|
|
82463
|
+
constructor(data?: IAppDataGoogleLocationsCountryResponseInfo);
|
|
82464
|
+
init(_data?: any): void;
|
|
82465
|
+
static fromJS(data: any): AppDataGoogleLocationsCountryResponseInfo;
|
|
82466
|
+
toJSON(data?: any): any;
|
|
82467
|
+
}
|
|
82468
|
+
export interface IAppDataGoogleLocationsCountryResponseInfo extends IBaseResponseInfo {
|
|
82469
|
+
/** array of tasks */
|
|
82470
|
+
tasks?: (AppDataGoogleLocationsCountryTaskInfo | undefined)[] | undefined;
|
|
82471
|
+
[key: string]: any;
|
|
82472
|
+
}
|
|
81564
82473
|
export declare class AppDataGoogleLanguagesResultInfo implements IAppDataGoogleLanguagesResultInfo {
|
|
81565
82474
|
/** language name */
|
|
81566
82475
|
language_name?: string | undefined;
|
|
@@ -81643,6 +82552,7 @@ unique task identifier in our system in the UUID format */
|
|
|
81643
82552
|
id?: string | undefined;
|
|
81644
82553
|
/** search engine specified when setting the task */
|
|
81645
82554
|
se?: string | undefined;
|
|
82555
|
+
/** search engine type */
|
|
81646
82556
|
se_type?: string | undefined;
|
|
81647
82557
|
/** date when the task was posted (in the UTC format) */
|
|
81648
82558
|
date_posted?: string | undefined;
|
|
@@ -81665,6 +82575,7 @@ unique task identifier in our system in the UUID format */
|
|
|
81665
82575
|
id?: string | undefined;
|
|
81666
82576
|
/** search engine specified when setting the task */
|
|
81667
82577
|
se?: string | undefined;
|
|
82578
|
+
/** search engine type */
|
|
81668
82579
|
se_type?: string | undefined;
|
|
81669
82580
|
/** date when the task was posted (in the UTC format) */
|
|
81670
82581
|
date_posted?: string | undefined;
|
|
@@ -81705,6 +82616,76 @@ export interface IAppDataGoogleAppSearchesTasksReadyResponseInfo extends IBaseRe
|
|
|
81705
82616
|
tasks?: (AppDataGoogleAppSearchesTasksReadyTaskInfo | undefined)[] | undefined;
|
|
81706
82617
|
[key: string]: any;
|
|
81707
82618
|
}
|
|
82619
|
+
export declare class AppDataTasksReadyResultInfo implements IAppDataTasksReadyResultInfo {
|
|
82620
|
+
/** task identifier of the completed task
|
|
82621
|
+
unique task identifier in our system in the UUID format */
|
|
82622
|
+
id?: string | undefined;
|
|
82623
|
+
/** search engine specified when setting the task */
|
|
82624
|
+
se?: string | undefined;
|
|
82625
|
+
/** search engine type */
|
|
82626
|
+
se_type?: string | undefined;
|
|
82627
|
+
/** date when the task was posted (in the UTC format) */
|
|
82628
|
+
date_posted?: string | undefined;
|
|
82629
|
+
/** user-defined task identifier */
|
|
82630
|
+
tag?: string | undefined;
|
|
82631
|
+
/** URL for collecting the results of the Apple App Reviews task */
|
|
82632
|
+
endpoint_advanced?: string | undefined;
|
|
82633
|
+
/** URL for collecting the results of the Apple App Reviews HTML task
|
|
82634
|
+
if HTML tasks are not supported in the specified endpoint, the value will be null */
|
|
82635
|
+
endpoint_html?: string | undefined;
|
|
82636
|
+
[key: string]: any;
|
|
82637
|
+
constructor(data?: IAppDataTasksReadyResultInfo);
|
|
82638
|
+
init(_data?: any): void;
|
|
82639
|
+
static fromJS(data: any): AppDataTasksReadyResultInfo;
|
|
82640
|
+
toJSON(data?: any): any;
|
|
82641
|
+
}
|
|
82642
|
+
export interface IAppDataTasksReadyResultInfo {
|
|
82643
|
+
/** task identifier of the completed task
|
|
82644
|
+
unique task identifier in our system in the UUID format */
|
|
82645
|
+
id?: string | undefined;
|
|
82646
|
+
/** search engine specified when setting the task */
|
|
82647
|
+
se?: string | undefined;
|
|
82648
|
+
/** search engine type */
|
|
82649
|
+
se_type?: string | undefined;
|
|
82650
|
+
/** date when the task was posted (in the UTC format) */
|
|
82651
|
+
date_posted?: string | undefined;
|
|
82652
|
+
/** user-defined task identifier */
|
|
82653
|
+
tag?: string | undefined;
|
|
82654
|
+
/** URL for collecting the results of the Apple App Reviews task */
|
|
82655
|
+
endpoint_advanced?: string | undefined;
|
|
82656
|
+
/** URL for collecting the results of the Apple App Reviews HTML task
|
|
82657
|
+
if HTML tasks are not supported in the specified endpoint, the value will be null */
|
|
82658
|
+
endpoint_html?: string | undefined;
|
|
82659
|
+
[key: string]: any;
|
|
82660
|
+
}
|
|
82661
|
+
export declare class AppDataTasksReadyTaskInfo extends BaseResponseTaskInfo implements IAppDataTasksReadyTaskInfo {
|
|
82662
|
+
/** array of results */
|
|
82663
|
+
result?: (AppDataTasksReadyResultInfo | undefined)[] | undefined;
|
|
82664
|
+
[key: string]: any;
|
|
82665
|
+
constructor(data?: IAppDataTasksReadyTaskInfo);
|
|
82666
|
+
init(_data?: any): void;
|
|
82667
|
+
static fromJS(data: any): AppDataTasksReadyTaskInfo;
|
|
82668
|
+
toJSON(data?: any): any;
|
|
82669
|
+
}
|
|
82670
|
+
export interface IAppDataTasksReadyTaskInfo extends IBaseResponseTaskInfo {
|
|
82671
|
+
/** array of results */
|
|
82672
|
+
result?: (AppDataTasksReadyResultInfo | undefined)[] | undefined;
|
|
82673
|
+
[key: string]: any;
|
|
82674
|
+
}
|
|
82675
|
+
export declare class AppDataTasksReadyResponseInfo extends BaseResponseInfo implements IAppDataTasksReadyResponseInfo {
|
|
82676
|
+
/** array of tasks */
|
|
82677
|
+
tasks?: (AppDataTasksReadyTaskInfo | undefined)[] | undefined;
|
|
82678
|
+
[key: string]: any;
|
|
82679
|
+
constructor(data?: IAppDataTasksReadyResponseInfo);
|
|
82680
|
+
init(_data?: any): void;
|
|
82681
|
+
static fromJS(data: any): AppDataTasksReadyResponseInfo;
|
|
82682
|
+
toJSON(data?: any): any;
|
|
82683
|
+
}
|
|
82684
|
+
export interface IAppDataTasksReadyResponseInfo extends IBaseResponseInfo {
|
|
82685
|
+
/** array of tasks */
|
|
82686
|
+
tasks?: (AppDataTasksReadyTaskInfo | undefined)[] | undefined;
|
|
82687
|
+
[key: string]: any;
|
|
82688
|
+
}
|
|
81708
82689
|
export declare class AppDataGoogleAppSearchesTaskGetAdvancedResultInfo implements IAppDataGoogleAppSearchesTaskGetAdvancedResultInfo {
|
|
81709
82690
|
/** keyword received in a POST request */
|
|
81710
82691
|
keyword?: string | undefined;
|
|
@@ -82109,6 +83090,7 @@ unique task identifier in our system in the UUID format */
|
|
|
82109
83090
|
id?: string | undefined;
|
|
82110
83091
|
/** search engine specified when setting the task */
|
|
82111
83092
|
se?: string | undefined;
|
|
83093
|
+
/** search engine type */
|
|
82112
83094
|
se_type?: string | undefined;
|
|
82113
83095
|
/** date when the task was posted (in the UTC format) */
|
|
82114
83096
|
date_posted?: string | undefined;
|
|
@@ -82131,6 +83113,7 @@ unique task identifier in our system in the UUID format */
|
|
|
82131
83113
|
id?: string | undefined;
|
|
82132
83114
|
/** search engine specified when setting the task */
|
|
82133
83115
|
se?: string | undefined;
|
|
83116
|
+
/** search engine type */
|
|
82134
83117
|
se_type?: string | undefined;
|
|
82135
83118
|
/** date when the task was posted (in the UTC format) */
|
|
82136
83119
|
date_posted?: string | undefined;
|
|
@@ -82529,6 +83512,7 @@ unique task identifier in our system in the UUID format */
|
|
|
82529
83512
|
id?: string | undefined;
|
|
82530
83513
|
/** search engine specified when setting the task */
|
|
82531
83514
|
se?: string | undefined;
|
|
83515
|
+
/** search engine type */
|
|
82532
83516
|
se_type?: string | undefined;
|
|
82533
83517
|
/** date when the task was posted (in the UTC format) */
|
|
82534
83518
|
date_posted?: string | undefined;
|
|
@@ -82551,6 +83535,7 @@ unique task identifier in our system in the UUID format */
|
|
|
82551
83535
|
id?: string | undefined;
|
|
82552
83536
|
/** search engine specified when setting the task */
|
|
82553
83537
|
se?: string | undefined;
|
|
83538
|
+
/** search engine type */
|
|
82554
83539
|
se_type?: string | undefined;
|
|
82555
83540
|
/** date when the task was posted (in the UTC format) */
|
|
82556
83541
|
date_posted?: string | undefined;
|
|
@@ -83197,6 +84182,7 @@ unique task identifier in our system in the UUID format */
|
|
|
83197
84182
|
id?: string | undefined;
|
|
83198
84183
|
/** search engine specified when setting the task */
|
|
83199
84184
|
se?: string | undefined;
|
|
84185
|
+
/** search engine type */
|
|
83200
84186
|
se_type?: string | undefined;
|
|
83201
84187
|
/** date when the task was posted (in the UTC format) */
|
|
83202
84188
|
date_posted?: string | undefined;
|
|
@@ -83219,6 +84205,7 @@ unique task identifier in our system in the UUID format */
|
|
|
83219
84205
|
id?: string | undefined;
|
|
83220
84206
|
/** search engine specified when setting the task */
|
|
83221
84207
|
se?: string | undefined;
|
|
84208
|
+
/** search engine type */
|
|
83222
84209
|
se_type?: string | undefined;
|
|
83223
84210
|
/** date when the task was posted (in the UTC format) */
|
|
83224
84211
|
date_posted?: string | undefined;
|
|
@@ -83751,7 +84738,7 @@ you will find the specified tag value in the data object of the response */
|
|
|
83751
84738
|
tag?: string | undefined;
|
|
83752
84739
|
[key: string]: any;
|
|
83753
84740
|
}
|
|
83754
|
-
export declare class
|
|
84741
|
+
export declare class AppDataGoogleAppListingsSearchLiveItem implements IAppDataGoogleAppListingsSearchLiveItem {
|
|
83755
84742
|
/** ID of the returned app */
|
|
83756
84743
|
app_id?: string | undefined;
|
|
83757
84744
|
/** search engine domain in a POST array */
|
|
@@ -83769,14 +84756,14 @@ example:
|
|
|
83769
84756
|
2023-05-23 10:16:19 +00:00 */
|
|
83770
84757
|
time_update?: string | undefined;
|
|
83771
84758
|
/** detailed information about the app */
|
|
83772
|
-
item?:
|
|
84759
|
+
item?: AppDataGooglePlayInfoOrganicSerpElementItem | undefined;
|
|
83773
84760
|
[key: string]: any;
|
|
83774
|
-
constructor(data?:
|
|
84761
|
+
constructor(data?: IAppDataGoogleAppListingsSearchLiveItem);
|
|
83775
84762
|
init(_data?: any): void;
|
|
83776
|
-
static fromJS(data: any):
|
|
84763
|
+
static fromJS(data: any): AppDataGoogleAppListingsSearchLiveItem;
|
|
83777
84764
|
toJSON(data?: any): any;
|
|
83778
84765
|
}
|
|
83779
|
-
export interface
|
|
84766
|
+
export interface IAppDataGoogleAppListingsSearchLiveItem {
|
|
83780
84767
|
/** ID of the returned app */
|
|
83781
84768
|
app_id?: string | undefined;
|
|
83782
84769
|
/** search engine domain in a POST array */
|
|
@@ -83794,7 +84781,7 @@ example:
|
|
|
83794
84781
|
2023-05-23 10:16:19 +00:00 */
|
|
83795
84782
|
time_update?: string | undefined;
|
|
83796
84783
|
/** detailed information about the app */
|
|
83797
|
-
item?:
|
|
84784
|
+
item?: AppDataGooglePlayInfoOrganicSerpElementItem | undefined;
|
|
83798
84785
|
[key: string]: any;
|
|
83799
84786
|
}
|
|
83800
84787
|
export declare class AppDataGoogleAppListingsSearchLiveResultInfo implements IAppDataGoogleAppListingsSearchLiveResultInfo {
|
|
@@ -83808,7 +84795,7 @@ export declare class AppDataGoogleAppListingsSearchLiveResultInfo implements IAp
|
|
|
83808
84795
|
you can use this parameter in the POST request to avoid timeouts while trying to obtain over 100,000 results in a single request */
|
|
83809
84796
|
offset_token?: string | undefined;
|
|
83810
84797
|
/** array of apps and related data */
|
|
83811
|
-
items?: (
|
|
84798
|
+
items?: (AppDataGoogleAppListingsSearchLiveItem | undefined)[] | undefined;
|
|
83812
84799
|
[key: string]: any;
|
|
83813
84800
|
constructor(data?: IAppDataGoogleAppListingsSearchLiveResultInfo);
|
|
83814
84801
|
init(_data?: any): void;
|
|
@@ -83826,7 +84813,7 @@ export interface IAppDataGoogleAppListingsSearchLiveResultInfo {
|
|
|
83826
84813
|
you can use this parameter in the POST request to avoid timeouts while trying to obtain over 100,000 results in a single request */
|
|
83827
84814
|
offset_token?: string | undefined;
|
|
83828
84815
|
/** array of apps and related data */
|
|
83829
|
-
items?: (
|
|
84816
|
+
items?: (AppDataGoogleAppListingsSearchLiveItem | undefined)[] | undefined;
|
|
83830
84817
|
[key: string]: any;
|
|
83831
84818
|
}
|
|
83832
84819
|
export declare class AppDataGoogleAppListingsSearchLiveTaskInfo extends BaseResponseTaskInfo implements IAppDataGoogleAppListingsSearchLiveTaskInfo {
|
|
@@ -84239,6 +85226,7 @@ unique task identifier in our system in the UUID format */
|
|
|
84239
85226
|
id?: string | undefined;
|
|
84240
85227
|
/** search engine specified when setting the task */
|
|
84241
85228
|
se?: string | undefined;
|
|
85229
|
+
/** search engine type */
|
|
84242
85230
|
se_type?: string | undefined;
|
|
84243
85231
|
/** date when the task was posted (in the UTC format) */
|
|
84244
85232
|
date_posted?: string | undefined;
|
|
@@ -84261,6 +85249,7 @@ unique task identifier in our system in the UUID format */
|
|
|
84261
85249
|
id?: string | undefined;
|
|
84262
85250
|
/** search engine specified when setting the task */
|
|
84263
85251
|
se?: string | undefined;
|
|
85252
|
+
/** search engine type */
|
|
84264
85253
|
se_type?: string | undefined;
|
|
84265
85254
|
/** date when the task was posted (in the UTC format) */
|
|
84266
85255
|
date_posted?: string | undefined;
|
|
@@ -84581,6 +85570,7 @@ unique task identifier in our system in the UUID format */
|
|
|
84581
85570
|
id?: string | undefined;
|
|
84582
85571
|
/** search engine specified when setting the task */
|
|
84583
85572
|
se?: string | undefined;
|
|
85573
|
+
/** search engine type */
|
|
84584
85574
|
se_type?: string | undefined;
|
|
84585
85575
|
/** date when the task was posted (in the UTC format) */
|
|
84586
85576
|
date_posted?: string | undefined;
|
|
@@ -84603,6 +85593,7 @@ unique task identifier in our system in the UUID format */
|
|
|
84603
85593
|
id?: string | undefined;
|
|
84604
85594
|
/** search engine specified when setting the task */
|
|
84605
85595
|
se?: string | undefined;
|
|
85596
|
+
/** search engine type */
|
|
84606
85597
|
se_type?: string | undefined;
|
|
84607
85598
|
/** date when the task was posted (in the UTC format) */
|
|
84608
85599
|
date_posted?: string | undefined;
|
|
@@ -85101,6 +86092,7 @@ unique task identifier in our system in the UUID format */
|
|
|
85101
86092
|
id?: string | undefined;
|
|
85102
86093
|
/** search engine specified when setting the task */
|
|
85103
86094
|
se?: string | undefined;
|
|
86095
|
+
/** search engine type */
|
|
85104
86096
|
se_type?: string | undefined;
|
|
85105
86097
|
/** date when the task was posted (in the UTC format) */
|
|
85106
86098
|
date_posted?: string | undefined;
|
|
@@ -85123,6 +86115,7 @@ unique task identifier in our system in the UUID format */
|
|
|
85123
86115
|
id?: string | undefined;
|
|
85124
86116
|
/** search engine specified when setting the task */
|
|
85125
86117
|
se?: string | undefined;
|
|
86118
|
+
/** search engine type */
|
|
85126
86119
|
se_type?: string | undefined;
|
|
85127
86120
|
/** date when the task was posted (in the UTC format) */
|
|
85128
86121
|
date_posted?: string | undefined;
|
|
@@ -85477,6 +86470,7 @@ unique task identifier in our system in the UUID format */
|
|
|
85477
86470
|
id?: string | undefined;
|
|
85478
86471
|
/** search engine specified when setting the task */
|
|
85479
86472
|
se?: string | undefined;
|
|
86473
|
+
/** search engine type */
|
|
85480
86474
|
se_type?: string | undefined;
|
|
85481
86475
|
/** date when the task was posted (in the UTC format) */
|
|
85482
86476
|
date_posted?: string | undefined;
|
|
@@ -85499,6 +86493,7 @@ unique task identifier in our system in the UUID format */
|
|
|
85499
86493
|
id?: string | undefined;
|
|
85500
86494
|
/** search engine specified when setting the task */
|
|
85501
86495
|
se?: string | undefined;
|
|
86496
|
+
/** search engine type */
|
|
85502
86497
|
se_type?: string | undefined;
|
|
85503
86498
|
/** date when the task was posted (in the UTC format) */
|
|
85504
86499
|
date_posted?: string | undefined;
|
|
@@ -85891,6 +86886,52 @@ you will find the specified tag value in the data object of the response */
|
|
|
85891
86886
|
tag?: string | undefined;
|
|
85892
86887
|
[key: string]: any;
|
|
85893
86888
|
}
|
|
86889
|
+
export declare class AppDataAppleAppListingsSearchLiveItem implements IAppDataAppleAppListingsSearchLiveItem {
|
|
86890
|
+
/** ID of the returned app */
|
|
86891
|
+
app_id?: string | undefined;
|
|
86892
|
+
/** search engine domain in a POST array */
|
|
86893
|
+
se_domain?: string | undefined;
|
|
86894
|
+
/** location code in a POST array */
|
|
86895
|
+
location_code?: number | undefined;
|
|
86896
|
+
/** language code in a POST array */
|
|
86897
|
+
language_code?: string | undefined;
|
|
86898
|
+
/** direct URL to search engine results
|
|
86899
|
+
you can use it to make sure that we provided accurate results */
|
|
86900
|
+
check_url?: string | undefined;
|
|
86901
|
+
/** date and time when SERP data was last updated
|
|
86902
|
+
in the ISO 8601 format: “YYYY-MM-DDThh:mm:ss.sssssssZ”
|
|
86903
|
+
example:
|
|
86904
|
+
2023-05-23 10:16:19 +00:00 */
|
|
86905
|
+
time_update?: string | undefined;
|
|
86906
|
+
/** detailed information about the app */
|
|
86907
|
+
item?: AppDataAppStoreInfoOrganicSerpElementItem | undefined;
|
|
86908
|
+
[key: string]: any;
|
|
86909
|
+
constructor(data?: IAppDataAppleAppListingsSearchLiveItem);
|
|
86910
|
+
init(_data?: any): void;
|
|
86911
|
+
static fromJS(data: any): AppDataAppleAppListingsSearchLiveItem;
|
|
86912
|
+
toJSON(data?: any): any;
|
|
86913
|
+
}
|
|
86914
|
+
export interface IAppDataAppleAppListingsSearchLiveItem {
|
|
86915
|
+
/** ID of the returned app */
|
|
86916
|
+
app_id?: string | undefined;
|
|
86917
|
+
/** search engine domain in a POST array */
|
|
86918
|
+
se_domain?: string | undefined;
|
|
86919
|
+
/** location code in a POST array */
|
|
86920
|
+
location_code?: number | undefined;
|
|
86921
|
+
/** language code in a POST array */
|
|
86922
|
+
language_code?: string | undefined;
|
|
86923
|
+
/** direct URL to search engine results
|
|
86924
|
+
you can use it to make sure that we provided accurate results */
|
|
86925
|
+
check_url?: string | undefined;
|
|
86926
|
+
/** date and time when SERP data was last updated
|
|
86927
|
+
in the ISO 8601 format: “YYYY-MM-DDThh:mm:ss.sssssssZ”
|
|
86928
|
+
example:
|
|
86929
|
+
2023-05-23 10:16:19 +00:00 */
|
|
86930
|
+
time_update?: string | undefined;
|
|
86931
|
+
/** detailed information about the app */
|
|
86932
|
+
item?: AppDataAppStoreInfoOrganicSerpElementItem | undefined;
|
|
86933
|
+
[key: string]: any;
|
|
86934
|
+
}
|
|
85894
86935
|
export declare class AppDataAppleAppListingsSearchLiveResultInfo implements IAppDataAppleAppListingsSearchLiveResultInfo {
|
|
85895
86936
|
/** the total number of relevant results in the database */
|
|
85896
86937
|
total_count?: number | undefined;
|
|
@@ -85902,7 +86943,7 @@ export declare class AppDataAppleAppListingsSearchLiveResultInfo implements IApp
|
|
|
85902
86943
|
you can use this parameter in the POST request to avoid timeouts while trying to obtain over 100,000 results in a single request */
|
|
85903
86944
|
offset_token?: string | undefined;
|
|
85904
86945
|
/** array of apps and related data */
|
|
85905
|
-
items?: (
|
|
86946
|
+
items?: (AppDataAppleAppListingsSearchLiveItem | undefined)[] | undefined;
|
|
85906
86947
|
[key: string]: any;
|
|
85907
86948
|
constructor(data?: IAppDataAppleAppListingsSearchLiveResultInfo);
|
|
85908
86949
|
init(_data?: any): void;
|
|
@@ -85920,7 +86961,7 @@ export interface IAppDataAppleAppListingsSearchLiveResultInfo {
|
|
|
85920
86961
|
you can use this parameter in the POST request to avoid timeouts while trying to obtain over 100,000 results in a single request */
|
|
85921
86962
|
offset_token?: string | undefined;
|
|
85922
86963
|
/** array of apps and related data */
|
|
85923
|
-
items?: (
|
|
86964
|
+
items?: (AppDataAppleAppListingsSearchLiveItem | undefined)[] | undefined;
|
|
85924
86965
|
[key: string]: any;
|
|
85925
86966
|
}
|
|
85926
86967
|
export declare class AppDataAppleAppListingsSearchLiveTaskInfo extends BaseResponseTaskInfo implements IAppDataAppleAppListingsSearchLiveTaskInfo {
|
|
@@ -86825,6 +87866,8 @@ information related to operational hours of the business entity */
|
|
|
86825
87866
|
/** popular times
|
|
86826
87867
|
information related to busy hours of the business entity */
|
|
86827
87868
|
popular_times?: PopularTimes | undefined;
|
|
87869
|
+
/** available interactions with the business
|
|
87870
|
+
list of options to interact with the business directly from search results */
|
|
86828
87871
|
local_business_links?: (BaseLocalBusinessLink | undefined)[] | undefined;
|
|
86829
87872
|
/** available contacts of the business
|
|
86830
87873
|
list of contacts to interact with the business */
|
|
@@ -86937,6 +87980,8 @@ information related to operational hours of the business entity */
|
|
|
86937
87980
|
/** popular times
|
|
86938
87981
|
information related to busy hours of the business entity */
|
|
86939
87982
|
popular_times?: PopularTimes | undefined;
|
|
87983
|
+
/** available interactions with the business
|
|
87984
|
+
list of options to interact with the business directly from search results */
|
|
86940
87985
|
local_business_links?: (BaseLocalBusinessLink | undefined)[] | undefined;
|
|
86941
87986
|
/** available contacts of the business
|
|
86942
87987
|
list of contacts to interact with the business */
|
|
@@ -87569,6 +88614,72 @@ export interface IBusinessDataGoogleMyBusinessInfoTasksReadyResponseInfo extends
|
|
|
87569
88614
|
tasks?: (BusinessDataGoogleMyBusinessInfoTasksReadyTaskInfo | undefined)[] | undefined;
|
|
87570
88615
|
[key: string]: any;
|
|
87571
88616
|
}
|
|
88617
|
+
export declare class BusinessDataTasksReadyResultInfo implements IBusinessDataTasksReadyResultInfo {
|
|
88618
|
+
/** task identifier of the completed task
|
|
88619
|
+
unique task identifier in our system in the UUID format */
|
|
88620
|
+
id?: string | undefined;
|
|
88621
|
+
/** search engine specified when setting the task
|
|
88622
|
+
can take the following values: tripadvisor */
|
|
88623
|
+
se?: string | undefined;
|
|
88624
|
+
/** search engine type */
|
|
88625
|
+
se_type?: string | undefined;
|
|
88626
|
+
/** date when the task was posted (in the UTC format) */
|
|
88627
|
+
date_posted?: string | undefined;
|
|
88628
|
+
/** user-defined task identifier */
|
|
88629
|
+
tag?: string | undefined;
|
|
88630
|
+
/** URL for collecting the results of the task */
|
|
88631
|
+
endpoint?: string | undefined;
|
|
88632
|
+
[key: string]: any;
|
|
88633
|
+
constructor(data?: IBusinessDataTasksReadyResultInfo);
|
|
88634
|
+
init(_data?: any): void;
|
|
88635
|
+
static fromJS(data: any): BusinessDataTasksReadyResultInfo;
|
|
88636
|
+
toJSON(data?: any): any;
|
|
88637
|
+
}
|
|
88638
|
+
export interface IBusinessDataTasksReadyResultInfo {
|
|
88639
|
+
/** task identifier of the completed task
|
|
88640
|
+
unique task identifier in our system in the UUID format */
|
|
88641
|
+
id?: string | undefined;
|
|
88642
|
+
/** search engine specified when setting the task
|
|
88643
|
+
can take the following values: tripadvisor */
|
|
88644
|
+
se?: string | undefined;
|
|
88645
|
+
/** search engine type */
|
|
88646
|
+
se_type?: string | undefined;
|
|
88647
|
+
/** date when the task was posted (in the UTC format) */
|
|
88648
|
+
date_posted?: string | undefined;
|
|
88649
|
+
/** user-defined task identifier */
|
|
88650
|
+
tag?: string | undefined;
|
|
88651
|
+
/** URL for collecting the results of the task */
|
|
88652
|
+
endpoint?: string | undefined;
|
|
88653
|
+
[key: string]: any;
|
|
88654
|
+
}
|
|
88655
|
+
export declare class BusinessDataTasksReadyTaskInfo extends BaseResponseTaskInfo implements IBusinessDataTasksReadyTaskInfo {
|
|
88656
|
+
/** array of results */
|
|
88657
|
+
result?: (BusinessDataTasksReadyResultInfo | undefined)[] | undefined;
|
|
88658
|
+
[key: string]: any;
|
|
88659
|
+
constructor(data?: IBusinessDataTasksReadyTaskInfo);
|
|
88660
|
+
init(_data?: any): void;
|
|
88661
|
+
static fromJS(data: any): BusinessDataTasksReadyTaskInfo;
|
|
88662
|
+
toJSON(data?: any): any;
|
|
88663
|
+
}
|
|
88664
|
+
export interface IBusinessDataTasksReadyTaskInfo extends IBaseResponseTaskInfo {
|
|
88665
|
+
/** array of results */
|
|
88666
|
+
result?: (BusinessDataTasksReadyResultInfo | undefined)[] | undefined;
|
|
88667
|
+
[key: string]: any;
|
|
88668
|
+
}
|
|
88669
|
+
export declare class BusinessDataTasksReadyResponseInfo extends BaseResponseInfo implements IBusinessDataTasksReadyResponseInfo {
|
|
88670
|
+
/** array of tasks */
|
|
88671
|
+
tasks?: (BusinessDataTasksReadyTaskInfo | undefined)[] | undefined;
|
|
88672
|
+
[key: string]: any;
|
|
88673
|
+
constructor(data?: IBusinessDataTasksReadyResponseInfo);
|
|
88674
|
+
init(_data?: any): void;
|
|
88675
|
+
static fromJS(data: any): BusinessDataTasksReadyResponseInfo;
|
|
88676
|
+
toJSON(data?: any): any;
|
|
88677
|
+
}
|
|
88678
|
+
export interface IBusinessDataTasksReadyResponseInfo extends IBaseResponseInfo {
|
|
88679
|
+
/** array of tasks */
|
|
88680
|
+
tasks?: (BusinessDataTasksReadyTaskInfo | undefined)[] | undefined;
|
|
88681
|
+
[key: string]: any;
|
|
88682
|
+
}
|
|
87572
88683
|
export declare class MapsSearchBusinessDataSerpElementItem extends BaseBusinessDataSerpElementItem implements IMapsSearchBusinessDataSerpElementItem {
|
|
87573
88684
|
/** position within a group of elements with identical type values
|
|
87574
88685
|
positions of elements with different type values are omitted from the rank_group */
|
|
@@ -91141,6 +92252,24 @@ export interface IBusinessDataGoogleReviewsTasksReadyResponseInfo extends IBaseR
|
|
|
91141
92252
|
tasks?: (BusinessDataGoogleReviewsTasksReadyTaskInfo | undefined)[] | undefined;
|
|
91142
92253
|
[key: string]: any;
|
|
91143
92254
|
}
|
|
92255
|
+
export declare class ReviewHighlights implements IReviewHighlights {
|
|
92256
|
+
/** reviewed feature */
|
|
92257
|
+
feature?: string | undefined;
|
|
92258
|
+
/** feature assessment */
|
|
92259
|
+
assessment?: string | undefined;
|
|
92260
|
+
[key: string]: any;
|
|
92261
|
+
constructor(data?: IReviewHighlights);
|
|
92262
|
+
init(_data?: any): void;
|
|
92263
|
+
static fromJS(data: any): ReviewHighlights;
|
|
92264
|
+
toJSON(data?: any): any;
|
|
92265
|
+
}
|
|
92266
|
+
export interface IReviewHighlights {
|
|
92267
|
+
/** reviewed feature */
|
|
92268
|
+
feature?: string | undefined;
|
|
92269
|
+
/** feature assessment */
|
|
92270
|
+
assessment?: string | undefined;
|
|
92271
|
+
[key: string]: any;
|
|
92272
|
+
}
|
|
91144
92273
|
export declare class GoogleReviewsSearchBusinessDataSerpElementItem extends BaseBusinessDataSerpElementItem implements IGoogleReviewsSearchBusinessDataSerpElementItem {
|
|
91145
92274
|
/** position within a group of elements with identical type values
|
|
91146
92275
|
positions of elements with different type values are omitted from rank_group */
|
|
@@ -91202,6 +92331,9 @@ ChZDSUhNMG9nS0VJQ0FnSUMxbHFyMFlnEAE */
|
|
|
91202
92331
|
review_id?: string | undefined;
|
|
91203
92332
|
/** images submitted by the reviewer */
|
|
91204
92333
|
images?: (ImagesElement | undefined)[] | undefined;
|
|
92334
|
+
/** review highlights
|
|
92335
|
+
contains highlighted review criteria and assessments */
|
|
92336
|
+
review_highlights?: (ReviewHighlights | undefined)[] | undefined;
|
|
91205
92337
|
[key: string]: any;
|
|
91206
92338
|
constructor(data?: IGoogleReviewsSearchBusinessDataSerpElementItem);
|
|
91207
92339
|
init(_data?: any): void;
|
|
@@ -91269,6 +92401,9 @@ ChZDSUhNMG9nS0VJQ0FnSUMxbHFyMFlnEAE */
|
|
|
91269
92401
|
review_id?: string | undefined;
|
|
91270
92402
|
/** images submitted by the reviewer */
|
|
91271
92403
|
images?: (ImagesElement | undefined)[] | undefined;
|
|
92404
|
+
/** review highlights
|
|
92405
|
+
contains highlighted review criteria and assessments */
|
|
92406
|
+
review_highlights?: (ReviewHighlights | undefined)[] | undefined;
|
|
91272
92407
|
[key: string]: any;
|
|
91273
92408
|
}
|
|
91274
92409
|
export declare class BusinessDataGoogleReviewsTaskGetResultInfo implements IBusinessDataGoogleReviewsTaskGetResultInfo {
|
|
@@ -93765,6 +94900,9 @@ example:
|
|
|
93765
94900
|
user_profile?: BusinessDataUserProfileInfo | undefined;
|
|
93766
94901
|
/** contains information about the owner’s response */
|
|
93767
94902
|
responses?: (ReviewResponseItemInfo | undefined)[] | undefined;
|
|
94903
|
+
/** review highlights
|
|
94904
|
+
contains highlighted review criteria and assessments */
|
|
94905
|
+
review_highlights?: (ReviewHighlights | undefined)[] | undefined;
|
|
93768
94906
|
[key: string]: any;
|
|
93769
94907
|
constructor(data?: ITripadvisorReviewSearchBusinessDataSerpElementItem);
|
|
93770
94908
|
init(_data?: any): void;
|
|
@@ -93805,6 +94943,9 @@ example:
|
|
|
93805
94943
|
user_profile?: BusinessDataUserProfileInfo | undefined;
|
|
93806
94944
|
/** contains information about the owner’s response */
|
|
93807
94945
|
responses?: (ReviewResponseItemInfo | undefined)[] | undefined;
|
|
94946
|
+
/** review highlights
|
|
94947
|
+
contains highlighted review criteria and assessments */
|
|
94948
|
+
review_highlights?: (ReviewHighlights | undefined)[] | undefined;
|
|
93808
94949
|
[key: string]: any;
|
|
93809
94950
|
}
|
|
93810
94951
|
export declare class BusinessDataTripadvisorReviewsTaskGetResultInfo implements IBusinessDataTripadvisorReviewsTaskGetResultInfo {
|
|
@@ -93833,6 +94974,11 @@ address of the local establishment for which the reviews are collected */
|
|
|
93833
94974
|
/** rating of the corresponding local establishment
|
|
93834
94975
|
popularity rate based on reviews and displayed in SERP */
|
|
93835
94976
|
rating?: RatingInfo | undefined;
|
|
94977
|
+
/** rating distribution by votes
|
|
94978
|
+
the distribution of votes across the rating in the range from 1 to 5 */
|
|
94979
|
+
rating_distribution?: {
|
|
94980
|
+
[key: string]: number;
|
|
94981
|
+
} | undefined;
|
|
93836
94982
|
/** the number of reviews items in the results array
|
|
93837
94983
|
you can get more results by using the depth parameter when setting a task */
|
|
93838
94984
|
items_count?: number | undefined;
|
|
@@ -93873,6 +95019,11 @@ address of the local establishment for which the reviews are collected */
|
|
|
93873
95019
|
/** rating of the corresponding local establishment
|
|
93874
95020
|
popularity rate based on reviews and displayed in SERP */
|
|
93875
95021
|
rating?: RatingInfo | undefined;
|
|
95022
|
+
/** rating distribution by votes
|
|
95023
|
+
the distribution of votes across the rating in the range from 1 to 5 */
|
|
95024
|
+
rating_distribution?: {
|
|
95025
|
+
[key: string]: number;
|
|
95026
|
+
} | undefined;
|
|
93876
95027
|
/** the number of reviews items in the results array
|
|
93877
95028
|
you can get more results by using the depth parameter when setting a task */
|
|
93878
95029
|
items_count?: number | undefined;
|
|
@@ -94309,22 +95460,6 @@ export interface IAppendixBingKeywordsDataLimitsRatesDataInfo {
|
|
|
94309
95460
|
keywords_for_keywords?: AppendixInfo | undefined;
|
|
94310
95461
|
[key: string]: any;
|
|
94311
95462
|
}
|
|
94312
|
-
export declare class AppendixKeywordPerformanceKeywordsDataLimitsRatesDataInfo implements IAppendixKeywordPerformanceKeywordsDataLimitsRatesDataInfo {
|
|
94313
|
-
task_get?: number | undefined;
|
|
94314
|
-
task_post?: number | undefined;
|
|
94315
|
-
locations_and_languages?: number | undefined;
|
|
94316
|
-
[key: string]: any;
|
|
94317
|
-
constructor(data?: IAppendixKeywordPerformanceKeywordsDataLimitsRatesDataInfo);
|
|
94318
|
-
init(_data?: any): void;
|
|
94319
|
-
static fromJS(data: any): AppendixKeywordPerformanceKeywordsDataLimitsRatesDataInfo;
|
|
94320
|
-
toJSON(data?: any): any;
|
|
94321
|
-
}
|
|
94322
|
-
export interface IAppendixKeywordPerformanceKeywordsDataLimitsRatesDataInfo {
|
|
94323
|
-
task_get?: number | undefined;
|
|
94324
|
-
task_post?: number | undefined;
|
|
94325
|
-
locations_and_languages?: number | undefined;
|
|
94326
|
-
[key: string]: any;
|
|
94327
|
-
}
|
|
94328
95463
|
export declare class AppendixGoogleAdsKeywordsDataLimitsRatesDataInfo implements IAppendixGoogleAdsKeywordsDataLimitsRatesDataInfo {
|
|
94329
95464
|
status?: number | undefined;
|
|
94330
95465
|
search_volume?: AppendixInfo | undefined;
|
|
@@ -94375,7 +95510,8 @@ export declare class AppendixKeywordsDataDaysRatesDataInfo implements IAppendixK
|
|
|
94375
95510
|
categories?: number | undefined;
|
|
94376
95511
|
errors?: number | undefined;
|
|
94377
95512
|
bing?: AppendixBingKeywordsDataLimitsRatesDataInfo | undefined;
|
|
94378
|
-
keyword_performance?:
|
|
95513
|
+
keyword_performance?: AppendixInfo | undefined;
|
|
95514
|
+
locations_and_languages?: number | undefined;
|
|
94379
95515
|
search_volume_history?: AppendixInfo | undefined;
|
|
94380
95516
|
google_ads?: AppendixGoogleAdsKeywordsDataLimitsRatesDataInfo | undefined;
|
|
94381
95517
|
dataforseo_trends?: AppendixDataforseoTrendsKeywordsDataLimitsRatesDataInfo | undefined;
|
|
@@ -94397,7 +95533,8 @@ export interface IAppendixKeywordsDataDaysRatesDataInfo {
|
|
|
94397
95533
|
categories?: number | undefined;
|
|
94398
95534
|
errors?: number | undefined;
|
|
94399
95535
|
bing?: AppendixBingKeywordsDataLimitsRatesDataInfo | undefined;
|
|
94400
|
-
keyword_performance?:
|
|
95536
|
+
keyword_performance?: AppendixInfo | undefined;
|
|
95537
|
+
locations_and_languages?: number | undefined;
|
|
94401
95538
|
search_volume_history?: AppendixInfo | undefined;
|
|
94402
95539
|
google_ads?: AppendixGoogleAdsKeywordsDataLimitsRatesDataInfo | undefined;
|
|
94403
95540
|
dataforseo_trends?: AppendixDataforseoTrendsKeywordsDataLimitsRatesDataInfo | undefined;
|
|
@@ -95021,7 +96158,8 @@ export declare class AppendixKeywordsDataDataInfo implements IAppendixKeywordsDa
|
|
|
95021
96158
|
categories?: number | undefined;
|
|
95022
96159
|
errors?: number | undefined;
|
|
95023
96160
|
bing?: AppendixBingKeywordsDataLimitsRatesDataInfo | undefined;
|
|
95024
|
-
keyword_performance?:
|
|
96161
|
+
keyword_performance?: AppendixInfo | undefined;
|
|
96162
|
+
locations_and_languages?: number | undefined;
|
|
95025
96163
|
search_volume_history?: AppendixInfo | undefined;
|
|
95026
96164
|
google_ads?: AppendixGoogleAdsKeywordsDataLimitsRatesDataInfo | undefined;
|
|
95027
96165
|
dataforseo_trends?: AppendixDataforseoTrendsKeywordsDataLimitsRatesDataInfo | undefined;
|
|
@@ -95046,7 +96184,8 @@ export interface IAppendixKeywordsDataDataInfo {
|
|
|
95046
96184
|
categories?: number | undefined;
|
|
95047
96185
|
errors?: number | undefined;
|
|
95048
96186
|
bing?: AppendixBingKeywordsDataLimitsRatesDataInfo | undefined;
|
|
95049
|
-
keyword_performance?:
|
|
96187
|
+
keyword_performance?: AppendixInfo | undefined;
|
|
96188
|
+
locations_and_languages?: number | undefined;
|
|
95050
96189
|
search_volume_history?: AppendixInfo | undefined;
|
|
95051
96190
|
google_ads?: AppendixGoogleAdsKeywordsDataLimitsRatesDataInfo | undefined;
|
|
95052
96191
|
dataforseo_trends?: AppendixDataforseoTrendsKeywordsDataLimitsRatesDataInfo | undefined;
|
|
@@ -95343,16 +96482,16 @@ export interface IAppendixTaskKeywordsDataPriceDataInfo {
|
|
|
95343
96482
|
priority_high?: (AppendixPriorityTasksReadyKeywordsDataPriceDataInfo | undefined)[] | undefined;
|
|
95344
96483
|
[key: string]: any;
|
|
95345
96484
|
}
|
|
95346
|
-
export declare class
|
|
96485
|
+
export declare class AppendixKeywordsDataPriceDataInfo implements IAppendixKeywordsDataPriceDataInfo {
|
|
95347
96486
|
task_get?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95348
96487
|
task_post?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95349
96488
|
[key: string]: any;
|
|
95350
|
-
constructor(data?:
|
|
96489
|
+
constructor(data?: IAppendixKeywordsDataPriceDataInfo);
|
|
95351
96490
|
init(_data?: any): void;
|
|
95352
|
-
static fromJS(data: any):
|
|
96491
|
+
static fromJS(data: any): AppendixKeywordsDataPriceDataInfo;
|
|
95353
96492
|
toJSON(data?: any): any;
|
|
95354
96493
|
}
|
|
95355
|
-
export interface
|
|
96494
|
+
export interface IAppendixKeywordsDataPriceDataInfo {
|
|
95356
96495
|
task_get?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95357
96496
|
task_post?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95358
96497
|
[key: string]: any;
|
|
@@ -95409,22 +96548,6 @@ export interface IAppendixGoogleAdsKeywordsDataPriceData {
|
|
|
95409
96548
|
status?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95410
96549
|
[key: string]: any;
|
|
95411
96550
|
}
|
|
95412
|
-
export declare class AppendixKeywordPerformanceKeywordsDataPriceData implements IAppendixKeywordPerformanceKeywordsDataPriceData {
|
|
95413
|
-
locations_and_languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95414
|
-
task_get?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95415
|
-
task_post?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95416
|
-
[key: string]: any;
|
|
95417
|
-
constructor(data?: IAppendixKeywordPerformanceKeywordsDataPriceData);
|
|
95418
|
-
init(_data?: any): void;
|
|
95419
|
-
static fromJS(data: any): AppendixKeywordPerformanceKeywordsDataPriceData;
|
|
95420
|
-
toJSON(data?: any): any;
|
|
95421
|
-
}
|
|
95422
|
-
export interface IAppendixKeywordPerformanceKeywordsDataPriceData {
|
|
95423
|
-
locations_and_languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95424
|
-
task_get?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95425
|
-
task_post?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95426
|
-
[key: string]: any;
|
|
95427
|
-
}
|
|
95428
96551
|
export declare class AppendixDataforseoTrendsKeywordsDataPriceData implements IAppendixDataforseoTrendsKeywordsDataPriceData {
|
|
95429
96552
|
demography?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95430
96553
|
explore?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
@@ -95461,18 +96584,19 @@ export interface IAppendixExploreKeywordsDataPriceData {
|
|
|
95461
96584
|
}
|
|
95462
96585
|
export declare class AppendixKeywordsDataPriceData implements IAppendixKeywordsDataPriceData {
|
|
95463
96586
|
tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95464
|
-
ad_traffic_by_keywords?:
|
|
96587
|
+
ad_traffic_by_keywords?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
95465
96588
|
bing?: AppendixBingKeywordsDataPriceData | undefined;
|
|
95466
96589
|
categories?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95467
96590
|
errors?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95468
96591
|
google_ads?: AppendixGoogleAdsKeywordsDataPriceData | undefined;
|
|
95469
|
-
keyword_performance?:
|
|
95470
|
-
keywords_for_keywords?:
|
|
95471
|
-
keywords_for_site?:
|
|
96592
|
+
keyword_performance?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
96593
|
+
keywords_for_keywords?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
96594
|
+
keywords_for_site?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
95472
96595
|
languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95473
96596
|
locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95474
|
-
|
|
95475
|
-
|
|
96597
|
+
locations_and_languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
96598
|
+
search_volume_history?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
96599
|
+
search_volume?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
95476
96600
|
dataforseo_trends?: AppendixDataforseoTrendsKeywordsDataPriceData | undefined;
|
|
95477
96601
|
explore?: AppendixExploreKeywordsDataPriceData | undefined;
|
|
95478
96602
|
[key: string]: any;
|
|
@@ -95483,18 +96607,19 @@ export declare class AppendixKeywordsDataPriceData implements IAppendixKeywordsD
|
|
|
95483
96607
|
}
|
|
95484
96608
|
export interface IAppendixKeywordsDataPriceData {
|
|
95485
96609
|
tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95486
|
-
ad_traffic_by_keywords?:
|
|
96610
|
+
ad_traffic_by_keywords?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
95487
96611
|
bing?: AppendixBingKeywordsDataPriceData | undefined;
|
|
95488
96612
|
categories?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95489
96613
|
errors?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95490
96614
|
google_ads?: AppendixGoogleAdsKeywordsDataPriceData | undefined;
|
|
95491
|
-
keyword_performance?:
|
|
95492
|
-
keywords_for_keywords?:
|
|
95493
|
-
keywords_for_site?:
|
|
96615
|
+
keyword_performance?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
96616
|
+
keywords_for_keywords?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
96617
|
+
keywords_for_site?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
95494
96618
|
languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95495
96619
|
locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95496
|
-
|
|
95497
|
-
|
|
96620
|
+
locations_and_languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
96621
|
+
search_volume_history?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
96622
|
+
search_volume?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
95498
96623
|
dataforseo_trends?: AppendixDataforseoTrendsKeywordsDataPriceData | undefined;
|
|
95499
96624
|
explore?: AppendixExploreKeywordsDataPriceData | undefined;
|
|
95500
96625
|
[key: string]: any;
|
|
@@ -95634,9 +96759,9 @@ export interface IAppendixMerchantPriceData {
|
|
|
95634
96759
|
[key: string]: any;
|
|
95635
96760
|
}
|
|
95636
96761
|
export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceDataInfo {
|
|
95637
|
-
advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95638
96762
|
regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95639
96763
|
html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
96764
|
+
advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95640
96765
|
[key: string]: any;
|
|
95641
96766
|
constructor(data?: IAppendixSerpPriceDataInfo);
|
|
95642
96767
|
init(_data?: any): void;
|
|
@@ -95644,15 +96769,15 @@ export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceData
|
|
|
95644
96769
|
toJSON(data?: any): any;
|
|
95645
96770
|
}
|
|
95646
96771
|
export interface IAppendixSerpPriceDataInfo {
|
|
95647
|
-
advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95648
96772
|
regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95649
96773
|
html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
96774
|
+
advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95650
96775
|
[key: string]: any;
|
|
95651
96776
|
}
|
|
95652
96777
|
export declare class AppendixSerpPriceData implements IAppendixSerpPriceData {
|
|
95653
96778
|
tasks_fixed?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95654
96779
|
errors?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95655
|
-
jobs?:
|
|
96780
|
+
jobs?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
95656
96781
|
languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95657
96782
|
live?: AppendixSerpPriceDataInfo | undefined;
|
|
95658
96783
|
locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
@@ -95669,7 +96794,7 @@ export declare class AppendixSerpPriceData implements IAppendixSerpPriceData {
|
|
|
95669
96794
|
export interface IAppendixSerpPriceData {
|
|
95670
96795
|
tasks_fixed?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95671
96796
|
errors?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95672
|
-
jobs?:
|
|
96797
|
+
jobs?: AppendixKeywordsDataPriceDataInfo | undefined;
|
|
95673
96798
|
languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95674
96799
|
live?: AppendixSerpPriceDataInfo | undefined;
|
|
95675
96800
|
locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|