dataforseo-client 1.0.19 → 1.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/main.d.ts +1363 -292
- package/main.js +2139 -667
- package/main.js.map +1 -1
- package/main.ts +3511 -989
- package/package.json +1 -1
package/main.d.ts
CHANGED
|
@@ -1096,12 +1096,23 @@ export declare class DataforseoLabsApi {
|
|
|
1096
1096
|
*/
|
|
1097
1097
|
googleSearchIntentLive(body: (DataforseoLabsGoogleSearchIntentLiveRequestInfo | undefined)[] | undefined): Promise<DataforseoLabsGoogleSearchIntentLiveResponseInfo | null>;
|
|
1098
1098
|
protected processGoogleSearchIntentLive(response: Response): Promise<DataforseoLabsGoogleSearchIntentLiveResponseInfo | null>;
|
|
1099
|
+
/**
|
|
1100
|
+
* @return Successful operation
|
|
1101
|
+
*/
|
|
1102
|
+
dataforseoLabsGoogleCategoriesForKeywordsLanguages(): Promise<DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo | null>;
|
|
1103
|
+
protected processDataforseoLabsGoogleCategoriesForKeywordsLanguages(response: Response): Promise<DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo | null>;
|
|
1099
1104
|
/**
|
|
1100
1105
|
* @param body (optional)
|
|
1101
1106
|
* @return Successful operation
|
|
1102
1107
|
*/
|
|
1103
1108
|
googleCategoriesForDomainLive(body: (DataforseoLabsGoogleCategoriesForDomainLiveRequestInfo | undefined)[] | undefined): Promise<DataforseoLabsGoogleCategoriesForDomainLiveResponseInfo | null>;
|
|
1104
1109
|
protected processGoogleCategoriesForDomainLive(response: Response): Promise<DataforseoLabsGoogleCategoriesForDomainLiveResponseInfo | null>;
|
|
1110
|
+
/**
|
|
1111
|
+
* @param body (optional)
|
|
1112
|
+
* @return Successful operation
|
|
1113
|
+
*/
|
|
1114
|
+
googleCategoriesForKeywordsLive(body: (DataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo | undefined)[] | undefined): Promise<DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo | null>;
|
|
1115
|
+
protected processGoogleCategoriesForKeywordsLive(response: Response): Promise<DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo | null>;
|
|
1105
1116
|
/**
|
|
1106
1117
|
* @param body (optional)
|
|
1107
1118
|
* @return Successful operation
|
|
@@ -1693,6 +1704,36 @@ export declare class KeywordsDataApi {
|
|
|
1693
1704
|
*/
|
|
1694
1705
|
bingKeywordPerformanceLive(body: (KeywordsDataBingKeywordPerformanceLiveRequestInfo | undefined)[] | undefined): Promise<KeywordsDataBingKeywordPerformanceLiveResponseInfo | null>;
|
|
1695
1706
|
protected processBingKeywordPerformanceLive(response: Response): Promise<KeywordsDataBingKeywordPerformanceLiveResponseInfo | null>;
|
|
1707
|
+
/**
|
|
1708
|
+
* @return Successful operation
|
|
1709
|
+
*/
|
|
1710
|
+
keywordsDataBingSearchVolumeHistoryLocationsAndLanguages(): Promise<KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo | null>;
|
|
1711
|
+
protected processKeywordsDataBingSearchVolumeHistoryLocationsAndLanguages(response: Response): Promise<KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo | null>;
|
|
1712
|
+
/**
|
|
1713
|
+
* @param body (optional)
|
|
1714
|
+
* @return Successful operation
|
|
1715
|
+
*/
|
|
1716
|
+
bingSearchVolumeHistoryTaskPost(body: (KeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo | undefined)[] | undefined): Promise<KeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo | null>;
|
|
1717
|
+
protected processBingSearchVolumeHistoryTaskPost(response: Response): Promise<KeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo | null>;
|
|
1718
|
+
/**
|
|
1719
|
+
* @return Successful operation
|
|
1720
|
+
*/
|
|
1721
|
+
bingSearchVolumeHistoryTasksReady(): Promise<KeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo | null>;
|
|
1722
|
+
protected processBingSearchVolumeHistoryTasksReady(response: Response): Promise<KeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo | null>;
|
|
1723
|
+
/**
|
|
1724
|
+
* @param id task identifier
|
|
1725
|
+
unique task identifier in our system in the UUID format
|
|
1726
|
+
you will be able to use it within 30 days to request the results of the task at any time
|
|
1727
|
+
* @return Successful operation
|
|
1728
|
+
*/
|
|
1729
|
+
bingSearchVolumeHistoryTaskGet(id: string): Promise<KeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo | null>;
|
|
1730
|
+
protected processBingSearchVolumeHistoryTaskGet(response: Response): Promise<KeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo | null>;
|
|
1731
|
+
/**
|
|
1732
|
+
* @param body (optional)
|
|
1733
|
+
* @return Successful operation
|
|
1734
|
+
*/
|
|
1735
|
+
bingSearchVolumeHistoryLive(body: (KeywordsDataBingSearchVolumeHistoryLiveRequestInfo | undefined)[] | undefined): Promise<KeywordsDataBingSearchVolumeHistoryLiveResponseInfo | null>;
|
|
1736
|
+
protected processBingSearchVolumeHistoryLive(response: Response): Promise<KeywordsDataBingSearchVolumeHistoryLiveResponseInfo | null>;
|
|
1696
1737
|
}
|
|
1697
1738
|
export declare class BacklinksApi {
|
|
1698
1739
|
private http;
|
|
@@ -3657,6 +3698,34 @@ raw price string as provided in the result */
|
|
|
3657
3698
|
displayed_price?: string | undefined;
|
|
3658
3699
|
[key: string]: any;
|
|
3659
3700
|
}
|
|
3701
|
+
export declare class RatingInfo implements IRatingInfo {
|
|
3702
|
+
/** the type of rating
|
|
3703
|
+
here you can find the following elements: Max5, Percents, CustomMax */
|
|
3704
|
+
rating_type?: string | undefined;
|
|
3705
|
+
/** the value of the rating */
|
|
3706
|
+
value?: number | undefined;
|
|
3707
|
+
/** the amount of feedback */
|
|
3708
|
+
votes_count?: number | undefined;
|
|
3709
|
+
/** the maximum value for a rating_type */
|
|
3710
|
+
rating_max?: number | undefined;
|
|
3711
|
+
[key: string]: any;
|
|
3712
|
+
constructor(data?: IRatingInfo);
|
|
3713
|
+
init(_data?: any): void;
|
|
3714
|
+
static fromJS(data: any): RatingInfo;
|
|
3715
|
+
toJSON(data?: any): any;
|
|
3716
|
+
}
|
|
3717
|
+
export interface IRatingInfo {
|
|
3718
|
+
/** the type of rating
|
|
3719
|
+
here you can find the following elements: Max5, Percents, CustomMax */
|
|
3720
|
+
rating_type?: string | undefined;
|
|
3721
|
+
/** the value of the rating */
|
|
3722
|
+
value?: number | undefined;
|
|
3723
|
+
/** the amount of feedback */
|
|
3724
|
+
votes_count?: number | undefined;
|
|
3725
|
+
/** the maximum value for a rating_type */
|
|
3726
|
+
rating_max?: number | undefined;
|
|
3727
|
+
[key: string]: any;
|
|
3728
|
+
}
|
|
3660
3729
|
export declare class SocialMetricsInfo implements ISocialMetricsInfo {
|
|
3661
3730
|
/** type of element */
|
|
3662
3731
|
type?: string | undefined;
|
|
@@ -6522,34 +6591,6 @@ export interface IAdLinkElement {
|
|
|
6522
6591
|
ad_aclk?: string | undefined;
|
|
6523
6592
|
[key: string]: any;
|
|
6524
6593
|
}
|
|
6525
|
-
export declare class RatingInfo implements IRatingInfo {
|
|
6526
|
-
/** the type of rating
|
|
6527
|
-
here you can find the following elements: Max5, Percents, CustomMax */
|
|
6528
|
-
rating_type?: string | undefined;
|
|
6529
|
-
/** the value of the rating */
|
|
6530
|
-
value?: number | undefined;
|
|
6531
|
-
/** the amount of feedback */
|
|
6532
|
-
votes_count?: number | undefined;
|
|
6533
|
-
/** the maximum value for a rating_type */
|
|
6534
|
-
rating_max?: number | undefined;
|
|
6535
|
-
[key: string]: any;
|
|
6536
|
-
constructor(data?: IRatingInfo);
|
|
6537
|
-
init(_data?: any): void;
|
|
6538
|
-
static fromJS(data: any): RatingInfo;
|
|
6539
|
-
toJSON(data?: any): any;
|
|
6540
|
-
}
|
|
6541
|
-
export interface IRatingInfo {
|
|
6542
|
-
/** the type of rating
|
|
6543
|
-
here you can find the following elements: Max5, Percents, CustomMax */
|
|
6544
|
-
rating_type?: string | undefined;
|
|
6545
|
-
/** the value of the rating */
|
|
6546
|
-
value?: number | undefined;
|
|
6547
|
-
/** the amount of feedback */
|
|
6548
|
-
votes_count?: number | undefined;
|
|
6549
|
-
/** the maximum value for a rating_type */
|
|
6550
|
-
rating_max?: number | undefined;
|
|
6551
|
-
[key: string]: any;
|
|
6552
|
-
}
|
|
6553
6594
|
export declare class FaqBoxElement implements IFaqBoxElement {
|
|
6554
6595
|
/** type of element */
|
|
6555
6596
|
type?: string | undefined;
|
|
@@ -33121,7 +33162,7 @@ if false, the results are returned for Google search sites only */
|
|
|
33121
33162
|
keyword_info?: KeywordInfo | undefined;
|
|
33122
33163
|
/** clickstream data for the returned keyword
|
|
33123
33164
|
to retrieve results for this field, the parameter include_clickstream_data must be set to true */
|
|
33124
|
-
clickstream_keyword_info?:
|
|
33165
|
+
clickstream_keyword_info?: any | undefined;
|
|
33125
33166
|
/** additional information about the keyword */
|
|
33126
33167
|
keyword_properties?: KeywordProperties | undefined;
|
|
33127
33168
|
/** impressions data for the returned keyword idea
|
|
@@ -33133,6 +33174,9 @@ learn more about impressions in this help center article */
|
|
|
33133
33174
|
/** SERP data
|
|
33134
33175
|
the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
|
|
33135
33176
|
serp_info?: SerpInfo | undefined;
|
|
33177
|
+
/** backlink data for the returned keyword
|
|
33178
|
+
this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
|
|
33179
|
+
avg_backlinks_info?: AvgBacklinksInfo | undefined;
|
|
33136
33180
|
[key: string]: any;
|
|
33137
33181
|
constructor(data?: IDataforseoLabsGoogleHistoricalSearchVolumeLiveItem);
|
|
33138
33182
|
init(_data?: any): void;
|
|
@@ -33158,7 +33202,7 @@ if false, the results are returned for Google search sites only */
|
|
|
33158
33202
|
keyword_info?: KeywordInfo | undefined;
|
|
33159
33203
|
/** clickstream data for the returned keyword
|
|
33160
33204
|
to retrieve results for this field, the parameter include_clickstream_data must be set to true */
|
|
33161
|
-
clickstream_keyword_info?:
|
|
33205
|
+
clickstream_keyword_info?: any | undefined;
|
|
33162
33206
|
/** additional information about the keyword */
|
|
33163
33207
|
keyword_properties?: KeywordProperties | undefined;
|
|
33164
33208
|
/** impressions data for the returned keyword idea
|
|
@@ -33170,6 +33214,9 @@ learn more about impressions in this help center article */
|
|
|
33170
33214
|
/** SERP data
|
|
33171
33215
|
the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
|
|
33172
33216
|
serp_info?: SerpInfo | undefined;
|
|
33217
|
+
/** backlink data for the returned keyword
|
|
33218
|
+
this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
|
|
33219
|
+
avg_backlinks_info?: AvgBacklinksInfo | undefined;
|
|
33173
33220
|
[key: string]: any;
|
|
33174
33221
|
}
|
|
33175
33222
|
export declare class DataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo implements IDataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo {
|
|
@@ -33624,6 +33671,52 @@ export interface IDataforseoLabsGoogleSearchIntentLiveResponseInfo extends IBase
|
|
|
33624
33671
|
tasks?: (DataforseoLabsGoogleSearchIntentLiveTaskInfo | undefined)[] | undefined;
|
|
33625
33672
|
[key: string]: any;
|
|
33626
33673
|
}
|
|
33674
|
+
export declare class DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo {
|
|
33675
|
+
/** language name */
|
|
33676
|
+
language_name?: string | undefined;
|
|
33677
|
+
/** language code according to ISO 639-1 */
|
|
33678
|
+
language_code?: string | undefined;
|
|
33679
|
+
[key: string]: any;
|
|
33680
|
+
constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo);
|
|
33681
|
+
init(_data?: any): void;
|
|
33682
|
+
static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo;
|
|
33683
|
+
toJSON(data?: any): any;
|
|
33684
|
+
}
|
|
33685
|
+
export interface IDataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo {
|
|
33686
|
+
/** language name */
|
|
33687
|
+
language_name?: string | undefined;
|
|
33688
|
+
/** language code according to ISO 639-1 */
|
|
33689
|
+
language_code?: string | undefined;
|
|
33690
|
+
[key: string]: any;
|
|
33691
|
+
}
|
|
33692
|
+
export declare class DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo {
|
|
33693
|
+
/** array of results */
|
|
33694
|
+
result?: (DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo | undefined)[] | undefined;
|
|
33695
|
+
[key: string]: any;
|
|
33696
|
+
constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo);
|
|
33697
|
+
init(_data?: any): void;
|
|
33698
|
+
static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo;
|
|
33699
|
+
toJSON(data?: any): any;
|
|
33700
|
+
}
|
|
33701
|
+
export interface IDataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo extends IBaseResponseTaskInfo {
|
|
33702
|
+
/** array of results */
|
|
33703
|
+
result?: (DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo | undefined)[] | undefined;
|
|
33704
|
+
[key: string]: any;
|
|
33705
|
+
}
|
|
33706
|
+
export declare class DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo extends BaseResponseInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo {
|
|
33707
|
+
/** array of tasks */
|
|
33708
|
+
tasks?: (DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo | undefined)[] | undefined;
|
|
33709
|
+
[key: string]: any;
|
|
33710
|
+
constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo);
|
|
33711
|
+
init(_data?: any): void;
|
|
33712
|
+
static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo;
|
|
33713
|
+
toJSON(data?: any): any;
|
|
33714
|
+
}
|
|
33715
|
+
export interface IDataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo extends IBaseResponseInfo {
|
|
33716
|
+
/** array of tasks */
|
|
33717
|
+
tasks?: (DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo | undefined)[] | undefined;
|
|
33718
|
+
[key: string]: any;
|
|
33719
|
+
}
|
|
33627
33720
|
export declare class DataforseoLabsGoogleCategoriesForDomainLiveRequestInfo implements IDataforseoLabsGoogleCategoriesForDomainLiveRequestInfo {
|
|
33628
33721
|
/** domain or subdomain
|
|
33629
33722
|
required field
|
|
@@ -34096,6 +34189,142 @@ export interface IDataforseoLabsGoogleCategoriesForDomainLiveResponseInfo extend
|
|
|
34096
34189
|
tasks?: (DataforseoLabsGoogleCategoriesForDomainLiveTaskInfo | undefined)[] | undefined;
|
|
34097
34190
|
[key: string]: any;
|
|
34098
34191
|
}
|
|
34192
|
+
export declare class DataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo {
|
|
34193
|
+
/** target keywords
|
|
34194
|
+
required field
|
|
34195
|
+
UTF-8 encoding
|
|
34196
|
+
maximum number of keywords you can specify in this array: 1000
|
|
34197
|
+
each keyword should be at least 3 characters long;
|
|
34198
|
+
the keywords will be converted to lowercase format */
|
|
34199
|
+
keywords?: string[];
|
|
34200
|
+
/** full name of the language
|
|
34201
|
+
required field if don’t specify language_code
|
|
34202
|
+
you can receive the list of available languages with their language_name by making a separate request to the
|
|
34203
|
+
https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages
|
|
34204
|
+
example:
|
|
34205
|
+
English */
|
|
34206
|
+
language_name?: string | undefined;
|
|
34207
|
+
/** language code
|
|
34208
|
+
required field if don’t specify language_name
|
|
34209
|
+
you can receive the list of available languages with their language_code by making a separate request to the
|
|
34210
|
+
https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages
|
|
34211
|
+
example:
|
|
34212
|
+
en */
|
|
34213
|
+
language_code?: string | undefined;
|
|
34214
|
+
/** user-defined task identifier
|
|
34215
|
+
optional field
|
|
34216
|
+
the character limit is 255
|
|
34217
|
+
you can use this parameter to identify the task and match it with the result
|
|
34218
|
+
you will find the specified tag value in the data object of the response */
|
|
34219
|
+
tag?: string | undefined;
|
|
34220
|
+
[key: string]: any;
|
|
34221
|
+
constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo);
|
|
34222
|
+
init(_data?: any): void;
|
|
34223
|
+
static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo;
|
|
34224
|
+
toJSON(data?: any): any;
|
|
34225
|
+
}
|
|
34226
|
+
export interface IDataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo {
|
|
34227
|
+
/** target keywords
|
|
34228
|
+
required field
|
|
34229
|
+
UTF-8 encoding
|
|
34230
|
+
maximum number of keywords you can specify in this array: 1000
|
|
34231
|
+
each keyword should be at least 3 characters long;
|
|
34232
|
+
the keywords will be converted to lowercase format */
|
|
34233
|
+
keywords?: string[];
|
|
34234
|
+
/** full name of the language
|
|
34235
|
+
required field if don’t specify language_code
|
|
34236
|
+
you can receive the list of available languages with their language_name by making a separate request to the
|
|
34237
|
+
https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages
|
|
34238
|
+
example:
|
|
34239
|
+
English */
|
|
34240
|
+
language_name?: string | undefined;
|
|
34241
|
+
/** language code
|
|
34242
|
+
required field if don’t specify language_name
|
|
34243
|
+
you can receive the list of available languages with their language_code by making a separate request to the
|
|
34244
|
+
https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages
|
|
34245
|
+
example:
|
|
34246
|
+
en */
|
|
34247
|
+
language_code?: string | undefined;
|
|
34248
|
+
/** user-defined task identifier
|
|
34249
|
+
optional field
|
|
34250
|
+
the character limit is 255
|
|
34251
|
+
you can use this parameter to identify the task and match it with the result
|
|
34252
|
+
you will find the specified tag value in the data object of the response */
|
|
34253
|
+
tag?: string | undefined;
|
|
34254
|
+
[key: string]: any;
|
|
34255
|
+
}
|
|
34256
|
+
export declare class DataforseoLabsGoogleCategoriesForKeywordsLiveItem implements IDataforseoLabsGoogleCategoriesForKeywordsLiveItem {
|
|
34257
|
+
/** keyword in a POST array */
|
|
34258
|
+
keyword?: string | undefined;
|
|
34259
|
+
/** product and service categories
|
|
34260
|
+
you can download the full list of possible categories */
|
|
34261
|
+
categories?: number[] | undefined;
|
|
34262
|
+
[key: string]: any;
|
|
34263
|
+
constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLiveItem);
|
|
34264
|
+
init(_data?: any): void;
|
|
34265
|
+
static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLiveItem;
|
|
34266
|
+
toJSON(data?: any): any;
|
|
34267
|
+
}
|
|
34268
|
+
export interface IDataforseoLabsGoogleCategoriesForKeywordsLiveItem {
|
|
34269
|
+
/** keyword in a POST array */
|
|
34270
|
+
keyword?: string | undefined;
|
|
34271
|
+
/** product and service categories
|
|
34272
|
+
you can download the full list of possible categories */
|
|
34273
|
+
categories?: number[] | undefined;
|
|
34274
|
+
[key: string]: any;
|
|
34275
|
+
}
|
|
34276
|
+
export declare class DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo {
|
|
34277
|
+
/** language code in a POST array
|
|
34278
|
+
if there is no data, then the value is null */
|
|
34279
|
+
language_code?: string | undefined;
|
|
34280
|
+
/** the number of results returned in the items array */
|
|
34281
|
+
items_count?: number | undefined;
|
|
34282
|
+
/** contains keywords and related keyword difficulty scores */
|
|
34283
|
+
items?: (DataforseoLabsGoogleCategoriesForKeywordsLiveItem | undefined)[] | undefined;
|
|
34284
|
+
[key: string]: any;
|
|
34285
|
+
constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo);
|
|
34286
|
+
init(_data?: any): void;
|
|
34287
|
+
static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo;
|
|
34288
|
+
toJSON(data?: any): any;
|
|
34289
|
+
}
|
|
34290
|
+
export interface IDataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo {
|
|
34291
|
+
/** language code in a POST array
|
|
34292
|
+
if there is no data, then the value is null */
|
|
34293
|
+
language_code?: string | undefined;
|
|
34294
|
+
/** the number of results returned in the items array */
|
|
34295
|
+
items_count?: number | undefined;
|
|
34296
|
+
/** contains keywords and related keyword difficulty scores */
|
|
34297
|
+
items?: (DataforseoLabsGoogleCategoriesForKeywordsLiveItem | undefined)[] | undefined;
|
|
34298
|
+
[key: string]: any;
|
|
34299
|
+
}
|
|
34300
|
+
export declare class DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo {
|
|
34301
|
+
/** array of results */
|
|
34302
|
+
result?: (DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo | undefined)[] | undefined;
|
|
34303
|
+
[key: string]: any;
|
|
34304
|
+
constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo);
|
|
34305
|
+
init(_data?: any): void;
|
|
34306
|
+
static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo;
|
|
34307
|
+
toJSON(data?: any): any;
|
|
34308
|
+
}
|
|
34309
|
+
export interface IDataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo extends IBaseResponseTaskInfo {
|
|
34310
|
+
/** array of results */
|
|
34311
|
+
result?: (DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo | undefined)[] | undefined;
|
|
34312
|
+
[key: string]: any;
|
|
34313
|
+
}
|
|
34314
|
+
export declare class DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo extends BaseResponseInfo implements IDataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo {
|
|
34315
|
+
/** array of tasks */
|
|
34316
|
+
tasks?: (DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo | undefined)[] | undefined;
|
|
34317
|
+
[key: string]: any;
|
|
34318
|
+
constructor(data?: IDataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo);
|
|
34319
|
+
init(_data?: any): void;
|
|
34320
|
+
static fromJS(data: any): DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo;
|
|
34321
|
+
toJSON(data?: any): any;
|
|
34322
|
+
}
|
|
34323
|
+
export interface IDataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo extends IBaseResponseInfo {
|
|
34324
|
+
/** array of tasks */
|
|
34325
|
+
tasks?: (DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo | undefined)[] | undefined;
|
|
34326
|
+
[key: string]: any;
|
|
34327
|
+
}
|
|
34099
34328
|
export declare class DataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo implements IDataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo {
|
|
34100
34329
|
/** product and service categories
|
|
34101
34330
|
required field
|
|
@@ -34160,7 +34389,7 @@ default value: false */
|
|
|
34160
34389
|
ignore_synonyms?: boolean | undefined;
|
|
34161
34390
|
/** the maximum number of keywords in the results array
|
|
34162
34391
|
optional field
|
|
34163
|
-
default value:
|
|
34392
|
+
default value: 100
|
|
34164
34393
|
maximum value: 1000 */
|
|
34165
34394
|
limit?: number | undefined;
|
|
34166
34395
|
/** offset in the results array of returned keywords
|
|
@@ -34287,7 +34516,7 @@ default value: false */
|
|
|
34287
34516
|
ignore_synonyms?: boolean | undefined;
|
|
34288
34517
|
/** the maximum number of keywords in the results array
|
|
34289
34518
|
optional field
|
|
34290
|
-
default value:
|
|
34519
|
+
default value: 100
|
|
34291
34520
|
maximum value: 1000 */
|
|
34292
34521
|
limit?: number | undefined;
|
|
34293
34522
|
/** offset in the results array of returned keywords
|
|
@@ -37305,10 +37534,10 @@ export declare class DataforseoLabsGoogleDomainIntersectionLiveItem implements I
|
|
|
37305
37534
|
se_type?: string | undefined;
|
|
37306
37535
|
/** keyword data for the returned keyword */
|
|
37307
37536
|
keyword_data?: KeywordDataInfo | undefined;
|
|
37308
|
-
/** contains data on the first domain
|
|
37537
|
+
/** contains data on the first domain’s SERP element found for the returned keyword
|
|
37309
37538
|
the list of supported SERP elements can be found below */
|
|
37310
37539
|
first_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
|
|
37311
|
-
/** contains data on the second domain
|
|
37540
|
+
/** contains data on the second domain’s SERP element found for the returned keyword
|
|
37312
37541
|
the list of supported SERP elements can be found below */
|
|
37313
37542
|
second_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
|
|
37314
37543
|
[key: string]: any;
|
|
@@ -37322,10 +37551,10 @@ export interface IDataforseoLabsGoogleDomainIntersectionLiveItem {
|
|
|
37322
37551
|
se_type?: string | undefined;
|
|
37323
37552
|
/** keyword data for the returned keyword */
|
|
37324
37553
|
keyword_data?: KeywordDataInfo | undefined;
|
|
37325
|
-
/** contains data on the first domain
|
|
37554
|
+
/** contains data on the first domain’s SERP element found for the returned keyword
|
|
37326
37555
|
the list of supported SERP elements can be found below */
|
|
37327
37556
|
first_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
|
|
37328
|
-
/** contains data on the second domain
|
|
37557
|
+
/** contains data on the second domain’s SERP element found for the returned keyword
|
|
37329
37558
|
the list of supported SERP elements can be found below */
|
|
37330
37559
|
second_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
|
|
37331
37560
|
[key: string]: any;
|
|
@@ -53672,74 +53901,6 @@ the data included in the google_trends_graph element is based on the keywords li
|
|
|
53672
53901
|
averages?: (number | undefined)[];
|
|
53673
53902
|
[key: string]: any;
|
|
53674
53903
|
}
|
|
53675
|
-
export declare class KeywordsDataGoogleTrendsExploreTaskGetResultInfo implements IKeywordsDataGoogleTrendsExploreTaskGetResultInfo {
|
|
53676
|
-
/** keywords in a POST array */
|
|
53677
|
-
keywords?: (string | undefined)[] | undefined;
|
|
53678
|
-
/** type of element */
|
|
53679
|
-
type?: string | undefined;
|
|
53680
|
-
/** location code in a POST array
|
|
53681
|
-
if there is no data, then the value is null */
|
|
53682
|
-
location_code?: number | undefined;
|
|
53683
|
-
/** language code in a POST array
|
|
53684
|
-
if there is no data, then the value is null */
|
|
53685
|
-
language_code?: string | undefined;
|
|
53686
|
-
/** direct URL to the Google Trends results
|
|
53687
|
-
you can use it to make sure that we provided accurate results */
|
|
53688
|
-
check_url?: string | undefined;
|
|
53689
|
-
/** date and time when the result was received
|
|
53690
|
-
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
|
|
53691
|
-
example:
|
|
53692
|
-
2019-11-15 12:57:46 +00:00 */
|
|
53693
|
-
datetime?: string | undefined;
|
|
53694
|
-
/** the number of results returned in the items array */
|
|
53695
|
-
items_count?: number | undefined;
|
|
53696
|
-
/** items on the Google Trends page */
|
|
53697
|
-
items?: (BaseGoogleTrendsItem | undefined)[] | undefined;
|
|
53698
|
-
[key: string]: any;
|
|
53699
|
-
constructor(data?: IKeywordsDataGoogleTrendsExploreTaskGetResultInfo);
|
|
53700
|
-
init(_data?: any): void;
|
|
53701
|
-
static fromJS(data: any): KeywordsDataGoogleTrendsExploreTaskGetResultInfo;
|
|
53702
|
-
toJSON(data?: any): any;
|
|
53703
|
-
}
|
|
53704
|
-
export interface IKeywordsDataGoogleTrendsExploreTaskGetResultInfo {
|
|
53705
|
-
/** keywords in a POST array */
|
|
53706
|
-
keywords?: (string | undefined)[] | undefined;
|
|
53707
|
-
/** type of element */
|
|
53708
|
-
type?: string | undefined;
|
|
53709
|
-
/** location code in a POST array
|
|
53710
|
-
if there is no data, then the value is null */
|
|
53711
|
-
location_code?: number | undefined;
|
|
53712
|
-
/** language code in a POST array
|
|
53713
|
-
if there is no data, then the value is null */
|
|
53714
|
-
language_code?: string | undefined;
|
|
53715
|
-
/** direct URL to the Google Trends results
|
|
53716
|
-
you can use it to make sure that we provided accurate results */
|
|
53717
|
-
check_url?: string | undefined;
|
|
53718
|
-
/** date and time when the result was received
|
|
53719
|
-
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
|
|
53720
|
-
example:
|
|
53721
|
-
2019-11-15 12:57:46 +00:00 */
|
|
53722
|
-
datetime?: string | undefined;
|
|
53723
|
-
/** the number of results returned in the items array */
|
|
53724
|
-
items_count?: number | undefined;
|
|
53725
|
-
/** items on the Google Trends page */
|
|
53726
|
-
items?: (BaseGoogleTrendsItem | undefined)[] | undefined;
|
|
53727
|
-
[key: string]: any;
|
|
53728
|
-
}
|
|
53729
|
-
export declare class KeywordsDataGoogleTrendsExploreTaskGetTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataGoogleTrendsExploreTaskGetTaskInfo {
|
|
53730
|
-
/** array of results */
|
|
53731
|
-
result?: (KeywordsDataGoogleTrendsExploreTaskGetResultInfo | undefined)[] | undefined;
|
|
53732
|
-
[key: string]: any;
|
|
53733
|
-
constructor(data?: IKeywordsDataGoogleTrendsExploreTaskGetTaskInfo);
|
|
53734
|
-
init(_data?: any): void;
|
|
53735
|
-
static fromJS(data: any): KeywordsDataGoogleTrendsExploreTaskGetTaskInfo;
|
|
53736
|
-
toJSON(data?: any): any;
|
|
53737
|
-
}
|
|
53738
|
-
export interface IKeywordsDataGoogleTrendsExploreTaskGetTaskInfo extends IBaseResponseTaskInfo {
|
|
53739
|
-
/** array of results */
|
|
53740
|
-
result?: (KeywordsDataGoogleTrendsExploreTaskGetResultInfo | undefined)[] | undefined;
|
|
53741
|
-
[key: string]: any;
|
|
53742
|
-
}
|
|
53743
53904
|
export declare class TrendsMapDataInfo implements ITrendsMapDataInfo {
|
|
53744
53905
|
/** Google Trends location identifier
|
|
53745
53906
|
you can use this field for matching obtained results with location parameters specified in the request
|
|
@@ -53890,6 +54051,74 @@ the data included in the google_trends_topics_list element is based on the keywo
|
|
|
53890
54051
|
data?: QueriesListDataInfo | undefined;
|
|
53891
54052
|
[key: string]: any;
|
|
53892
54053
|
}
|
|
54054
|
+
export declare class KeywordsDataGoogleTrendsExploreTaskGetResultInfo implements IKeywordsDataGoogleTrendsExploreTaskGetResultInfo {
|
|
54055
|
+
/** keywords in a POST array */
|
|
54056
|
+
keywords?: (string | undefined)[] | undefined;
|
|
54057
|
+
/** type of element */
|
|
54058
|
+
type?: string | undefined;
|
|
54059
|
+
/** location code in a POST array
|
|
54060
|
+
if there is no data, then the value is null */
|
|
54061
|
+
location_code?: number | undefined;
|
|
54062
|
+
/** language code in a POST array
|
|
54063
|
+
if there is no data, then the value is null */
|
|
54064
|
+
language_code?: string | undefined;
|
|
54065
|
+
/** direct URL to the Google Trends results
|
|
54066
|
+
you can use it to make sure that we provided accurate results */
|
|
54067
|
+
check_url?: string | undefined;
|
|
54068
|
+
/** date and time when the result was received
|
|
54069
|
+
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
|
|
54070
|
+
example:
|
|
54071
|
+
2019-11-15 12:57:46 +00:00 */
|
|
54072
|
+
datetime?: string | undefined;
|
|
54073
|
+
/** the number of results returned in the items array */
|
|
54074
|
+
items_count?: number | undefined;
|
|
54075
|
+
/** items on the Google Trends page */
|
|
54076
|
+
items?: (BaseGoogleTrendsItem | undefined)[] | undefined;
|
|
54077
|
+
[key: string]: any;
|
|
54078
|
+
constructor(data?: IKeywordsDataGoogleTrendsExploreTaskGetResultInfo);
|
|
54079
|
+
init(_data?: any): void;
|
|
54080
|
+
static fromJS(data: any): KeywordsDataGoogleTrendsExploreTaskGetResultInfo;
|
|
54081
|
+
toJSON(data?: any): any;
|
|
54082
|
+
}
|
|
54083
|
+
export interface IKeywordsDataGoogleTrendsExploreTaskGetResultInfo {
|
|
54084
|
+
/** keywords in a POST array */
|
|
54085
|
+
keywords?: (string | undefined)[] | undefined;
|
|
54086
|
+
/** type of element */
|
|
54087
|
+
type?: string | undefined;
|
|
54088
|
+
/** location code in a POST array
|
|
54089
|
+
if there is no data, then the value is null */
|
|
54090
|
+
location_code?: number | undefined;
|
|
54091
|
+
/** language code in a POST array
|
|
54092
|
+
if there is no data, then the value is null */
|
|
54093
|
+
language_code?: string | undefined;
|
|
54094
|
+
/** direct URL to the Google Trends results
|
|
54095
|
+
you can use it to make sure that we provided accurate results */
|
|
54096
|
+
check_url?: string | undefined;
|
|
54097
|
+
/** date and time when the result was received
|
|
54098
|
+
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
|
|
54099
|
+
example:
|
|
54100
|
+
2019-11-15 12:57:46 +00:00 */
|
|
54101
|
+
datetime?: string | undefined;
|
|
54102
|
+
/** the number of results returned in the items array */
|
|
54103
|
+
items_count?: number | undefined;
|
|
54104
|
+
/** items on the Google Trends page */
|
|
54105
|
+
items?: (BaseGoogleTrendsItem | undefined)[] | undefined;
|
|
54106
|
+
[key: string]: any;
|
|
54107
|
+
}
|
|
54108
|
+
export declare class KeywordsDataGoogleTrendsExploreTaskGetTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataGoogleTrendsExploreTaskGetTaskInfo {
|
|
54109
|
+
/** array of results */
|
|
54110
|
+
result?: (KeywordsDataGoogleTrendsExploreTaskGetResultInfo | undefined)[] | undefined;
|
|
54111
|
+
[key: string]: any;
|
|
54112
|
+
constructor(data?: IKeywordsDataGoogleTrendsExploreTaskGetTaskInfo);
|
|
54113
|
+
init(_data?: any): void;
|
|
54114
|
+
static fromJS(data: any): KeywordsDataGoogleTrendsExploreTaskGetTaskInfo;
|
|
54115
|
+
toJSON(data?: any): any;
|
|
54116
|
+
}
|
|
54117
|
+
export interface IKeywordsDataGoogleTrendsExploreTaskGetTaskInfo extends IBaseResponseTaskInfo {
|
|
54118
|
+
/** array of results */
|
|
54119
|
+
result?: (KeywordsDataGoogleTrendsExploreTaskGetResultInfo | undefined)[] | undefined;
|
|
54120
|
+
[key: string]: any;
|
|
54121
|
+
}
|
|
53893
54122
|
export declare class KeywordsDataGoogleTrendsExploreTaskGetResponseInfo extends BaseResponseInfo implements IKeywordsDataGoogleTrendsExploreTaskGetResponseInfo {
|
|
53894
54123
|
/** array of tasks */
|
|
53895
54124
|
tasks?: (KeywordsDataGoogleTrendsExploreTaskGetTaskInfo | undefined)[] | undefined;
|
|
@@ -55711,7 +55940,8 @@ if you don’t specify this field, data will be provided for the last 12 months
|
|
|
55711
55940
|
minimum value: two years back from today’s date
|
|
55712
55941
|
date format: "yyyy-mm-dd"
|
|
55713
55942
|
example:
|
|
55714
|
-
"2020-01-01"
|
|
55943
|
+
"2020-01-01"
|
|
55944
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
55715
55945
|
date_from?: string | undefined;
|
|
55716
55946
|
/** ending date of the time range
|
|
55717
55947
|
optional field
|
|
@@ -55721,7 +55951,8 @@ maximum value: one month from today’s date;
|
|
|
55721
55951
|
note: we do not recommend using a custom time range for the past year’s dates;
|
|
55722
55952
|
date format: "yyyy-mm-dd"
|
|
55723
55953
|
example:
|
|
55724
|
-
"2020-03-15"
|
|
55954
|
+
"2020-03-15"
|
|
55955
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
55725
55956
|
date_to?: string | undefined;
|
|
55726
55957
|
/** return URL for sending task results
|
|
55727
55958
|
optional field
|
|
@@ -55817,7 +56048,8 @@ if you don’t specify this field, data will be provided for the last 12 months
|
|
|
55817
56048
|
minimum value: two years back from today’s date
|
|
55818
56049
|
date format: "yyyy-mm-dd"
|
|
55819
56050
|
example:
|
|
55820
|
-
"2020-01-01"
|
|
56051
|
+
"2020-01-01"
|
|
56052
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
55821
56053
|
date_from?: string | undefined;
|
|
55822
56054
|
/** ending date of the time range
|
|
55823
56055
|
optional field
|
|
@@ -55827,7 +56059,8 @@ maximum value: one month from today’s date;
|
|
|
55827
56059
|
note: we do not recommend using a custom time range for the past year’s dates;
|
|
55828
56060
|
date format: "yyyy-mm-dd"
|
|
55829
56061
|
example:
|
|
55830
|
-
"2020-03-15"
|
|
56062
|
+
"2020-03-15"
|
|
56063
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
55831
56064
|
date_to?: string | undefined;
|
|
55832
56065
|
/** return URL for sending task results
|
|
55833
56066
|
optional field
|
|
@@ -56121,7 +56354,8 @@ if you don’t specify this field, data will be provided for the last 12 months
|
|
|
56121
56354
|
minimum value: two years back from today’s date
|
|
56122
56355
|
date format: "yyyy-mm-dd"
|
|
56123
56356
|
example:
|
|
56124
|
-
"2020-01-01"
|
|
56357
|
+
"2020-01-01"
|
|
56358
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
56125
56359
|
date_from?: string | undefined;
|
|
56126
56360
|
/** ending date of the time range
|
|
56127
56361
|
optional field
|
|
@@ -56131,7 +56365,8 @@ maximum value: one month from today’s date;
|
|
|
56131
56365
|
note: we do not recommend using a custom time range for the past year’s dates;
|
|
56132
56366
|
date format: "yyyy-mm-dd"
|
|
56133
56367
|
example:
|
|
56134
|
-
"2020-03-15"
|
|
56368
|
+
"2020-03-15"
|
|
56369
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
56135
56370
|
date_to?: string | undefined;
|
|
56136
56371
|
/** Bing search partners type
|
|
56137
56372
|
optional field
|
|
@@ -56207,7 +56442,8 @@ if you don’t specify this field, data will be provided for the last 12 months
|
|
|
56207
56442
|
minimum value: two years back from today’s date
|
|
56208
56443
|
date format: "yyyy-mm-dd"
|
|
56209
56444
|
example:
|
|
56210
|
-
"2020-01-01"
|
|
56445
|
+
"2020-01-01"
|
|
56446
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
56211
56447
|
date_from?: string | undefined;
|
|
56212
56448
|
/** ending date of the time range
|
|
56213
56449
|
optional field
|
|
@@ -56217,7 +56453,8 @@ maximum value: one month from today’s date;
|
|
|
56217
56453
|
note: we do not recommend using a custom time range for the past year’s dates;
|
|
56218
56454
|
date format: "yyyy-mm-dd"
|
|
56219
56455
|
example:
|
|
56220
|
-
"2020-03-15"
|
|
56456
|
+
"2020-03-15"
|
|
56457
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
56221
56458
|
date_to?: string | undefined;
|
|
56222
56459
|
/** Bing search partners type
|
|
56223
56460
|
optional field
|
|
@@ -56403,17 +56640,18 @@ optional field
|
|
|
56403
56640
|
if you don’t specify this field, data will be provided for the last 12 months
|
|
56404
56641
|
date format: "yyyy-mm-dd"
|
|
56405
56642
|
example:
|
|
56406
|
-
"2020-01-01"
|
|
56643
|
+
"2020-01-01"
|
|
56644
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
56407
56645
|
date_from?: string | undefined;
|
|
56408
56646
|
/** ending date of the time range
|
|
56409
56647
|
optional field
|
|
56410
56648
|
if you don’t specify this field, data will be provided for the last 12 months;
|
|
56411
56649
|
minimum value: two years back from today’s date;
|
|
56412
56650
|
maximum value: one month from today’s date;
|
|
56413
|
-
note: we do not recommend using a custom time range for the past year’s dates;
|
|
56414
56651
|
date format: "yyyy-mm-dd"
|
|
56415
56652
|
example:
|
|
56416
|
-
"2020-03-15"
|
|
56653
|
+
"2020-03-15"
|
|
56654
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
56417
56655
|
date_to?: string | undefined;
|
|
56418
56656
|
/** return URL for sending task results
|
|
56419
56657
|
optional field
|
|
@@ -56513,17 +56751,18 @@ optional field
|
|
|
56513
56751
|
if you don’t specify this field, data will be provided for the last 12 months
|
|
56514
56752
|
date format: "yyyy-mm-dd"
|
|
56515
56753
|
example:
|
|
56516
|
-
"2020-01-01"
|
|
56754
|
+
"2020-01-01"
|
|
56755
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
56517
56756
|
date_from?: string | undefined;
|
|
56518
56757
|
/** ending date of the time range
|
|
56519
56758
|
optional field
|
|
56520
56759
|
if you don’t specify this field, data will be provided for the last 12 months;
|
|
56521
56760
|
minimum value: two years back from today’s date;
|
|
56522
56761
|
maximum value: one month from today’s date;
|
|
56523
|
-
note: we do not recommend using a custom time range for the past year’s dates;
|
|
56524
56762
|
date format: "yyyy-mm-dd"
|
|
56525
56763
|
example:
|
|
56526
|
-
"2020-03-15"
|
|
56764
|
+
"2020-03-15"
|
|
56765
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
56527
56766
|
date_to?: string | undefined;
|
|
56528
56767
|
/** return URL for sending task results
|
|
56529
56768
|
optional field
|
|
@@ -56819,7 +57058,8 @@ optional field
|
|
|
56819
57058
|
if you don’t specify this field, data will be provided for the last 12 months
|
|
56820
57059
|
date format: "yyyy-mm-dd"
|
|
56821
57060
|
example:
|
|
56822
|
-
"2020-01-01"
|
|
57061
|
+
"2020-01-01"
|
|
57062
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
56823
57063
|
date_from?: string | undefined;
|
|
56824
57064
|
/** ending date of the time range
|
|
56825
57065
|
optional field
|
|
@@ -56829,7 +57069,8 @@ maximum value: one month from today’s date;
|
|
|
56829
57069
|
note: we do not recommend using a custom time range for the past year’s dates;
|
|
56830
57070
|
date format: "yyyy-mm-dd"
|
|
56831
57071
|
example:
|
|
56832
|
-
"2020-03-15"
|
|
57072
|
+
"2020-03-15"
|
|
57073
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
56833
57074
|
date_to?: string | undefined;
|
|
56834
57075
|
/** results sorting parameters
|
|
56835
57076
|
optional field
|
|
@@ -56908,7 +57149,8 @@ optional field
|
|
|
56908
57149
|
if you don’t specify this field, data will be provided for the last 12 months
|
|
56909
57150
|
date format: "yyyy-mm-dd"
|
|
56910
57151
|
example:
|
|
56911
|
-
"2020-01-01"
|
|
57152
|
+
"2020-01-01"
|
|
57153
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
56912
57154
|
date_from?: string | undefined;
|
|
56913
57155
|
/** ending date of the time range
|
|
56914
57156
|
optional field
|
|
@@ -56918,7 +57160,8 @@ maximum value: one month from today’s date;
|
|
|
56918
57160
|
note: we do not recommend using a custom time range for the past year’s dates;
|
|
56919
57161
|
date format: "yyyy-mm-dd"
|
|
56920
57162
|
example:
|
|
56921
|
-
"2020-03-15"
|
|
57163
|
+
"2020-03-15"
|
|
57164
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
56922
57165
|
date_to?: string | undefined;
|
|
56923
57166
|
/** results sorting parameters
|
|
56924
57167
|
optional field
|
|
@@ -57103,17 +57346,18 @@ you can specify a date from the past 24 months
|
|
|
57103
57346
|
if you don’t specify this field, data will be provided for the last 12 months
|
|
57104
57347
|
date format: "yyyy-mm-dd"
|
|
57105
57348
|
example:
|
|
57106
|
-
"2020-01-01"
|
|
57349
|
+
"2020-01-01"
|
|
57350
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
57107
57351
|
date_from?: string | undefined;
|
|
57108
57352
|
/** ending date of the time range
|
|
57109
57353
|
optional field
|
|
57110
57354
|
if you don’t specify this field, data will be provided for the last 12 months;
|
|
57111
57355
|
minimum value: two years back from today’s date;
|
|
57112
57356
|
maximum value: one month from today’s date;
|
|
57113
|
-
note: we do not recommend using a custom time range for the past year’s dates;
|
|
57114
57357
|
date format: "yyyy-mm-dd"
|
|
57115
57358
|
example:
|
|
57116
|
-
"2020-03-15"
|
|
57359
|
+
"2020-03-15"
|
|
57360
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
57117
57361
|
date_to?: string | undefined;
|
|
57118
57362
|
/** Bing search partners type
|
|
57119
57363
|
optional field
|
|
@@ -57215,17 +57459,18 @@ you can specify a date from the past 24 months
|
|
|
57215
57459
|
if you don’t specify this field, data will be provided for the last 12 months
|
|
57216
57460
|
date format: "yyyy-mm-dd"
|
|
57217
57461
|
example:
|
|
57218
|
-
"2020-01-01"
|
|
57462
|
+
"2020-01-01"
|
|
57463
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
57219
57464
|
date_from?: string | undefined;
|
|
57220
57465
|
/** ending date of the time range
|
|
57221
57466
|
optional field
|
|
57222
57467
|
if you don’t specify this field, data will be provided for the last 12 months;
|
|
57223
57468
|
minimum value: two years back from today’s date;
|
|
57224
57469
|
maximum value: one month from today’s date;
|
|
57225
|
-
note: we do not recommend using a custom time range for the past year’s dates;
|
|
57226
57470
|
date format: "yyyy-mm-dd"
|
|
57227
57471
|
example:
|
|
57228
|
-
"2020-03-15"
|
|
57472
|
+
"2020-03-15"
|
|
57473
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
57229
57474
|
date_to?: string | undefined;
|
|
57230
57475
|
/** Bing search partners type
|
|
57231
57476
|
optional field
|
|
@@ -57527,17 +57772,18 @@ you can specify a date from the past 24 months
|
|
|
57527
57772
|
if you don’t specify this field, data will be provided for the last 12 months
|
|
57528
57773
|
date format: "yyyy-mm-dd"
|
|
57529
57774
|
example:
|
|
57530
|
-
"2020-01-01"
|
|
57775
|
+
"2020-01-01"
|
|
57776
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
57531
57777
|
date_from?: string | undefined;
|
|
57532
57778
|
/** ending date of the time range
|
|
57533
57779
|
optional field
|
|
57534
57780
|
if you don’t specify this field, data will be provided for the last 12 months;
|
|
57535
57781
|
minimum value: two years back from today’s date;
|
|
57536
57782
|
maximum value: one month from today’s date;
|
|
57537
|
-
note: we do not recommend using a custom time range for the past year’s dates;
|
|
57538
57783
|
date format: "yyyy-mm-dd"
|
|
57539
57784
|
example:
|
|
57540
|
-
"2020-03-15"
|
|
57785
|
+
"2020-03-15"
|
|
57786
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
57541
57787
|
date_to?: string | undefined;
|
|
57542
57788
|
/** Bing search partners type
|
|
57543
57789
|
optional field
|
|
@@ -57619,17 +57865,18 @@ you can specify a date from the past 24 months
|
|
|
57619
57865
|
if you don’t specify this field, data will be provided for the last 12 months
|
|
57620
57866
|
date format: "yyyy-mm-dd"
|
|
57621
57867
|
example:
|
|
57622
|
-
"2020-01-01"
|
|
57868
|
+
"2020-01-01"
|
|
57869
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
57623
57870
|
date_from?: string | undefined;
|
|
57624
57871
|
/** ending date of the time range
|
|
57625
57872
|
optional field
|
|
57626
57873
|
if you don’t specify this field, data will be provided for the last 12 months;
|
|
57627
57874
|
minimum value: two years back from today’s date;
|
|
57628
57875
|
maximum value: one month from today’s date;
|
|
57629
|
-
note: we do not recommend using a custom time range for the past year’s dates;
|
|
57630
57876
|
date format: "yyyy-mm-dd"
|
|
57631
57877
|
example:
|
|
57632
|
-
"2020-03-15"
|
|
57878
|
+
"2020-03-15"
|
|
57879
|
+
Note: we do not recommend using a custom time range for the past year’s dates */
|
|
57633
57880
|
date_to?: string | undefined;
|
|
57634
57881
|
/** Bing search partners type
|
|
57635
57882
|
optional field
|
|
@@ -58492,6 +58739,752 @@ export interface IKeywordsDataBingKeywordPerformanceLiveResponseInfo extends IBa
|
|
|
58492
58739
|
tasks?: (KeywordsDataBingKeywordPerformanceLiveTaskInfo | undefined)[] | undefined;
|
|
58493
58740
|
[key: string]: any;
|
|
58494
58741
|
}
|
|
58742
|
+
export declare class KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo implements IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo {
|
|
58743
|
+
/** language name */
|
|
58744
|
+
language_name?: string | undefined;
|
|
58745
|
+
/** language code according to ISO 639-1 */
|
|
58746
|
+
language_code?: string | undefined;
|
|
58747
|
+
/** array of available locations for a certain language */
|
|
58748
|
+
available_locations?: (AvailableLocations | undefined)[] | undefined;
|
|
58749
|
+
[key: string]: any;
|
|
58750
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo);
|
|
58751
|
+
init(_data?: any): void;
|
|
58752
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo;
|
|
58753
|
+
toJSON(data?: any): any;
|
|
58754
|
+
}
|
|
58755
|
+
export interface IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo {
|
|
58756
|
+
/** language name */
|
|
58757
|
+
language_name?: string | undefined;
|
|
58758
|
+
/** language code according to ISO 639-1 */
|
|
58759
|
+
language_code?: string | undefined;
|
|
58760
|
+
/** array of available locations for a certain language */
|
|
58761
|
+
available_locations?: (AvailableLocations | undefined)[] | undefined;
|
|
58762
|
+
[key: string]: any;
|
|
58763
|
+
}
|
|
58764
|
+
export declare class KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo {
|
|
58765
|
+
/** array of results */
|
|
58766
|
+
result?: (KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo | undefined)[] | undefined;
|
|
58767
|
+
[key: string]: any;
|
|
58768
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo);
|
|
58769
|
+
init(_data?: any): void;
|
|
58770
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo;
|
|
58771
|
+
toJSON(data?: any): any;
|
|
58772
|
+
}
|
|
58773
|
+
export interface IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo extends IBaseResponseTaskInfo {
|
|
58774
|
+
/** array of results */
|
|
58775
|
+
result?: (KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo | undefined)[] | undefined;
|
|
58776
|
+
[key: string]: any;
|
|
58777
|
+
}
|
|
58778
|
+
export declare class KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo extends BaseResponseInfo implements IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo {
|
|
58779
|
+
/** array of tasks */
|
|
58780
|
+
tasks?: (KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo | undefined)[] | undefined;
|
|
58781
|
+
[key: string]: any;
|
|
58782
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo);
|
|
58783
|
+
init(_data?: any): void;
|
|
58784
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo;
|
|
58785
|
+
toJSON(data?: any): any;
|
|
58786
|
+
}
|
|
58787
|
+
export interface IKeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo extends IBaseResponseInfo {
|
|
58788
|
+
/** array of tasks */
|
|
58789
|
+
tasks?: (KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo | undefined)[] | undefined;
|
|
58790
|
+
[key: string]: any;
|
|
58791
|
+
}
|
|
58792
|
+
export declare class KeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo implements IKeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo {
|
|
58793
|
+
/** keywords
|
|
58794
|
+
required field
|
|
58795
|
+
The maximum number of keywords you can specify: 1000
|
|
58796
|
+
The maximum number of characters for each keyword: 100
|
|
58797
|
+
the specified keywords will be converted to lowercase, data will be provided in a separate array */
|
|
58798
|
+
keywords?: string[];
|
|
58799
|
+
/** full name of search engine location
|
|
58800
|
+
required field if you don’t specify location_code or location_coordinate
|
|
58801
|
+
if you use this field, you don’t need to specify location_code or location_coordinate
|
|
58802
|
+
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
|
|
58803
|
+
example:
|
|
58804
|
+
London,England,United Kingdom */
|
|
58805
|
+
location_name?: string | undefined;
|
|
58806
|
+
/** search engine location code
|
|
58807
|
+
required field if you don’t specify location_name or location_coordinate
|
|
58808
|
+
if you use this field, you don’t need to specify location_name or location_coordinate
|
|
58809
|
+
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
|
|
58810
|
+
example:
|
|
58811
|
+
2840 */
|
|
58812
|
+
location_code?: number | undefined;
|
|
58813
|
+
/** GPS coordinates of a location
|
|
58814
|
+
required field if you don’t specify location_name or location_code
|
|
58815
|
+
if you use this field, you don’t need to specify location_name or location_code
|
|
58816
|
+
location_coordinate parameter should be specified in the “latitude,longitude” format
|
|
58817
|
+
the data will be provided for the country the specified coordinates belong to
|
|
58818
|
+
example:
|
|
58819
|
+
52.6178549,-155.352142 */
|
|
58820
|
+
location_coordinate?: string | undefined;
|
|
58821
|
+
/** full name of search engine language
|
|
58822
|
+
required field if you don’t specify language_code
|
|
58823
|
+
if you use this field, you don’t need to specify language_code
|
|
58824
|
+
you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
|
|
58825
|
+
language_name?: string | undefined;
|
|
58826
|
+
/** search engine language code
|
|
58827
|
+
required field if you don’t specify language_name
|
|
58828
|
+
if you use this field, you don’t need to specify language_name
|
|
58829
|
+
you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
|
|
58830
|
+
language_code?: string | undefined;
|
|
58831
|
+
/** device type
|
|
58832
|
+
optional field
|
|
58833
|
+
specify this field if you want to get the data for a particular device type
|
|
58834
|
+
possible values: mobile, desktop, tablet, non_smartphones
|
|
58835
|
+
default value: mobile, desktop, tablet, non_smartphones */
|
|
58836
|
+
device?: string | undefined;
|
|
58837
|
+
/** aggregates the returned data to a certain time period
|
|
58838
|
+
optional field
|
|
58839
|
+
specify this field if you want to get the data in monthly, weekly or daily format
|
|
58840
|
+
possible values: monthly, weekly, daily
|
|
58841
|
+
monthly – returns data up to past 24 months
|
|
58842
|
+
weekly – returns data up to past 15 weeks
|
|
58843
|
+
daily – returns data up to past 45 days
|
|
58844
|
+
default value: monthly */
|
|
58845
|
+
period?: string | undefined;
|
|
58846
|
+
/** starting date of the time range
|
|
58847
|
+
optional field
|
|
58848
|
+
minimum value: two years back from today’s date
|
|
58849
|
+
maximum value: one day from today’s date
|
|
58850
|
+
date format: "yyyy-mm-dd"
|
|
58851
|
+
example:
|
|
58852
|
+
"2020-01-01"
|
|
58853
|
+
Note: we do not recommend using a custom time range
|
|
58854
|
+
Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
|
|
58855
|
+
if you specify the period parameter:
|
|
58856
|
+
with value weekly, you will get results for the past 15 weeks
|
|
58857
|
+
with value daily, you will get results for the past 45 days */
|
|
58858
|
+
date_from?: string | undefined;
|
|
58859
|
+
/** ending date of the time range
|
|
58860
|
+
optional field
|
|
58861
|
+
minimum value: two years back from today’s date;
|
|
58862
|
+
maximum value: one day from today’s date;
|
|
58863
|
+
date format: "yyyy-mm-dd"
|
|
58864
|
+
example:
|
|
58865
|
+
"2020-03-15"
|
|
58866
|
+
Note: we do not recommend using a custom time range
|
|
58867
|
+
Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
|
|
58868
|
+
if you specify the period parameter:
|
|
58869
|
+
with value weekly, you will get results for the past 15 weeks
|
|
58870
|
+
with value daily, you will get results for the past 45 days */
|
|
58871
|
+
date_to?: string | undefined;
|
|
58872
|
+
/** return URL for sending task results
|
|
58873
|
+
optional field
|
|
58874
|
+
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
|
|
58875
|
+
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
|
|
58876
|
+
example:
|
|
58877
|
+
http://your-server.com/postbackscript?id=$id
|
|
58878
|
+
http://your-server.com/postbackscript?id=$id&tag=$tag
|
|
58879
|
+
Note: special symbols in postback_url will be urlencoded;
|
|
58880
|
+
i.a., the # symbol will be encoded into %23 */
|
|
58881
|
+
postback_url?: string | undefined;
|
|
58882
|
+
/** notification URL of a completed task
|
|
58883
|
+
optional field
|
|
58884
|
+
when a task is completed we will notify you by GET request sent to the URL you have specified
|
|
58885
|
+
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
|
|
58886
|
+
example:
|
|
58887
|
+
http://your-server.com/pingscript?id=$id
|
|
58888
|
+
http://your-server.com/pingscript?id=$id&tag=$tag
|
|
58889
|
+
Note: special symbols in pingback_url will be urlencoded;
|
|
58890
|
+
i.a., the # symbol will be encoded into %23 */
|
|
58891
|
+
pingback_url?: string | undefined;
|
|
58892
|
+
/** user-defined task identifier
|
|
58893
|
+
optional field
|
|
58894
|
+
the character limit is 255
|
|
58895
|
+
you can use this parameter to identify the task and match it with the result
|
|
58896
|
+
you will find the specified tag value in the data object of the response */
|
|
58897
|
+
tag?: string | undefined;
|
|
58898
|
+
[key: string]: any;
|
|
58899
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo);
|
|
58900
|
+
init(_data?: any): void;
|
|
58901
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo;
|
|
58902
|
+
toJSON(data?: any): any;
|
|
58903
|
+
}
|
|
58904
|
+
export interface IKeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo {
|
|
58905
|
+
/** keywords
|
|
58906
|
+
required field
|
|
58907
|
+
The maximum number of keywords you can specify: 1000
|
|
58908
|
+
The maximum number of characters for each keyword: 100
|
|
58909
|
+
the specified keywords will be converted to lowercase, data will be provided in a separate array */
|
|
58910
|
+
keywords?: string[];
|
|
58911
|
+
/** full name of search engine location
|
|
58912
|
+
required field if you don’t specify location_code or location_coordinate
|
|
58913
|
+
if you use this field, you don’t need to specify location_code or location_coordinate
|
|
58914
|
+
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
|
|
58915
|
+
example:
|
|
58916
|
+
London,England,United Kingdom */
|
|
58917
|
+
location_name?: string | undefined;
|
|
58918
|
+
/** search engine location code
|
|
58919
|
+
required field if you don’t specify location_name or location_coordinate
|
|
58920
|
+
if you use this field, you don’t need to specify location_name or location_coordinate
|
|
58921
|
+
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
|
|
58922
|
+
example:
|
|
58923
|
+
2840 */
|
|
58924
|
+
location_code?: number | undefined;
|
|
58925
|
+
/** GPS coordinates of a location
|
|
58926
|
+
required field if you don’t specify location_name or location_code
|
|
58927
|
+
if you use this field, you don’t need to specify location_name or location_code
|
|
58928
|
+
location_coordinate parameter should be specified in the “latitude,longitude” format
|
|
58929
|
+
the data will be provided for the country the specified coordinates belong to
|
|
58930
|
+
example:
|
|
58931
|
+
52.6178549,-155.352142 */
|
|
58932
|
+
location_coordinate?: string | undefined;
|
|
58933
|
+
/** full name of search engine language
|
|
58934
|
+
required field if you don’t specify language_code
|
|
58935
|
+
if you use this field, you don’t need to specify language_code
|
|
58936
|
+
you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
|
|
58937
|
+
language_name?: string | undefined;
|
|
58938
|
+
/** search engine language code
|
|
58939
|
+
required field if you don’t specify language_name
|
|
58940
|
+
if you use this field, you don’t need to specify language_name
|
|
58941
|
+
you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
|
|
58942
|
+
language_code?: string | undefined;
|
|
58943
|
+
/** device type
|
|
58944
|
+
optional field
|
|
58945
|
+
specify this field if you want to get the data for a particular device type
|
|
58946
|
+
possible values: mobile, desktop, tablet, non_smartphones
|
|
58947
|
+
default value: mobile, desktop, tablet, non_smartphones */
|
|
58948
|
+
device?: string | undefined;
|
|
58949
|
+
/** aggregates the returned data to a certain time period
|
|
58950
|
+
optional field
|
|
58951
|
+
specify this field if you want to get the data in monthly, weekly or daily format
|
|
58952
|
+
possible values: monthly, weekly, daily
|
|
58953
|
+
monthly – returns data up to past 24 months
|
|
58954
|
+
weekly – returns data up to past 15 weeks
|
|
58955
|
+
daily – returns data up to past 45 days
|
|
58956
|
+
default value: monthly */
|
|
58957
|
+
period?: string | undefined;
|
|
58958
|
+
/** starting date of the time range
|
|
58959
|
+
optional field
|
|
58960
|
+
minimum value: two years back from today’s date
|
|
58961
|
+
maximum value: one day from today’s date
|
|
58962
|
+
date format: "yyyy-mm-dd"
|
|
58963
|
+
example:
|
|
58964
|
+
"2020-01-01"
|
|
58965
|
+
Note: we do not recommend using a custom time range
|
|
58966
|
+
Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
|
|
58967
|
+
if you specify the period parameter:
|
|
58968
|
+
with value weekly, you will get results for the past 15 weeks
|
|
58969
|
+
with value daily, you will get results for the past 45 days */
|
|
58970
|
+
date_from?: string | undefined;
|
|
58971
|
+
/** ending date of the time range
|
|
58972
|
+
optional field
|
|
58973
|
+
minimum value: two years back from today’s date;
|
|
58974
|
+
maximum value: one day from today’s date;
|
|
58975
|
+
date format: "yyyy-mm-dd"
|
|
58976
|
+
example:
|
|
58977
|
+
"2020-03-15"
|
|
58978
|
+
Note: we do not recommend using a custom time range
|
|
58979
|
+
Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
|
|
58980
|
+
if you specify the period parameter:
|
|
58981
|
+
with value weekly, you will get results for the past 15 weeks
|
|
58982
|
+
with value daily, you will get results for the past 45 days */
|
|
58983
|
+
date_to?: string | undefined;
|
|
58984
|
+
/** return URL for sending task results
|
|
58985
|
+
optional field
|
|
58986
|
+
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
|
|
58987
|
+
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
|
|
58988
|
+
example:
|
|
58989
|
+
http://your-server.com/postbackscript?id=$id
|
|
58990
|
+
http://your-server.com/postbackscript?id=$id&tag=$tag
|
|
58991
|
+
Note: special symbols in postback_url will be urlencoded;
|
|
58992
|
+
i.a., the # symbol will be encoded into %23 */
|
|
58993
|
+
postback_url?: string | undefined;
|
|
58994
|
+
/** notification URL of a completed task
|
|
58995
|
+
optional field
|
|
58996
|
+
when a task is completed we will notify you by GET request sent to the URL you have specified
|
|
58997
|
+
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
|
|
58998
|
+
example:
|
|
58999
|
+
http://your-server.com/pingscript?id=$id
|
|
59000
|
+
http://your-server.com/pingscript?id=$id&tag=$tag
|
|
59001
|
+
Note: special symbols in pingback_url will be urlencoded;
|
|
59002
|
+
i.a., the # symbol will be encoded into %23 */
|
|
59003
|
+
pingback_url?: string | undefined;
|
|
59004
|
+
/** user-defined task identifier
|
|
59005
|
+
optional field
|
|
59006
|
+
the character limit is 255
|
|
59007
|
+
you can use this parameter to identify the task and match it with the result
|
|
59008
|
+
you will find the specified tag value in the data object of the response */
|
|
59009
|
+
tag?: string | undefined;
|
|
59010
|
+
[key: string]: any;
|
|
59011
|
+
}
|
|
59012
|
+
export declare class KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo {
|
|
59013
|
+
/** array of results
|
|
59014
|
+
in this case, the value will be null */
|
|
59015
|
+
result?: any | undefined;
|
|
59016
|
+
[key: string]: any;
|
|
59017
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo);
|
|
59018
|
+
init(_data?: any): void;
|
|
59019
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo;
|
|
59020
|
+
toJSON(data?: any): any;
|
|
59021
|
+
}
|
|
59022
|
+
export interface IKeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo extends IBaseResponseTaskInfo {
|
|
59023
|
+
/** array of results
|
|
59024
|
+
in this case, the value will be null */
|
|
59025
|
+
result?: any | undefined;
|
|
59026
|
+
[key: string]: any;
|
|
59027
|
+
}
|
|
59028
|
+
export declare class KeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo extends BaseResponseInfo implements IKeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo {
|
|
59029
|
+
/** array of tasks */
|
|
59030
|
+
tasks?: (KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo | undefined)[] | undefined;
|
|
59031
|
+
[key: string]: any;
|
|
59032
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo);
|
|
59033
|
+
init(_data?: any): void;
|
|
59034
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo;
|
|
59035
|
+
toJSON(data?: any): any;
|
|
59036
|
+
}
|
|
59037
|
+
export interface IKeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo extends IBaseResponseInfo {
|
|
59038
|
+
/** array of tasks */
|
|
59039
|
+
tasks?: (KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo | undefined)[] | undefined;
|
|
59040
|
+
[key: string]: any;
|
|
59041
|
+
}
|
|
59042
|
+
export declare class KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo implements IKeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo {
|
|
59043
|
+
/** task identifier of the completed task
|
|
59044
|
+
unique task identifier in our system in the UUID format */
|
|
59045
|
+
id?: string | undefined;
|
|
59046
|
+
/** search engine specified when setting the task */
|
|
59047
|
+
se?: string | undefined;
|
|
59048
|
+
/** type of the task */
|
|
59049
|
+
function?: string | undefined;
|
|
59050
|
+
/** date when the task was posted (in the UTC format) */
|
|
59051
|
+
date_posted?: string | undefined;
|
|
59052
|
+
/** user-defined task identifier */
|
|
59053
|
+
tag?: string | undefined;
|
|
59054
|
+
/** URL for collecting the results of the task */
|
|
59055
|
+
endpoint?: string | undefined;
|
|
59056
|
+
[key: string]: any;
|
|
59057
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo);
|
|
59058
|
+
init(_data?: any): void;
|
|
59059
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo;
|
|
59060
|
+
toJSON(data?: any): any;
|
|
59061
|
+
}
|
|
59062
|
+
export interface IKeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo {
|
|
59063
|
+
/** task identifier of the completed task
|
|
59064
|
+
unique task identifier in our system in the UUID format */
|
|
59065
|
+
id?: string | undefined;
|
|
59066
|
+
/** search engine specified when setting the task */
|
|
59067
|
+
se?: string | undefined;
|
|
59068
|
+
/** type of the task */
|
|
59069
|
+
function?: string | undefined;
|
|
59070
|
+
/** date when the task was posted (in the UTC format) */
|
|
59071
|
+
date_posted?: string | undefined;
|
|
59072
|
+
/** user-defined task identifier */
|
|
59073
|
+
tag?: string | undefined;
|
|
59074
|
+
/** URL for collecting the results of the task */
|
|
59075
|
+
endpoint?: string | undefined;
|
|
59076
|
+
[key: string]: any;
|
|
59077
|
+
}
|
|
59078
|
+
export declare class KeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo {
|
|
59079
|
+
/** array of results */
|
|
59080
|
+
result?: (KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo | undefined)[] | undefined;
|
|
59081
|
+
[key: string]: any;
|
|
59082
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo);
|
|
59083
|
+
init(_data?: any): void;
|
|
59084
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo;
|
|
59085
|
+
toJSON(data?: any): any;
|
|
59086
|
+
}
|
|
59087
|
+
export interface IKeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo extends IBaseResponseTaskInfo {
|
|
59088
|
+
/** array of results */
|
|
59089
|
+
result?: (KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo | undefined)[] | undefined;
|
|
59090
|
+
[key: string]: any;
|
|
59091
|
+
}
|
|
59092
|
+
export declare class KeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo extends BaseResponseInfo implements IKeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo {
|
|
59093
|
+
/** array of tasks */
|
|
59094
|
+
tasks?: (KeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo | undefined)[] | undefined;
|
|
59095
|
+
[key: string]: any;
|
|
59096
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo);
|
|
59097
|
+
init(_data?: any): void;
|
|
59098
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo;
|
|
59099
|
+
toJSON(data?: any): any;
|
|
59100
|
+
}
|
|
59101
|
+
export interface IKeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo extends IBaseResponseInfo {
|
|
59102
|
+
/** array of tasks */
|
|
59103
|
+
tasks?: (KeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo | undefined)[] | undefined;
|
|
59104
|
+
[key: string]: any;
|
|
59105
|
+
}
|
|
59106
|
+
/** device type = desktop contains historical search volume data for searches made from desktop devices */
|
|
59107
|
+
export declare class SearchVolumeHistoryItemInfo implements ISearchVolumeHistoryItemInfo {
|
|
59108
|
+
/** year */
|
|
59109
|
+
year?: number | undefined;
|
|
59110
|
+
/** month */
|
|
59111
|
+
month?: number | undefined;
|
|
59112
|
+
/** day of the month */
|
|
59113
|
+
day?: number | undefined;
|
|
59114
|
+
/** search volume rate */
|
|
59115
|
+
search_volume?: number | undefined;
|
|
59116
|
+
[key: string]: any;
|
|
59117
|
+
constructor(data?: ISearchVolumeHistoryItemInfo);
|
|
59118
|
+
init(_data?: any): void;
|
|
59119
|
+
static fromJS(data: any): SearchVolumeHistoryItemInfo;
|
|
59120
|
+
toJSON(data?: any): any;
|
|
59121
|
+
}
|
|
59122
|
+
/** device type = desktop contains historical search volume data for searches made from desktop devices */
|
|
59123
|
+
export interface ISearchVolumeHistoryItemInfo {
|
|
59124
|
+
/** year */
|
|
59125
|
+
year?: number | undefined;
|
|
59126
|
+
/** month */
|
|
59127
|
+
month?: number | undefined;
|
|
59128
|
+
/** day of the month */
|
|
59129
|
+
day?: number | undefined;
|
|
59130
|
+
/** search volume rate */
|
|
59131
|
+
search_volume?: number | undefined;
|
|
59132
|
+
[key: string]: any;
|
|
59133
|
+
}
|
|
59134
|
+
export declare class SearchVolumeHistorySearchInfo implements ISearchVolumeHistorySearchInfo {
|
|
59135
|
+
/** device type = desktop
|
|
59136
|
+
contains historical search volume data for searches made from desktop devices */
|
|
59137
|
+
desktop?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
|
|
59138
|
+
/** device type = non-smartphones
|
|
59139
|
+
contains historical search volume data for searches made from feature phones (non-smartphone mobile devices) */
|
|
59140
|
+
non_smartphones?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
|
|
59141
|
+
/** device type = mobile
|
|
59142
|
+
contains historical search volume data for searches made from mobile devices */
|
|
59143
|
+
mobile?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
|
|
59144
|
+
/** device type = tablet
|
|
59145
|
+
contains historical search volume data for searches made from tablets */
|
|
59146
|
+
tablet?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
|
|
59147
|
+
[key: string]: any;
|
|
59148
|
+
constructor(data?: ISearchVolumeHistorySearchInfo);
|
|
59149
|
+
init(_data?: any): void;
|
|
59150
|
+
static fromJS(data: any): SearchVolumeHistorySearchInfo;
|
|
59151
|
+
toJSON(data?: any): any;
|
|
59152
|
+
}
|
|
59153
|
+
export interface ISearchVolumeHistorySearchInfo {
|
|
59154
|
+
/** device type = desktop
|
|
59155
|
+
contains historical search volume data for searches made from desktop devices */
|
|
59156
|
+
desktop?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
|
|
59157
|
+
/** device type = non-smartphones
|
|
59158
|
+
contains historical search volume data for searches made from feature phones (non-smartphone mobile devices) */
|
|
59159
|
+
non_smartphones?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
|
|
59160
|
+
/** device type = mobile
|
|
59161
|
+
contains historical search volume data for searches made from mobile devices */
|
|
59162
|
+
mobile?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
|
|
59163
|
+
/** device type = tablet
|
|
59164
|
+
contains historical search volume data for searches made from tablets */
|
|
59165
|
+
tablet?: (SearchVolumeHistoryItemInfo | undefined)[] | undefined;
|
|
59166
|
+
[key: string]: any;
|
|
59167
|
+
}
|
|
59168
|
+
export declare class KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo implements IKeywordsDataBingSearchVolumeHistoryTaskGetResultInfo {
|
|
59169
|
+
/** keyword in a POST array */
|
|
59170
|
+
keyword?: string | undefined;
|
|
59171
|
+
/** location code in a POST array
|
|
59172
|
+
if there is no data, then the value is null */
|
|
59173
|
+
location_code?: number | undefined;
|
|
59174
|
+
/** language code in a POST array
|
|
59175
|
+
if there is no data, then the value is null */
|
|
59176
|
+
language_code?: string | undefined;
|
|
59177
|
+
device?: (string | undefined)[] | undefined;
|
|
59178
|
+
/** time period
|
|
59179
|
+
indicates if returned data is aggregated to a certain time period
|
|
59180
|
+
default value monthly */
|
|
59181
|
+
period?: string | undefined;
|
|
59182
|
+
/** contains results distributed by device type
|
|
59183
|
+
if the device parameter is not specified, the data will be returned for all available device types */
|
|
59184
|
+
searches?: SearchVolumeHistorySearchInfo | undefined;
|
|
59185
|
+
[key: string]: any;
|
|
59186
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryTaskGetResultInfo);
|
|
59187
|
+
init(_data?: any): void;
|
|
59188
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo;
|
|
59189
|
+
toJSON(data?: any): any;
|
|
59190
|
+
}
|
|
59191
|
+
export interface IKeywordsDataBingSearchVolumeHistoryTaskGetResultInfo {
|
|
59192
|
+
/** keyword in a POST array */
|
|
59193
|
+
keyword?: string | undefined;
|
|
59194
|
+
/** location code in a POST array
|
|
59195
|
+
if there is no data, then the value is null */
|
|
59196
|
+
location_code?: number | undefined;
|
|
59197
|
+
/** language code in a POST array
|
|
59198
|
+
if there is no data, then the value is null */
|
|
59199
|
+
language_code?: string | undefined;
|
|
59200
|
+
device?: (string | undefined)[] | undefined;
|
|
59201
|
+
/** time period
|
|
59202
|
+
indicates if returned data is aggregated to a certain time period
|
|
59203
|
+
default value monthly */
|
|
59204
|
+
period?: string | undefined;
|
|
59205
|
+
/** contains results distributed by device type
|
|
59206
|
+
if the device parameter is not specified, the data will be returned for all available device types */
|
|
59207
|
+
searches?: SearchVolumeHistorySearchInfo | undefined;
|
|
59208
|
+
[key: string]: any;
|
|
59209
|
+
}
|
|
59210
|
+
export declare class KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo {
|
|
59211
|
+
/** array of results */
|
|
59212
|
+
result?: (KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo | undefined)[] | undefined;
|
|
59213
|
+
[key: string]: any;
|
|
59214
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo);
|
|
59215
|
+
init(_data?: any): void;
|
|
59216
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo;
|
|
59217
|
+
toJSON(data?: any): any;
|
|
59218
|
+
}
|
|
59219
|
+
export interface IKeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo extends IBaseResponseTaskInfo {
|
|
59220
|
+
/** array of results */
|
|
59221
|
+
result?: (KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo | undefined)[] | undefined;
|
|
59222
|
+
[key: string]: any;
|
|
59223
|
+
}
|
|
59224
|
+
export declare class KeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo extends BaseResponseInfo implements IKeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo {
|
|
59225
|
+
/** array of tasks */
|
|
59226
|
+
tasks?: (KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo | undefined)[] | undefined;
|
|
59227
|
+
[key: string]: any;
|
|
59228
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo);
|
|
59229
|
+
init(_data?: any): void;
|
|
59230
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo;
|
|
59231
|
+
toJSON(data?: any): any;
|
|
59232
|
+
}
|
|
59233
|
+
export interface IKeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo extends IBaseResponseInfo {
|
|
59234
|
+
/** array of tasks */
|
|
59235
|
+
tasks?: (KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo | undefined)[] | undefined;
|
|
59236
|
+
[key: string]: any;
|
|
59237
|
+
}
|
|
59238
|
+
export declare class KeywordsDataBingSearchVolumeHistoryLiveRequestInfo implements IKeywordsDataBingSearchVolumeHistoryLiveRequestInfo {
|
|
59239
|
+
/** keywords
|
|
59240
|
+
required field
|
|
59241
|
+
The maximum number of keywords you can specify: 1000
|
|
59242
|
+
The maximum number of characters for each keyword: 100
|
|
59243
|
+
the specified keywords will be converted to lowercase, data will be provided in a separate array */
|
|
59244
|
+
keywords?: string[];
|
|
59245
|
+
/** full name of search engine location
|
|
59246
|
+
required field if you don’t specify location_code or location_coordinate
|
|
59247
|
+
if you use this field, you don’t need to specify location_code or location_coordinate
|
|
59248
|
+
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
|
|
59249
|
+
example:
|
|
59250
|
+
London,England,United Kingdom */
|
|
59251
|
+
location_name?: string | undefined;
|
|
59252
|
+
/** search engine location code
|
|
59253
|
+
required field if you don’t specify location_name or location_coordinate
|
|
59254
|
+
if you use this field, you don’t need to specify location_name or location_coordinate
|
|
59255
|
+
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
|
|
59256
|
+
example:
|
|
59257
|
+
2840 */
|
|
59258
|
+
location_code?: number | undefined;
|
|
59259
|
+
/** GPS coordinates of a location
|
|
59260
|
+
required field if you don’t specify location_name or location_code
|
|
59261
|
+
if you use this field, you don’t need to specify location_name or location_code
|
|
59262
|
+
location_coordinate parameter should be specified in the “latitude,longitude” format
|
|
59263
|
+
the data will be provided for the country the specified coordinates belong to
|
|
59264
|
+
example:
|
|
59265
|
+
52.6178549,-155.352142 */
|
|
59266
|
+
location_coordinate?: string | undefined;
|
|
59267
|
+
/** full name of search engine language
|
|
59268
|
+
required field if you don’t specify language_code
|
|
59269
|
+
if you use this field, you don’t need to specify language_code
|
|
59270
|
+
you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
|
|
59271
|
+
language_name?: string | undefined;
|
|
59272
|
+
/** search engine language code
|
|
59273
|
+
required field if you don’t specify language_name
|
|
59274
|
+
if you use this field, you don’t need to specify language_name
|
|
59275
|
+
you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
|
|
59276
|
+
language_code?: string | undefined;
|
|
59277
|
+
/** device type
|
|
59278
|
+
optional field
|
|
59279
|
+
specify this field if you want to get the data for a particular device type
|
|
59280
|
+
possible values: mobile, desktop, tablet, non_smartphones
|
|
59281
|
+
default value: mobile, desktop, tablet, non_smartphones */
|
|
59282
|
+
device?: string | undefined;
|
|
59283
|
+
/** aggregates the returned data to a certain time period
|
|
59284
|
+
optional field
|
|
59285
|
+
specify this field if you want to get the data in monthly, weekly or daily format
|
|
59286
|
+
possible values: monthly, weekly, daily
|
|
59287
|
+
monthly – returns data up to past 24 months
|
|
59288
|
+
weekly – returns data up to past 15 weeks
|
|
59289
|
+
daily – returns data up to past 45 days
|
|
59290
|
+
default value: monthly */
|
|
59291
|
+
period?: string | undefined;
|
|
59292
|
+
/** starting date of the time range
|
|
59293
|
+
optional field
|
|
59294
|
+
minimum value: two years back from today’s date
|
|
59295
|
+
maximum value: one day from today’s date
|
|
59296
|
+
date format: "yyyy-mm-dd"
|
|
59297
|
+
example:
|
|
59298
|
+
"2020-01-01"
|
|
59299
|
+
Note: we do not recommend using a custom time range
|
|
59300
|
+
Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
|
|
59301
|
+
if you specify the period parameter:
|
|
59302
|
+
with value weekly, you will get results for the past 15 weeks
|
|
59303
|
+
with value daily, you will get results for the past 45 days */
|
|
59304
|
+
date_from?: string | undefined;
|
|
59305
|
+
/** ending date of the time range
|
|
59306
|
+
optional field
|
|
59307
|
+
minimum value: two years back from today’s date;
|
|
59308
|
+
maximum value: one day from today’s date;
|
|
59309
|
+
date format: "yyyy-mm-dd"
|
|
59310
|
+
example:
|
|
59311
|
+
"2020-03-15"
|
|
59312
|
+
Note: we do not recommend using a custom time range
|
|
59313
|
+
Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
|
|
59314
|
+
if you specify the period parameter:
|
|
59315
|
+
with value weekly, you will get results for the past 15 weeks
|
|
59316
|
+
with value daily, you will get results for the past 45 days */
|
|
59317
|
+
date_to?: string | undefined;
|
|
59318
|
+
/** user-defined task identifier
|
|
59319
|
+
optional field
|
|
59320
|
+
the character limit is 255
|
|
59321
|
+
you can use this parameter to identify the task and match it with the result
|
|
59322
|
+
you will find the specified tag value in the data object of the response */
|
|
59323
|
+
tag?: string | undefined;
|
|
59324
|
+
[key: string]: any;
|
|
59325
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryLiveRequestInfo);
|
|
59326
|
+
init(_data?: any): void;
|
|
59327
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLiveRequestInfo;
|
|
59328
|
+
toJSON(data?: any): any;
|
|
59329
|
+
}
|
|
59330
|
+
export interface IKeywordsDataBingSearchVolumeHistoryLiveRequestInfo {
|
|
59331
|
+
/** keywords
|
|
59332
|
+
required field
|
|
59333
|
+
The maximum number of keywords you can specify: 1000
|
|
59334
|
+
The maximum number of characters for each keyword: 100
|
|
59335
|
+
the specified keywords will be converted to lowercase, data will be provided in a separate array */
|
|
59336
|
+
keywords?: string[];
|
|
59337
|
+
/** full name of search engine location
|
|
59338
|
+
required field if you don’t specify location_code or location_coordinate
|
|
59339
|
+
if you use this field, you don’t need to specify location_code or location_coordinate
|
|
59340
|
+
you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
|
|
59341
|
+
example:
|
|
59342
|
+
London,England,United Kingdom */
|
|
59343
|
+
location_name?: string | undefined;
|
|
59344
|
+
/** search engine location code
|
|
59345
|
+
required field if you don’t specify location_name or location_coordinate
|
|
59346
|
+
if you use this field, you don’t need to specify location_name or location_coordinate
|
|
59347
|
+
you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages
|
|
59348
|
+
example:
|
|
59349
|
+
2840 */
|
|
59350
|
+
location_code?: number | undefined;
|
|
59351
|
+
/** GPS coordinates of a location
|
|
59352
|
+
required field if you don’t specify location_name or location_code
|
|
59353
|
+
if you use this field, you don’t need to specify location_name or location_code
|
|
59354
|
+
location_coordinate parameter should be specified in the “latitude,longitude” format
|
|
59355
|
+
the data will be provided for the country the specified coordinates belong to
|
|
59356
|
+
example:
|
|
59357
|
+
52.6178549,-155.352142 */
|
|
59358
|
+
location_coordinate?: string | undefined;
|
|
59359
|
+
/** full name of search engine language
|
|
59360
|
+
required field if you don’t specify language_code
|
|
59361
|
+
if you use this field, you don’t need to specify language_code
|
|
59362
|
+
you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
|
|
59363
|
+
language_name?: string | undefined;
|
|
59364
|
+
/** search engine language code
|
|
59365
|
+
required field if you don’t specify language_name
|
|
59366
|
+
if you use this field, you don’t need to specify language_name
|
|
59367
|
+
you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages */
|
|
59368
|
+
language_code?: string | undefined;
|
|
59369
|
+
/** device type
|
|
59370
|
+
optional field
|
|
59371
|
+
specify this field if you want to get the data for a particular device type
|
|
59372
|
+
possible values: mobile, desktop, tablet, non_smartphones
|
|
59373
|
+
default value: mobile, desktop, tablet, non_smartphones */
|
|
59374
|
+
device?: string | undefined;
|
|
59375
|
+
/** aggregates the returned data to a certain time period
|
|
59376
|
+
optional field
|
|
59377
|
+
specify this field if you want to get the data in monthly, weekly or daily format
|
|
59378
|
+
possible values: monthly, weekly, daily
|
|
59379
|
+
monthly – returns data up to past 24 months
|
|
59380
|
+
weekly – returns data up to past 15 weeks
|
|
59381
|
+
daily – returns data up to past 45 days
|
|
59382
|
+
default value: monthly */
|
|
59383
|
+
period?: string | undefined;
|
|
59384
|
+
/** starting date of the time range
|
|
59385
|
+
optional field
|
|
59386
|
+
minimum value: two years back from today’s date
|
|
59387
|
+
maximum value: one day from today’s date
|
|
59388
|
+
date format: "yyyy-mm-dd"
|
|
59389
|
+
example:
|
|
59390
|
+
"2020-01-01"
|
|
59391
|
+
Note: we do not recommend using a custom time range
|
|
59392
|
+
Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
|
|
59393
|
+
if you specify the period parameter:
|
|
59394
|
+
with value weekly, you will get results for the past 15 weeks
|
|
59395
|
+
with value daily, you will get results for the past 45 days */
|
|
59396
|
+
date_from?: string | undefined;
|
|
59397
|
+
/** ending date of the time range
|
|
59398
|
+
optional field
|
|
59399
|
+
minimum value: two years back from today’s date;
|
|
59400
|
+
maximum value: one day from today’s date;
|
|
59401
|
+
date format: "yyyy-mm-dd"
|
|
59402
|
+
example:
|
|
59403
|
+
"2020-03-15"
|
|
59404
|
+
Note: we do not recommend using a custom time range
|
|
59405
|
+
Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months
|
|
59406
|
+
if you specify the period parameter:
|
|
59407
|
+
with value weekly, you will get results for the past 15 weeks
|
|
59408
|
+
with value daily, you will get results for the past 45 days */
|
|
59409
|
+
date_to?: string | undefined;
|
|
59410
|
+
/** user-defined task identifier
|
|
59411
|
+
optional field
|
|
59412
|
+
the character limit is 255
|
|
59413
|
+
you can use this parameter to identify the task and match it with the result
|
|
59414
|
+
you will find the specified tag value in the data object of the response */
|
|
59415
|
+
tag?: string | undefined;
|
|
59416
|
+
[key: string]: any;
|
|
59417
|
+
}
|
|
59418
|
+
export declare class KeywordsDataBingSearchVolumeHistoryLiveResultInfo implements IKeywordsDataBingSearchVolumeHistoryLiveResultInfo {
|
|
59419
|
+
/** keyword in a POST array */
|
|
59420
|
+
keyword?: string | undefined;
|
|
59421
|
+
/** location code in a POST array
|
|
59422
|
+
if there is no data, then the value is null */
|
|
59423
|
+
location_code?: number | undefined;
|
|
59424
|
+
/** language code in a POST array
|
|
59425
|
+
if there is no data, then the value is null */
|
|
59426
|
+
language_code?: string | undefined;
|
|
59427
|
+
device?: (string | undefined)[] | undefined;
|
|
59428
|
+
/** time period
|
|
59429
|
+
indicates if returned data is aggregated to a certain time period
|
|
59430
|
+
default value monthly */
|
|
59431
|
+
period?: string | undefined;
|
|
59432
|
+
/** contains results distributed by device type
|
|
59433
|
+
if the device parameter is not specified, the data will be returned for all available device types */
|
|
59434
|
+
searches?: SearchVolumeHistorySearchInfo | undefined;
|
|
59435
|
+
[key: string]: any;
|
|
59436
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryLiveResultInfo);
|
|
59437
|
+
init(_data?: any): void;
|
|
59438
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLiveResultInfo;
|
|
59439
|
+
toJSON(data?: any): any;
|
|
59440
|
+
}
|
|
59441
|
+
export interface IKeywordsDataBingSearchVolumeHistoryLiveResultInfo {
|
|
59442
|
+
/** keyword in a POST array */
|
|
59443
|
+
keyword?: string | undefined;
|
|
59444
|
+
/** location code in a POST array
|
|
59445
|
+
if there is no data, then the value is null */
|
|
59446
|
+
location_code?: number | undefined;
|
|
59447
|
+
/** language code in a POST array
|
|
59448
|
+
if there is no data, then the value is null */
|
|
59449
|
+
language_code?: string | undefined;
|
|
59450
|
+
device?: (string | undefined)[] | undefined;
|
|
59451
|
+
/** time period
|
|
59452
|
+
indicates if returned data is aggregated to a certain time period
|
|
59453
|
+
default value monthly */
|
|
59454
|
+
period?: string | undefined;
|
|
59455
|
+
/** contains results distributed by device type
|
|
59456
|
+
if the device parameter is not specified, the data will be returned for all available device types */
|
|
59457
|
+
searches?: SearchVolumeHistorySearchInfo | undefined;
|
|
59458
|
+
[key: string]: any;
|
|
59459
|
+
}
|
|
59460
|
+
export declare class KeywordsDataBingSearchVolumeHistoryLiveTaskInfo extends BaseResponseTaskInfo implements IKeywordsDataBingSearchVolumeHistoryLiveTaskInfo {
|
|
59461
|
+
/** array of results */
|
|
59462
|
+
result?: (KeywordsDataBingSearchVolumeHistoryLiveResultInfo | undefined)[] | undefined;
|
|
59463
|
+
[key: string]: any;
|
|
59464
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryLiveTaskInfo);
|
|
59465
|
+
init(_data?: any): void;
|
|
59466
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLiveTaskInfo;
|
|
59467
|
+
toJSON(data?: any): any;
|
|
59468
|
+
}
|
|
59469
|
+
export interface IKeywordsDataBingSearchVolumeHistoryLiveTaskInfo extends IBaseResponseTaskInfo {
|
|
59470
|
+
/** array of results */
|
|
59471
|
+
result?: (KeywordsDataBingSearchVolumeHistoryLiveResultInfo | undefined)[] | undefined;
|
|
59472
|
+
[key: string]: any;
|
|
59473
|
+
}
|
|
59474
|
+
export declare class KeywordsDataBingSearchVolumeHistoryLiveResponseInfo extends BaseResponseInfo implements IKeywordsDataBingSearchVolumeHistoryLiveResponseInfo {
|
|
59475
|
+
/** array of tasks */
|
|
59476
|
+
tasks?: (KeywordsDataBingSearchVolumeHistoryLiveTaskInfo | undefined)[] | undefined;
|
|
59477
|
+
[key: string]: any;
|
|
59478
|
+
constructor(data?: IKeywordsDataBingSearchVolumeHistoryLiveResponseInfo);
|
|
59479
|
+
init(_data?: any): void;
|
|
59480
|
+
static fromJS(data: any): KeywordsDataBingSearchVolumeHistoryLiveResponseInfo;
|
|
59481
|
+
toJSON(data?: any): any;
|
|
59482
|
+
}
|
|
59483
|
+
export interface IKeywordsDataBingSearchVolumeHistoryLiveResponseInfo extends IBaseResponseInfo {
|
|
59484
|
+
/** array of tasks */
|
|
59485
|
+
tasks?: (KeywordsDataBingSearchVolumeHistoryLiveTaskInfo | undefined)[] | undefined;
|
|
59486
|
+
[key: string]: any;
|
|
59487
|
+
}
|
|
58495
59488
|
export declare class BacklinksIdListRequestInfo implements IBacklinksIdListRequestInfo {
|
|
58496
59489
|
/** start time for filtering results
|
|
58497
59490
|
required field
|
|
@@ -59013,6 +60006,12 @@ if set to true, the results will include data on indirect links pointing to a pa
|
|
|
59013
60006
|
if set to false, indirect links will be ignored
|
|
59014
60007
|
default value: true */
|
|
59015
60008
|
include_indirect_links?: boolean | undefined;
|
|
60009
|
+
/** indicates if internal backlinks from subdomains to the target will be excluded from the results
|
|
60010
|
+
optional field
|
|
60011
|
+
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
|
|
60012
|
+
if set to false, internal links will be included in the results
|
|
60013
|
+
default value: true */
|
|
60014
|
+
exclude_internal_backlinks?: boolean | undefined;
|
|
59016
60015
|
/** maximum number of elements within internal arrays
|
|
59017
60016
|
optional field
|
|
59018
60017
|
you can use this field to limit the number of elements within the following arrays:
|
|
@@ -59070,6 +60069,12 @@ if set to true, the results will include data on indirect links pointing to a pa
|
|
|
59070
60069
|
if set to false, indirect links will be ignored
|
|
59071
60070
|
default value: true */
|
|
59072
60071
|
include_indirect_links?: boolean | undefined;
|
|
60072
|
+
/** indicates if internal backlinks from subdomains to the target will be excluded from the results
|
|
60073
|
+
optional field
|
|
60074
|
+
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
|
|
60075
|
+
if set to false, internal links will be included in the results
|
|
60076
|
+
default value: true */
|
|
60077
|
+
exclude_internal_backlinks?: boolean | undefined;
|
|
59073
60078
|
/** maximum number of elements within internal arrays
|
|
59074
60079
|
optional field
|
|
59075
60080
|
you can use this field to limit the number of elements within the following arrays:
|
|
@@ -59836,6 +60841,12 @@ if set to true, the results will include data on indirect links pointing to a pa
|
|
|
59836
60841
|
if set to false, indirect links will be ignored
|
|
59837
60842
|
default value: true */
|
|
59838
60843
|
include_indirect_links?: boolean | undefined;
|
|
60844
|
+
/** indicates if internal backlinks from subdomains to the target will be excluded from the results
|
|
60845
|
+
optional field
|
|
60846
|
+
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
|
|
60847
|
+
if set to false, internal links will be included in the results
|
|
60848
|
+
default value: true */
|
|
60849
|
+
exclude_internal_backlinks?: boolean | undefined;
|
|
59839
60850
|
/** user-defined task identifier
|
|
59840
60851
|
optional field
|
|
59841
60852
|
the character limit is 255
|
|
@@ -59958,6 +60969,12 @@ if set to true, the results will include data on indirect links pointing to a pa
|
|
|
59958
60969
|
if set to false, indirect links will be ignored
|
|
59959
60970
|
default value: true */
|
|
59960
60971
|
include_indirect_links?: boolean | undefined;
|
|
60972
|
+
/** indicates if internal backlinks from subdomains to the target will be excluded from the results
|
|
60973
|
+
optional field
|
|
60974
|
+
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
|
|
60975
|
+
if set to false, internal links will be included in the results
|
|
60976
|
+
default value: true */
|
|
60977
|
+
exclude_internal_backlinks?: boolean | undefined;
|
|
59961
60978
|
/** user-defined task identifier
|
|
59962
60979
|
optional field
|
|
59963
60980
|
the character limit is 255
|
|
@@ -60903,6 +61920,12 @@ optional field
|
|
|
60903
61920
|
if set to false, the subdomains will be ignored
|
|
60904
61921
|
default value: true */
|
|
60905
61922
|
include_subdomains?: boolean | undefined;
|
|
61923
|
+
/** indicates if internal backlinks from subdomains to the target will be excluded from the results
|
|
61924
|
+
optional field
|
|
61925
|
+
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
|
|
61926
|
+
if set to false, internal links will be included in the results
|
|
61927
|
+
default value: true */
|
|
61928
|
+
exclude_internal_backlinks?: boolean | undefined;
|
|
60906
61929
|
/** user-defined task identifier
|
|
60907
61930
|
optional field
|
|
60908
61931
|
the character limit is 255
|
|
@@ -60996,6 +62019,12 @@ optional field
|
|
|
60996
62019
|
if set to false, the subdomains will be ignored
|
|
60997
62020
|
default value: true */
|
|
60998
62021
|
include_subdomains?: boolean | undefined;
|
|
62022
|
+
/** indicates if internal backlinks from subdomains to the target will be excluded from the results
|
|
62023
|
+
optional field
|
|
62024
|
+
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
|
|
62025
|
+
if set to false, internal links will be included in the results
|
|
62026
|
+
default value: true */
|
|
62027
|
+
exclude_internal_backlinks?: boolean | undefined;
|
|
60999
62028
|
/** user-defined task identifier
|
|
61000
62029
|
optional field
|
|
61001
62030
|
the character limit is 255
|
|
@@ -62810,72 +63839,84 @@ optional field
|
|
|
62810
63839
|
if set to true, the results from the large domain (google.com, amazon.com, etc.) will be omitted;
|
|
62811
63840
|
default value: true */
|
|
62812
63841
|
exclude_large_domains?: boolean | undefined;
|
|
62813
|
-
/**
|
|
63842
|
+
/** indicates if internal backlinks from subdomains to the target will be excluded from the results
|
|
63843
|
+
optional field
|
|
63844
|
+
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
|
|
63845
|
+
if set to false, internal links will be included in the results
|
|
63846
|
+
default value: true */
|
|
63847
|
+
exclude_internal_backlinks?: boolean | undefined;
|
|
63848
|
+
/** user-defined task identifier
|
|
63849
|
+
optional field
|
|
63850
|
+
the character limit is 255
|
|
63851
|
+
you can use this parameter to identify the task and match it with the result
|
|
63852
|
+
you will find the specified tag value in the data object of the response */
|
|
63853
|
+
tag?: string | undefined;
|
|
63854
|
+
[key: string]: any;
|
|
63855
|
+
constructor(data?: IBacklinksCompetitorsLiveRequestInfo);
|
|
63856
|
+
init(_data?: any): void;
|
|
63857
|
+
static fromJS(data: any): BacklinksCompetitorsLiveRequestInfo;
|
|
63858
|
+
toJSON(data?: any): any;
|
|
63859
|
+
}
|
|
63860
|
+
export interface IBacklinksCompetitorsLiveRequestInfo {
|
|
63861
|
+
/** domain, subdomain or webpage to get competitor domains for
|
|
63862
|
+
required field
|
|
63863
|
+
a domain or a subdomain should be specified without https:// and www.
|
|
63864
|
+
a page should be specified with absolute URL (including http:// or https://) */
|
|
63865
|
+
target?: string;
|
|
63866
|
+
/** the maximum number of returned domains
|
|
63867
|
+
optional field
|
|
63868
|
+
default value: 100
|
|
63869
|
+
maximum value: 1000 */
|
|
63870
|
+
limit?: number | undefined;
|
|
63871
|
+
/** offset in the results array of returned domains
|
|
63872
|
+
optional field
|
|
63873
|
+
default value: 0
|
|
63874
|
+
if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages */
|
|
63875
|
+
offset?: number | undefined;
|
|
63876
|
+
/** array of results filtering parameters
|
|
63877
|
+
optional field
|
|
63878
|
+
you can add several filters at once (8 filters maximum)
|
|
63879
|
+
you should set a logical operator and, or between the conditions
|
|
63880
|
+
the following operators are supported:
|
|
63881
|
+
regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
|
|
63882
|
+
you can use the % operator with like and not_like to match any string of zero or more characters
|
|
63883
|
+
example:
|
|
63884
|
+
["rank",">","100"]
|
|
63885
|
+
[["target","like","%forbes%"],
|
|
63886
|
+
"and",
|
|
63887
|
+
[["rank",">","100"],"or",["intersections",">","5"]]]
|
|
63888
|
+
The full list of possible filters is available here. */
|
|
63889
|
+
filters?: (any | undefined)[] | undefined;
|
|
63890
|
+
/** results sorting rules
|
|
63891
|
+
optional field
|
|
63892
|
+
you can use the same values as in the filters array to sort the results
|
|
63893
|
+
possible sorting types:
|
|
63894
|
+
asc – results will be sorted in the ascending order
|
|
63895
|
+
desc – results will be sorted in the descending order
|
|
63896
|
+
you should use a comma to set up a sorting type
|
|
63897
|
+
example:
|
|
63898
|
+
["rank,desc"]
|
|
63899
|
+
note that you can set no more than three sorting rules in a single request
|
|
63900
|
+
you should use a comma to separate several sorting rules
|
|
63901
|
+
example:
|
|
63902
|
+
["intersections,desc","rank,asc"] */
|
|
63903
|
+
order_by?: string[] | undefined;
|
|
63904
|
+
/** indicates if only main domain of the target will be included in the search
|
|
63905
|
+
optional field
|
|
63906
|
+
if set to true, only the main domain will be included in search;
|
|
63907
|
+
default value: true */
|
|
63908
|
+
main_domain?: boolean | undefined;
|
|
63909
|
+
/** indicates whether large domain will appear in results
|
|
63910
|
+
optional field
|
|
63911
|
+
if set to true, the results from the large domain (google.com, amazon.com, etc.) will be omitted;
|
|
63912
|
+
default value: true */
|
|
63913
|
+
exclude_large_domains?: boolean | undefined;
|
|
63914
|
+
/** indicates if internal backlinks from subdomains to the target will be excluded from the results
|
|
62814
63915
|
optional field
|
|
62815
|
-
the
|
|
62816
|
-
|
|
62817
|
-
you will find the specified tag value in the data object of the response */
|
|
62818
|
-
tag?: string | undefined;
|
|
62819
|
-
[key: string]: any;
|
|
62820
|
-
constructor(data?: IBacklinksCompetitorsLiveRequestInfo);
|
|
62821
|
-
init(_data?: any): void;
|
|
62822
|
-
static fromJS(data: any): BacklinksCompetitorsLiveRequestInfo;
|
|
62823
|
-
toJSON(data?: any): any;
|
|
62824
|
-
}
|
|
62825
|
-
export interface IBacklinksCompetitorsLiveRequestInfo {
|
|
62826
|
-
/** domain, subdomain or webpage to get competitor domains for
|
|
62827
|
-
required field
|
|
62828
|
-
a domain or a subdomain should be specified without https:// and www.
|
|
62829
|
-
a page should be specified with absolute URL (including http:// or https://) */
|
|
62830
|
-
target?: string;
|
|
62831
|
-
/** the maximum number of returned domains
|
|
62832
|
-
optional field
|
|
62833
|
-
default value: 100
|
|
62834
|
-
maximum value: 1000 */
|
|
62835
|
-
limit?: number | undefined;
|
|
62836
|
-
/** offset in the results array of returned domains
|
|
62837
|
-
optional field
|
|
62838
|
-
default value: 0
|
|
62839
|
-
if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages */
|
|
62840
|
-
offset?: number | undefined;
|
|
62841
|
-
/** array of results filtering parameters
|
|
62842
|
-
optional field
|
|
62843
|
-
you can add several filters at once (8 filters maximum)
|
|
62844
|
-
you should set a logical operator and, or between the conditions
|
|
62845
|
-
the following operators are supported:
|
|
62846
|
-
regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
|
|
62847
|
-
you can use the % operator with like and not_like to match any string of zero or more characters
|
|
62848
|
-
example:
|
|
62849
|
-
["rank",">","100"]
|
|
62850
|
-
[["target","like","%forbes%"],
|
|
62851
|
-
"and",
|
|
62852
|
-
[["rank",">","100"],"or",["intersections",">","5"]]]
|
|
62853
|
-
The full list of possible filters is available here. */
|
|
62854
|
-
filters?: (any | undefined)[] | undefined;
|
|
62855
|
-
/** results sorting rules
|
|
62856
|
-
optional field
|
|
62857
|
-
you can use the same values as in the filters array to sort the results
|
|
62858
|
-
possible sorting types:
|
|
62859
|
-
asc – results will be sorted in the ascending order
|
|
62860
|
-
desc – results will be sorted in the descending order
|
|
62861
|
-
you should use a comma to set up a sorting type
|
|
62862
|
-
example:
|
|
62863
|
-
["rank,desc"]
|
|
62864
|
-
note that you can set no more than three sorting rules in a single request
|
|
62865
|
-
you should use a comma to separate several sorting rules
|
|
62866
|
-
example:
|
|
62867
|
-
["intersections,desc","rank,asc"] */
|
|
62868
|
-
order_by?: string[] | undefined;
|
|
62869
|
-
/** indicates if only main domain of the target will be included in the search
|
|
62870
|
-
optional field
|
|
62871
|
-
if set to true, only the main domain will be included in search;
|
|
62872
|
-
default value: true */
|
|
62873
|
-
main_domain?: boolean | undefined;
|
|
62874
|
-
/** indicates whether large domain will appear in results
|
|
62875
|
-
optional field
|
|
62876
|
-
if set to true, the results from the large domain (google.com, amazon.com, etc.) will be omitted;
|
|
63916
|
+
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
|
|
63917
|
+
if set to false, internal links will be included in the results
|
|
62877
63918
|
default value: true */
|
|
62878
|
-
|
|
63919
|
+
exclude_internal_backlinks?: boolean | undefined;
|
|
62879
63920
|
/** user-defined task identifier
|
|
62880
63921
|
optional field
|
|
62881
63922
|
the character limit is 255
|
|
@@ -63225,7 +64266,8 @@ export declare class BacklinksDomainIntersectionInfo implements IBacklinksDomain
|
|
|
63225
64266
|
type?: string | undefined;
|
|
63226
64267
|
/** domain that links to the corresponding target from the POST array */
|
|
63227
64268
|
target?: string | undefined;
|
|
63228
|
-
/** rank
|
|
64269
|
+
/** rank referred to the target from the POST array
|
|
64270
|
+
indicates the rank that the referring domain (target above) refers to your target from the POST array;
|
|
63229
64271
|
rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
|
|
63230
64272
|
learn more about the metric and how it is calculated in this help center article */
|
|
63231
64273
|
rank?: number | undefined;
|
|
@@ -63309,7 +64351,8 @@ export interface IBacklinksDomainIntersectionInfo {
|
|
|
63309
64351
|
type?: string | undefined;
|
|
63310
64352
|
/** domain that links to the corresponding target from the POST array */
|
|
63311
64353
|
target?: string | undefined;
|
|
63312
|
-
/** rank
|
|
64354
|
+
/** rank referred to the target from the POST array
|
|
64355
|
+
indicates the rank that the referring domain (target above) refers to your target from the POST array;
|
|
63313
64356
|
rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
|
|
63314
64357
|
learn more about the metric and how it is calculated in this help center article */
|
|
63315
64358
|
rank?: number | undefined;
|
|
@@ -63573,6 +64616,12 @@ if set to true, the results will include data on indirect links pointing to a pa
|
|
|
63573
64616
|
if set to false, indirect links will be ignored
|
|
63574
64617
|
default value: true */
|
|
63575
64618
|
include_indirect_links?: boolean | undefined;
|
|
64619
|
+
/** indicates if internal backlinks from subdomains to the target will be excluded from the results
|
|
64620
|
+
optional field
|
|
64621
|
+
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
|
|
64622
|
+
if set to false, internal links will be included in the result
|
|
64623
|
+
default value: true */
|
|
64624
|
+
exclude_internal_backlinks?: boolean | undefined;
|
|
63576
64625
|
/** indicates whether to intersect backlinks
|
|
63577
64626
|
optional field
|
|
63578
64627
|
use this field to intersect or merge results for the specified URLs
|
|
@@ -63686,6 +64735,12 @@ if set to true, the results will include data on indirect links pointing to a pa
|
|
|
63686
64735
|
if set to false, indirect links will be ignored
|
|
63687
64736
|
default value: true */
|
|
63688
64737
|
include_indirect_links?: boolean | undefined;
|
|
64738
|
+
/** indicates if internal backlinks from subdomains to the target will be excluded from the results
|
|
64739
|
+
optional field
|
|
64740
|
+
if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target
|
|
64741
|
+
if set to false, internal links will be included in the result
|
|
64742
|
+
default value: true */
|
|
64743
|
+
exclude_internal_backlinks?: boolean | undefined;
|
|
63689
64744
|
/** indicates whether to intersect backlinks
|
|
63690
64745
|
optional field
|
|
63691
64746
|
use this field to intersect or merge results for the specified URLs
|
|
@@ -63739,6 +64794,7 @@ page_from_rank is calculated based on the method for node ranking in a linked da
|
|
|
63739
64794
|
learn more about the metric and how it is calculated in this help center article */
|
|
63740
64795
|
page_from_rank?: number | undefined;
|
|
63741
64796
|
/** domain rank of the referring domain
|
|
64797
|
+
indicates the rank of the domain at the time our crawler last saw the backlink;
|
|
63742
64798
|
domain_from_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
|
|
63743
64799
|
learn more about the metric and how it is calculated in this help center article */
|
|
63744
64800
|
domain_from_rank?: number | undefined;
|
|
@@ -63888,6 +64944,7 @@ page_from_rank is calculated based on the method for node ranking in a linked da
|
|
|
63888
64944
|
learn more about the metric and how it is calculated in this help center article */
|
|
63889
64945
|
page_from_rank?: number | undefined;
|
|
63890
64946
|
/** domain rank of the referring domain
|
|
64947
|
+
indicates the rank of the domain at the time our crawler last saw the backlink;
|
|
63891
64948
|
domain_from_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
|
|
63892
64949
|
learn more about the metric and how it is calculated in this help center article */
|
|
63893
64950
|
domain_from_rank?: number | undefined;
|
|
@@ -64640,6 +65697,7 @@ export declare class BacklinksBulkRanksLiveItem implements IBacklinksBulkRanksLi
|
|
|
64640
65697
|
/** domain, subdomain or webpage from a POST array */
|
|
64641
65698
|
target?: string | undefined;
|
|
64642
65699
|
/** rank of the target
|
|
65700
|
+
values represent real-time data for the date of the request
|
|
64643
65701
|
rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
|
|
64644
65702
|
learn more about the metric and how it is calculated in this help center article */
|
|
64645
65703
|
rank?: number | undefined;
|
|
@@ -64653,6 +65711,7 @@ export interface IBacklinksBulkRanksLiveItem {
|
|
|
64653
65711
|
/** domain, subdomain or webpage from a POST array */
|
|
64654
65712
|
target?: string | undefined;
|
|
64655
65713
|
/** rank of the target
|
|
65714
|
+
values represent real-time data for the date of the request
|
|
64656
65715
|
rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
|
|
64657
65716
|
learn more about the metric and how it is calculated in this help center article */
|
|
64658
65717
|
rank?: number | undefined;
|
|
@@ -68038,7 +69097,7 @@ the amount of time a browser needs to complete downloading a resource */
|
|
|
68038
69097
|
fetch_end?: number | undefined;
|
|
68039
69098
|
[key: string]: any;
|
|
68040
69099
|
}
|
|
68041
|
-
export declare class
|
|
69100
|
+
export declare class StylesheetResourceElementItem extends BaseOnPageResourceItemInfo implements IStylesheetResourceElementItem {
|
|
68042
69101
|
/** resource properties
|
|
68043
69102
|
the value depends on the resource_type
|
|
68044
69103
|
note that if you do not indicate a url when setting a task, resource’s meta is returned based on the data from the page where our crawler first saw the resource;
|
|
@@ -68090,13 +69149,25 @@ any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, oth
|
|
|
68090
69149
|
/** contains data on changes related to the resource
|
|
68091
69150
|
if there is no data, the value will be null */
|
|
68092
69151
|
last_modified?: LastModified | undefined;
|
|
69152
|
+
/** resource initiator */
|
|
69153
|
+
initiator?: string | undefined;
|
|
69154
|
+
/** total time it takes until a browser receives a complete response from a server (in milliseconds) */
|
|
69155
|
+
duration_time?: number | undefined;
|
|
69156
|
+
/** time to start downloading the resource
|
|
69157
|
+
the amount of time the browser needs to start downloading a resource */
|
|
69158
|
+
fetch_start?: number | undefined;
|
|
69159
|
+
/** time to complete downloading the resource
|
|
69160
|
+
the amount of time the browser needs to complete downloading a resource */
|
|
69161
|
+
fetch_end?: number | undefined;
|
|
69162
|
+
/** indicates whether the resource blocks rendering */
|
|
69163
|
+
is_render_blocking?: boolean | undefined;
|
|
68093
69164
|
[key: string]: any;
|
|
68094
|
-
constructor(data?:
|
|
69165
|
+
constructor(data?: IStylesheetResourceElementItem);
|
|
68095
69166
|
init(_data?: any): void;
|
|
68096
|
-
static fromJS(data: any):
|
|
69167
|
+
static fromJS(data: any): StylesheetResourceElementItem;
|
|
68097
69168
|
toJSON(data?: any): any;
|
|
68098
69169
|
}
|
|
68099
|
-
export interface
|
|
69170
|
+
export interface IStylesheetResourceElementItem extends IBaseOnPageResourceItemInfo {
|
|
68100
69171
|
/** resource properties
|
|
68101
69172
|
the value depends on the resource_type
|
|
68102
69173
|
note that if you do not indicate a url when setting a task, resource’s meta is returned based on the data from the page where our crawler first saw the resource;
|
|
@@ -68148,9 +69219,67 @@ any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, oth
|
|
|
68148
69219
|
/** contains data on changes related to the resource
|
|
68149
69220
|
if there is no data, the value will be null */
|
|
68150
69221
|
last_modified?: LastModified | undefined;
|
|
69222
|
+
/** resource initiator */
|
|
69223
|
+
initiator?: string | undefined;
|
|
69224
|
+
/** total time it takes until a browser receives a complete response from a server (in milliseconds) */
|
|
69225
|
+
duration_time?: number | undefined;
|
|
69226
|
+
/** time to start downloading the resource
|
|
69227
|
+
the amount of time the browser needs to start downloading a resource */
|
|
69228
|
+
fetch_start?: number | undefined;
|
|
69229
|
+
/** time to complete downloading the resource
|
|
69230
|
+
the amount of time the browser needs to complete downloading a resource */
|
|
69231
|
+
fetch_end?: number | undefined;
|
|
69232
|
+
/** indicates whether the resource blocks rendering */
|
|
69233
|
+
is_render_blocking?: boolean | undefined;
|
|
68151
69234
|
[key: string]: any;
|
|
68152
69235
|
}
|
|
68153
|
-
export declare class
|
|
69236
|
+
export declare class OnPageResourcesResultInfo implements IOnPageResourcesResultInfo {
|
|
69237
|
+
/** status of the crawling session
|
|
69238
|
+
possible values: in_progress, finished */
|
|
69239
|
+
crawl_progress?: string | undefined;
|
|
69240
|
+
/** details of the crawling session */
|
|
69241
|
+
crawl_status?: CrawlStatusInfo | undefined;
|
|
69242
|
+
/** total number of relevant items crawled */
|
|
69243
|
+
total_items_count?: number | undefined;
|
|
69244
|
+
/** number of items in the results array */
|
|
69245
|
+
items_count?: number | undefined;
|
|
69246
|
+
/** items array */
|
|
69247
|
+
items?: (BaseOnPageResourceItemInfo | undefined)[] | undefined;
|
|
69248
|
+
[key: string]: any;
|
|
69249
|
+
constructor(data?: IOnPageResourcesResultInfo);
|
|
69250
|
+
init(_data?: any): void;
|
|
69251
|
+
static fromJS(data: any): OnPageResourcesResultInfo;
|
|
69252
|
+
toJSON(data?: any): any;
|
|
69253
|
+
}
|
|
69254
|
+
export interface IOnPageResourcesResultInfo {
|
|
69255
|
+
/** status of the crawling session
|
|
69256
|
+
possible values: in_progress, finished */
|
|
69257
|
+
crawl_progress?: string | undefined;
|
|
69258
|
+
/** details of the crawling session */
|
|
69259
|
+
crawl_status?: CrawlStatusInfo | undefined;
|
|
69260
|
+
/** total number of relevant items crawled */
|
|
69261
|
+
total_items_count?: number | undefined;
|
|
69262
|
+
/** number of items in the results array */
|
|
69263
|
+
items_count?: number | undefined;
|
|
69264
|
+
/** items array */
|
|
69265
|
+
items?: (BaseOnPageResourceItemInfo | undefined)[] | undefined;
|
|
69266
|
+
[key: string]: any;
|
|
69267
|
+
}
|
|
69268
|
+
export declare class OnPageResourcesTaskInfo extends BaseResponseTaskInfo implements IOnPageResourcesTaskInfo {
|
|
69269
|
+
/** array of results */
|
|
69270
|
+
result?: (OnPageResourcesResultInfo | undefined)[] | undefined;
|
|
69271
|
+
[key: string]: any;
|
|
69272
|
+
constructor(data?: IOnPageResourcesTaskInfo);
|
|
69273
|
+
init(_data?: any): void;
|
|
69274
|
+
static fromJS(data: any): OnPageResourcesTaskInfo;
|
|
69275
|
+
toJSON(data?: any): any;
|
|
69276
|
+
}
|
|
69277
|
+
export interface IOnPageResourcesTaskInfo extends IBaseResponseTaskInfo {
|
|
69278
|
+
/** array of results */
|
|
69279
|
+
result?: (OnPageResourcesResultInfo | undefined)[] | undefined;
|
|
69280
|
+
[key: string]: any;
|
|
69281
|
+
}
|
|
69282
|
+
export declare class ScriptResourceElementItem extends BaseOnPageResourceItemInfo implements IScriptResourceElementItem {
|
|
68154
69283
|
/** resource properties
|
|
68155
69284
|
the value depends on the resource_type
|
|
68156
69285
|
note that if you do not indicate a url when setting a task, resource’s meta is returned based on the data from the page where our crawler first saw the resource;
|
|
@@ -68186,8 +69315,6 @@ contents of the array depend on the resource_type */
|
|
|
68186
69315
|
checks?: {
|
|
68187
69316
|
[key: string]: boolean;
|
|
68188
69317
|
} | undefined;
|
|
68189
|
-
/** resource errors and warnings */
|
|
68190
|
-
resource_errors?: OnPageResourceIssueInfo | undefined;
|
|
68191
69318
|
/** type of encoding */
|
|
68192
69319
|
content_encoding?: string | undefined;
|
|
68193
69320
|
/** types of media used to display a resource */
|
|
@@ -68202,25 +69329,15 @@ any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, oth
|
|
|
68202
69329
|
/** contains data on changes related to the resource
|
|
68203
69330
|
if there is no data, the value will be null */
|
|
68204
69331
|
last_modified?: LastModified | undefined;
|
|
68205
|
-
/** resource
|
|
68206
|
-
|
|
68207
|
-
/** total time it takes until a browser receives a complete response from a server (in milliseconds) */
|
|
68208
|
-
duration_time?: number | undefined;
|
|
68209
|
-
/** time to start downloading the resource
|
|
68210
|
-
the amount of time the browser needs to start downloading a resource */
|
|
68211
|
-
fetch_start?: number | undefined;
|
|
68212
|
-
/** time to complete downloading the resource
|
|
68213
|
-
the amount of time the browser needs to complete downloading a resource */
|
|
68214
|
-
fetch_end?: number | undefined;
|
|
68215
|
-
/** indicates whether the resource blocks rendering */
|
|
68216
|
-
is_render_blocking?: boolean | undefined;
|
|
69332
|
+
/** resource errors and warnings */
|
|
69333
|
+
resource_errors?: OnPageResourceIssueInfo | undefined;
|
|
68217
69334
|
[key: string]: any;
|
|
68218
|
-
constructor(data?:
|
|
69335
|
+
constructor(data?: IScriptResourceElementItem);
|
|
68219
69336
|
init(_data?: any): void;
|
|
68220
|
-
static fromJS(data: any):
|
|
69337
|
+
static fromJS(data: any): ScriptResourceElementItem;
|
|
68221
69338
|
toJSON(data?: any): any;
|
|
68222
69339
|
}
|
|
68223
|
-
export interface
|
|
69340
|
+
export interface IScriptResourceElementItem extends IBaseOnPageResourceItemInfo {
|
|
68224
69341
|
/** resource properties
|
|
68225
69342
|
the value depends on the resource_type
|
|
68226
69343
|
note that if you do not indicate a url when setting a task, resource’s meta is returned based on the data from the page where our crawler first saw the resource;
|
|
@@ -68256,8 +69373,6 @@ contents of the array depend on the resource_type */
|
|
|
68256
69373
|
checks?: {
|
|
68257
69374
|
[key: string]: boolean;
|
|
68258
69375
|
} | undefined;
|
|
68259
|
-
/** resource errors and warnings */
|
|
68260
|
-
resource_errors?: OnPageResourceIssueInfo | undefined;
|
|
68261
69376
|
/** type of encoding */
|
|
68262
69377
|
content_encoding?: string | undefined;
|
|
68263
69378
|
/** types of media used to display a resource */
|
|
@@ -68272,64 +69387,8 @@ any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, oth
|
|
|
68272
69387
|
/** contains data on changes related to the resource
|
|
68273
69388
|
if there is no data, the value will be null */
|
|
68274
69389
|
last_modified?: LastModified | undefined;
|
|
68275
|
-
/** resource
|
|
68276
|
-
|
|
68277
|
-
/** total time it takes until a browser receives a complete response from a server (in milliseconds) */
|
|
68278
|
-
duration_time?: number | undefined;
|
|
68279
|
-
/** time to start downloading the resource
|
|
68280
|
-
the amount of time the browser needs to start downloading a resource */
|
|
68281
|
-
fetch_start?: number | undefined;
|
|
68282
|
-
/** time to complete downloading the resource
|
|
68283
|
-
the amount of time the browser needs to complete downloading a resource */
|
|
68284
|
-
fetch_end?: number | undefined;
|
|
68285
|
-
/** indicates whether the resource blocks rendering */
|
|
68286
|
-
is_render_blocking?: boolean | undefined;
|
|
68287
|
-
[key: string]: any;
|
|
68288
|
-
}
|
|
68289
|
-
export declare class OnPageResourcesResultInfo implements IOnPageResourcesResultInfo {
|
|
68290
|
-
/** status of the crawling session
|
|
68291
|
-
possible values: in_progress, finished */
|
|
68292
|
-
crawl_progress?: string | undefined;
|
|
68293
|
-
/** details of the crawling session */
|
|
68294
|
-
crawl_status?: CrawlStatusInfo | undefined;
|
|
68295
|
-
/** total number of relevant items crawled */
|
|
68296
|
-
total_items_count?: number | undefined;
|
|
68297
|
-
/** number of items in the results array */
|
|
68298
|
-
items_count?: number | undefined;
|
|
68299
|
-
/** items array */
|
|
68300
|
-
items?: (BaseOnPageResourceItemInfo | undefined)[] | undefined;
|
|
68301
|
-
[key: string]: any;
|
|
68302
|
-
constructor(data?: IOnPageResourcesResultInfo);
|
|
68303
|
-
init(_data?: any): void;
|
|
68304
|
-
static fromJS(data: any): OnPageResourcesResultInfo;
|
|
68305
|
-
toJSON(data?: any): any;
|
|
68306
|
-
}
|
|
68307
|
-
export interface IOnPageResourcesResultInfo {
|
|
68308
|
-
/** status of the crawling session
|
|
68309
|
-
possible values: in_progress, finished */
|
|
68310
|
-
crawl_progress?: string | undefined;
|
|
68311
|
-
/** details of the crawling session */
|
|
68312
|
-
crawl_status?: CrawlStatusInfo | undefined;
|
|
68313
|
-
/** total number of relevant items crawled */
|
|
68314
|
-
total_items_count?: number | undefined;
|
|
68315
|
-
/** number of items in the results array */
|
|
68316
|
-
items_count?: number | undefined;
|
|
68317
|
-
/** items array */
|
|
68318
|
-
items?: (BaseOnPageResourceItemInfo | undefined)[] | undefined;
|
|
68319
|
-
[key: string]: any;
|
|
68320
|
-
}
|
|
68321
|
-
export declare class OnPageResourcesTaskInfo extends BaseResponseTaskInfo implements IOnPageResourcesTaskInfo {
|
|
68322
|
-
/** array of results */
|
|
68323
|
-
result?: (OnPageResourcesResultInfo | undefined)[] | undefined;
|
|
68324
|
-
[key: string]: any;
|
|
68325
|
-
constructor(data?: IOnPageResourcesTaskInfo);
|
|
68326
|
-
init(_data?: any): void;
|
|
68327
|
-
static fromJS(data: any): OnPageResourcesTaskInfo;
|
|
68328
|
-
toJSON(data?: any): any;
|
|
68329
|
-
}
|
|
68330
|
-
export interface IOnPageResourcesTaskInfo extends IBaseResponseTaskInfo {
|
|
68331
|
-
/** array of results */
|
|
68332
|
-
result?: (OnPageResourcesResultInfo | undefined)[] | undefined;
|
|
69390
|
+
/** resource errors and warnings */
|
|
69391
|
+
resource_errors?: OnPageResourceIssueInfo | undefined;
|
|
68333
69392
|
[key: string]: any;
|
|
68334
69393
|
}
|
|
68335
69394
|
export declare class ImageResourceElementItem extends BaseOnPageResourceItemInfo implements IImageResourceElementItem {
|
|
@@ -87538,6 +88597,7 @@ optional field */
|
|
|
87538
88597
|
optional field
|
|
87539
88598
|
location_coordinate parameter should be specified in the “latitude,longitude,radius” format
|
|
87540
88599
|
the maximum number of decimal digits for “latitude” and “longitude”: 7
|
|
88600
|
+
the value of “radius” is specified in kilometres (km)
|
|
87541
88601
|
the minimum value for “radius”: 1
|
|
87542
88602
|
the maximum value for “radius”: 100000
|
|
87543
88603
|
example:
|
|
@@ -87621,6 +88681,7 @@ optional field */
|
|
|
87621
88681
|
optional field
|
|
87622
88682
|
location_coordinate parameter should be specified in the “latitude,longitude,radius” format
|
|
87623
88683
|
the maximum number of decimal digits for “latitude” and “longitude”: 7
|
|
88684
|
+
the value of “radius” is specified in kilometres (km)
|
|
87624
88685
|
the minimum value for “radius”: 1
|
|
87625
88686
|
the maximum value for “radius”: 100000
|
|
87626
88687
|
example:
|
|
@@ -89009,7 +90070,7 @@ example:
|
|
|
89009
90070
|
"birthday": 33
|
|
89010
90071
|
} */
|
|
89011
90072
|
place_topics?: {
|
|
89012
|
-
[key: string]:
|
|
90073
|
+
[key: string]: number;
|
|
89013
90074
|
} | undefined;
|
|
89014
90075
|
/** the element’s rating
|
|
89015
90076
|
the popularity rate based on reviews and displayed in SERP */
|
|
@@ -89129,7 +90190,7 @@ example:
|
|
|
89129
90190
|
"birthday": 33
|
|
89130
90191
|
} */
|
|
89131
90192
|
place_topics?: {
|
|
89132
|
-
[key: string]:
|
|
90193
|
+
[key: string]: number;
|
|
89133
90194
|
} | undefined;
|
|
89134
90195
|
/** the element’s rating
|
|
89135
90196
|
the popularity rate based on reviews and displayed in SERP */
|
|
@@ -94682,8 +95743,7 @@ export declare class BusinessDataTripadvisorReviewsTaskPostRequestInfo implement
|
|
|
94682
95743
|
/** URL path of the business entity
|
|
94683
95744
|
required field if you do not specify keyword
|
|
94684
95745
|
URL path to the Tripadvisor page of the business entity;
|
|
94685
|
-
|
|
94686
|
-
example:
|
|
95746
|
+
examples:
|
|
94687
95747
|
Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html
|
|
94688
95748
|
https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html */
|
|
94689
95749
|
url_path?: string | undefined;
|
|
@@ -94765,6 +95825,12 @@ possible types of sorting:
|
|
|
94765
95825
|
most_recent
|
|
94766
95826
|
detailed_reviews */
|
|
94767
95827
|
sort_by?: string | undefined;
|
|
95828
|
+
/** translate reviews according to the URL path
|
|
95829
|
+
optional field
|
|
95830
|
+
if set to true, returned reviews will be translated to the language matching the specified url_path;
|
|
95831
|
+
for example, if url_path contains tripadvisor.it and translate_reviews is true, reviews will be translated to the Italian language;
|
|
95832
|
+
default value: true */
|
|
95833
|
+
translate_reviews?: boolean | undefined;
|
|
94768
95834
|
/** user-defined task identifier
|
|
94769
95835
|
optional field
|
|
94770
95836
|
the character limit is 255
|
|
@@ -94801,8 +95867,7 @@ export interface IBusinessDataTripadvisorReviewsTaskPostRequestInfo {
|
|
|
94801
95867
|
/** URL path of the business entity
|
|
94802
95868
|
required field if you do not specify keyword
|
|
94803
95869
|
URL path to the Tripadvisor page of the business entity;
|
|
94804
|
-
|
|
94805
|
-
example:
|
|
95870
|
+
examples:
|
|
94806
95871
|
Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html
|
|
94807
95872
|
https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html */
|
|
94808
95873
|
url_path?: string | undefined;
|
|
@@ -94884,6 +95949,12 @@ possible types of sorting:
|
|
|
94884
95949
|
most_recent
|
|
94885
95950
|
detailed_reviews */
|
|
94886
95951
|
sort_by?: string | undefined;
|
|
95952
|
+
/** translate reviews according to the URL path
|
|
95953
|
+
optional field
|
|
95954
|
+
if set to true, returned reviews will be translated to the language matching the specified url_path;
|
|
95955
|
+
for example, if url_path contains tripadvisor.it and translate_reviews is true, reviews will be translated to the Italian language;
|
|
95956
|
+
default value: true */
|
|
95957
|
+
translate_reviews?: boolean | undefined;
|
|
94887
95958
|
/** user-defined task identifier
|
|
94888
95959
|
optional field
|
|
94889
95960
|
the character limit is 255
|
|
@@ -96916,8 +97987,8 @@ export interface IAppendixMerchantPriceData {
|
|
|
96916
97987
|
}
|
|
96917
97988
|
export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceDataInfo {
|
|
96918
97989
|
regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
96919
|
-
html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
96920
97990
|
advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
97991
|
+
html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
96921
97992
|
[key: string]: any;
|
|
96922
97993
|
constructor(data?: IAppendixSerpPriceDataInfo);
|
|
96923
97994
|
init(_data?: any): void;
|
|
@@ -96926,8 +97997,8 @@ export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceData
|
|
|
96926
97997
|
}
|
|
96927
97998
|
export interface IAppendixSerpPriceDataInfo {
|
|
96928
97999
|
regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
96929
|
-
html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
96930
98000
|
advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
98001
|
+
html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
96931
98002
|
[key: string]: any;
|
|
96932
98003
|
}
|
|
96933
98004
|
export declare class AppendixSerpPriceData implements IAppendixSerpPriceData {
|
|
@@ -97167,8 +98238,8 @@ export declare class AppendixBusinessDataPriceData implements IAppendixBusinessD
|
|
|
97167
98238
|
google?: AppendixGoogleBusinessDataPriceData | undefined;
|
|
97168
98239
|
languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
97169
98240
|
locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
97170
|
-
tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
97171
98241
|
trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
98242
|
+
tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
97172
98243
|
yelp?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
97173
98244
|
tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
97174
98245
|
[key: string]: any;
|
|
@@ -97184,8 +98255,8 @@ export interface IAppendixBusinessDataPriceData {
|
|
|
97184
98255
|
google?: AppendixGoogleBusinessDataPriceData | undefined;
|
|
97185
98256
|
languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
97186
98257
|
locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
97187
|
-
tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
97188
98258
|
trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
98259
|
+
tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
97189
98260
|
yelp?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
97190
98261
|
tasks_ready?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
97191
98262
|
[key: string]: any;
|