dataforseo-client 2.1.10 → 2.1.11
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/dist/cjs/api/AiOptimizationApi.js +54 -54
- package/dist/cjs/api/AppDataApi.js +42 -42
- package/dist/cjs/api/AppendixApi.js +4 -4
- package/dist/cjs/api/BacklinksApi.js +24 -24
- package/dist/cjs/api/BusinessDataApi.js +53 -53
- package/dist/cjs/api/ContentAnalysisApi.js +11 -11
- package/dist/cjs/api/DataforseoLabsApi.js +48 -48
- package/dist/cjs/api/DomainAnalyticsApi.js +14 -14
- package/dist/cjs/api/KeywordsDataApi.js +70 -70
- package/dist/cjs/api/MerchantApi.js +38 -38
- package/dist/cjs/api/OnPageApi.js +31 -31
- package/dist/cjs/api/SerpApi.js +176 -176
- package/dist/cjs/index.d.ts +16 -17
- package/dist/cjs/index.js +179 -181
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/models/AiOptimizationChatGptLlmResponsesLiveResultInfo.d.ts +5 -0
- package/dist/cjs/models/AiOptimizationChatGptLlmResponsesLiveResultInfo.js +16 -0
- package/dist/cjs/models/AiOptimizationChatGptLlmResponsesLiveResultInfo.js.map +1 -1
- package/dist/cjs/models/AiOptimizationChatGptLlmResponsesTaskGetResultInfo.d.ts +5 -0
- package/dist/cjs/models/AiOptimizationChatGptLlmResponsesTaskGetResultInfo.js +16 -0
- package/dist/cjs/models/AiOptimizationChatGptLlmResponsesTaskGetResultInfo.js.map +1 -1
- package/dist/cjs/models/AiOptimizationClaudeLlmResponsesLiveResultInfo.d.ts +5 -0
- package/dist/cjs/models/AiOptimizationClaudeLlmResponsesLiveResultInfo.js +16 -0
- package/dist/cjs/models/AiOptimizationClaudeLlmResponsesLiveResultInfo.js.map +1 -1
- package/dist/cjs/models/AiOptimizationClaudeLlmResponsesTaskGetResultInfo.d.ts +5 -0
- package/dist/cjs/models/AiOptimizationClaudeLlmResponsesTaskGetResultInfo.js +16 -0
- package/dist/cjs/models/AiOptimizationClaudeLlmResponsesTaskGetResultInfo.js.map +1 -1
- package/dist/cjs/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.d.ts +3 -3
- package/dist/cjs/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.js +2 -2
- package/dist/cjs/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.js.map +1 -1
- package/dist/cjs/models/AiOptimizationPerplexityLlmResponsesLiveResultInfo.d.ts +7 -2
- package/dist/cjs/models/AiOptimizationPerplexityLlmResponsesLiveResultInfo.js +16 -0
- package/dist/cjs/models/AiOptimizationPerplexityLlmResponsesLiveResultInfo.js.map +1 -1
- package/dist/cjs/models/AppendixMoneyData.d.ts +3 -3
- package/dist/cjs/models/AppendixMoneyData.js +3 -3
- package/dist/cjs/models/AppendixMoneyData.js.map +1 -1
- package/dist/cjs/models/AppendixRatesData.d.ts +3 -3
- package/dist/cjs/models/AppendixRatesData.js +3 -3
- package/dist/cjs/models/AppendixRatesData.js.map +1 -1
- package/dist/cjs/models/BacklinksDomainIntersection.d.ts +6 -2
- package/dist/cjs/models/BaseDataforseoLabsApiElementItem.d.ts +164 -156
- package/dist/cjs/models/BaseDataforseoLabsApiElementItem.js +92 -92
- package/dist/cjs/models/BaseDataforseoLabsApiElementItem.js.map +1 -1
- package/dist/cjs/models/BaseOnPageResourceItem.d.ts +2 -2
- package/dist/cjs/models/DataforseoLabsGooglePageIntersectionLiveRequestInfo.d.ts +2 -2
- package/dist/cjs/models/ItemsSearchResults.d.ts +38 -0
- package/dist/cjs/models/ItemsSearchResults.js +47 -0
- package/dist/cjs/models/ItemsSearchResults.js.map +1 -0
- package/dist/cjs/models/OnPageInstantPagesResultInfo.d.ts +3 -3
- package/dist/cjs/models/OnPageInstantPagesResultInfo.js +1 -1
- package/dist/cjs/models/SearchResults.d.ts +12 -24
- package/dist/cjs/models/SearchResults.js +4 -10
- package/dist/cjs/models/SearchResults.js.map +1 -1
- package/dist/cjs/models/SerpNaverOrganicTaskPostRequestInfo.d.ts +2 -2
- package/dist/cjs/models/SerpYahooOrganicLiveAdvancedRequestInfo.d.ts +38 -30
- package/dist/cjs/models/SerpYahooOrganicLiveAdvancedRequestInfo.js +4 -0
- package/dist/cjs/models/SerpYahooOrganicLiveAdvancedRequestInfo.js.map +1 -1
- package/dist/cjs/models/SerpYahooOrganicLiveAdvancedResponseInfo.d.ts +2 -2
- package/dist/cjs/models/SerpYahooOrganicLiveAdvancedResultInfo.d.ts +26 -26
- package/dist/cjs/models/SerpYahooOrganicLiveAdvancedTaskInfo.d.ts +2 -2
- package/dist/cjs/models/SerpYahooOrganicTaskGetAdvancedResponseInfo.d.ts +2 -2
- package/dist/cjs/models/SerpYahooOrganicTaskGetAdvancedResultInfo.d.ts +26 -26
- package/dist/cjs/models/SerpYahooOrganicTaskGetAdvancedTaskInfo.d.ts +2 -2
- package/dist/cjs/models/index.d.ts +16 -17
- package/dist/cjs/models/index.js +180 -182
- package/dist/cjs/models/index.js.map +1 -1
- package/dist/esm/api/AiOptimizationApi.js +54 -54
- package/dist/esm/api/AppDataApi.js +42 -42
- package/dist/esm/api/AppendixApi.js +4 -4
- package/dist/esm/api/BacklinksApi.js +24 -24
- package/dist/esm/api/BusinessDataApi.js +53 -53
- package/dist/esm/api/ContentAnalysisApi.js +11 -11
- package/dist/esm/api/DataforseoLabsApi.js +48 -48
- package/dist/esm/api/DomainAnalyticsApi.js +14 -14
- package/dist/esm/api/KeywordsDataApi.js +70 -70
- package/dist/esm/api/MerchantApi.js +38 -38
- package/dist/esm/api/OnPageApi.js +31 -31
- package/dist/esm/api/SerpApi.js +176 -176
- package/dist/esm/index.d.ts +16 -17
- package/dist/esm/index.js +16 -17
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/models/AiOptimizationChatGptLlmResponsesLiveResultInfo.d.ts +5 -0
- package/dist/esm/models/AiOptimizationChatGptLlmResponsesLiveResultInfo.js +16 -0
- package/dist/esm/models/AiOptimizationChatGptLlmResponsesLiveResultInfo.js.map +1 -1
- package/dist/esm/models/AiOptimizationChatGptLlmResponsesTaskGetResultInfo.d.ts +5 -0
- package/dist/esm/models/AiOptimizationChatGptLlmResponsesTaskGetResultInfo.js +16 -0
- package/dist/esm/models/AiOptimizationChatGptLlmResponsesTaskGetResultInfo.js.map +1 -1
- package/dist/esm/models/AiOptimizationClaudeLlmResponsesLiveResultInfo.d.ts +5 -0
- package/dist/esm/models/AiOptimizationClaudeLlmResponsesLiveResultInfo.js +16 -0
- package/dist/esm/models/AiOptimizationClaudeLlmResponsesLiveResultInfo.js.map +1 -1
- package/dist/esm/models/AiOptimizationClaudeLlmResponsesTaskGetResultInfo.d.ts +5 -0
- package/dist/esm/models/AiOptimizationClaudeLlmResponsesTaskGetResultInfo.js +16 -0
- package/dist/esm/models/AiOptimizationClaudeLlmResponsesTaskGetResultInfo.js.map +1 -1
- package/dist/esm/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.d.ts +3 -3
- package/dist/esm/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.js +2 -2
- package/dist/esm/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.js.map +1 -1
- package/dist/esm/models/AiOptimizationPerplexityLlmResponsesLiveResultInfo.d.ts +7 -2
- package/dist/esm/models/AiOptimizationPerplexityLlmResponsesLiveResultInfo.js +16 -0
- package/dist/esm/models/AiOptimizationPerplexityLlmResponsesLiveResultInfo.js.map +1 -1
- package/dist/esm/models/AppendixMoneyData.d.ts +3 -3
- package/dist/esm/models/AppendixMoneyData.js +3 -3
- package/dist/esm/models/AppendixMoneyData.js.map +1 -1
- package/dist/esm/models/AppendixRatesData.d.ts +3 -3
- package/dist/esm/models/AppendixRatesData.js +3 -3
- package/dist/esm/models/AppendixRatesData.js.map +1 -1
- package/dist/esm/models/BacklinksDomainIntersection.d.ts +6 -2
- package/dist/esm/models/BaseDataforseoLabsApiElementItem.d.ts +164 -156
- package/dist/esm/models/BaseDataforseoLabsApiElementItem.js +88 -88
- package/dist/esm/models/BaseDataforseoLabsApiElementItem.js.map +1 -1
- package/dist/esm/models/BaseOnPageResourceItem.d.ts +2 -2
- package/dist/esm/models/DataforseoLabsGooglePageIntersectionLiveRequestInfo.d.ts +2 -2
- package/dist/esm/models/ItemsSearchResults.d.ts +38 -0
- package/dist/esm/models/ItemsSearchResults.js +43 -0
- package/dist/esm/models/ItemsSearchResults.js.map +1 -0
- package/dist/esm/models/OnPageInstantPagesResultInfo.d.ts +3 -3
- package/dist/esm/models/OnPageInstantPagesResultInfo.js +2 -2
- package/dist/esm/models/SearchResults.d.ts +12 -24
- package/dist/esm/models/SearchResults.js +4 -10
- package/dist/esm/models/SearchResults.js.map +1 -1
- package/dist/esm/models/SerpNaverOrganicTaskPostRequestInfo.d.ts +2 -2
- package/dist/esm/models/SerpYahooOrganicLiveAdvancedRequestInfo.d.ts +38 -30
- package/dist/esm/models/SerpYahooOrganicLiveAdvancedRequestInfo.js +4 -0
- package/dist/esm/models/SerpYahooOrganicLiveAdvancedRequestInfo.js.map +1 -1
- package/dist/esm/models/SerpYahooOrganicLiveAdvancedResponseInfo.d.ts +2 -2
- package/dist/esm/models/SerpYahooOrganicLiveAdvancedResultInfo.d.ts +26 -26
- package/dist/esm/models/SerpYahooOrganicLiveAdvancedTaskInfo.d.ts +2 -2
- package/dist/esm/models/SerpYahooOrganicTaskGetAdvancedResponseInfo.d.ts +2 -2
- package/dist/esm/models/SerpYahooOrganicTaskGetAdvancedResultInfo.d.ts +26 -26
- package/dist/esm/models/SerpYahooOrganicTaskGetAdvancedTaskInfo.d.ts +2 -2
- package/dist/esm/models/index.d.ts +16 -17
- package/dist/esm/models/index.js +16 -17
- package/dist/esm/models/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { RatingInfo } from "./RatingInfo";
|
|
2
2
|
import { RankChanges } from "./RankChanges";
|
|
3
3
|
import { BacklinksInfo } from "./BacklinksInfo";
|
|
4
4
|
import { RankInfo } from "./RankInfo";
|
|
5
5
|
import { Table } from "./Table";
|
|
6
|
-
import { RatingInfo } from "./RatingInfo";
|
|
7
6
|
import { LinkElement } from "./LinkElement";
|
|
8
7
|
import { AboutThisResultElement } from "./AboutThisResultElement";
|
|
8
|
+
import { AdLinkElement } from "./AdLinkElement";
|
|
9
9
|
import { DataforseoLabsCarouselElement } from "./DataforseoLabsCarouselElement";
|
|
10
10
|
import { MultiCarouselElement } from "./MultiCarouselElement";
|
|
11
11
|
import { GoogleFlightsElement } from "./GoogleFlightsElement";
|
|
@@ -71,28 +71,21 @@ export declare class BaseDataforseoLabsApiElementItem implements IBaseDataforseo
|
|
|
71
71
|
static fromJS(data: any): BaseDataforseoLabsApiElementItem;
|
|
72
72
|
toJSON(data?: any): any;
|
|
73
73
|
}
|
|
74
|
-
export interface
|
|
74
|
+
export interface IDataLabsLocalPackSerpElementItem extends IBaseDataforseoLabsApiElementItem {
|
|
75
75
|
/** *title of the result in SERP* */
|
|
76
76
|
title?: string | undefined;
|
|
77
|
-
/** *subdomain in SERP* */
|
|
78
|
-
domain?: string | undefined;
|
|
79
77
|
/** *description of the results element in SERP* */
|
|
80
78
|
description?: string | undefined;
|
|
81
|
-
/** *
|
|
82
|
-
|
|
79
|
+
/** *subdomain in SERP* */
|
|
80
|
+
domain?: string | undefined;
|
|
81
|
+
/** *phone number* */
|
|
82
|
+
phone?: string | undefined;
|
|
83
83
|
/** *relevant URL in SERP* */
|
|
84
84
|
url?: string | undefined;
|
|
85
|
-
/** *
|
|
86
|
-
|
|
87
|
-
/** *
|
|
88
|
-
|
|
89
|
-
extra?: {
|
|
90
|
-
[key: string]: string;
|
|
91
|
-
} | undefined;
|
|
92
|
-
/** *extended description* if there is none, equals `null` */
|
|
93
|
-
description_rows?: string[] | undefined;
|
|
94
|
-
/** *sitelinks* the links shown below some of Google's search results if there are none, equals `null` */
|
|
95
|
-
links?: AdLinkElement[] | undefined;
|
|
85
|
+
/** *indicates whether the element is an ad* */
|
|
86
|
+
is_paid?: boolean | undefined;
|
|
87
|
+
/** *the item's rating* the popularity rate based on reviews and displayed in SERP */
|
|
88
|
+
rating?: RatingInfo | undefined;
|
|
96
89
|
/** *primary domain name in SERP* */
|
|
97
90
|
main_domain?: string | undefined;
|
|
98
91
|
/** *URL in SERP that does not specify the HTTPs protocol and domain name* */
|
|
@@ -111,28 +104,21 @@ export interface IDataLabsPaidSerpElementItem extends IBaseDataforseoLabsApiElem
|
|
|
111
104
|
rank_info?: RankInfo | undefined;
|
|
112
105
|
[key: string]: any;
|
|
113
106
|
}
|
|
114
|
-
export declare class
|
|
107
|
+
export declare class DataLabsLocalPackSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsLocalPackSerpElementItem {
|
|
115
108
|
/** *title of the result in SERP* */
|
|
116
109
|
title?: string | undefined;
|
|
117
|
-
/** *subdomain in SERP* */
|
|
118
|
-
domain?: string | undefined;
|
|
119
110
|
/** *description of the results element in SERP* */
|
|
120
111
|
description?: string | undefined;
|
|
121
|
-
/** *
|
|
122
|
-
|
|
112
|
+
/** *subdomain in SERP* */
|
|
113
|
+
domain?: string | undefined;
|
|
114
|
+
/** *phone number* */
|
|
115
|
+
phone?: string | undefined;
|
|
123
116
|
/** *relevant URL in SERP* */
|
|
124
117
|
url?: string | undefined;
|
|
125
|
-
/** *
|
|
126
|
-
|
|
127
|
-
/** *
|
|
128
|
-
|
|
129
|
-
extra?: {
|
|
130
|
-
[key: string]: string;
|
|
131
|
-
} | undefined;
|
|
132
|
-
/** *extended description* if there is none, equals `null` */
|
|
133
|
-
description_rows?: string[] | undefined;
|
|
134
|
-
/** *sitelinks* the links shown below some of Google's search results if there are none, equals `null` */
|
|
135
|
-
links?: AdLinkElement[] | undefined;
|
|
118
|
+
/** *indicates whether the element is an ad* */
|
|
119
|
+
is_paid?: boolean | undefined;
|
|
120
|
+
/** *the item's rating* the popularity rate based on reviews and displayed in SERP */
|
|
121
|
+
rating?: RatingInfo | undefined;
|
|
136
122
|
/** *primary domain name in SERP* */
|
|
137
123
|
main_domain?: string | undefined;
|
|
138
124
|
/** *URL in SERP that does not specify the HTTPs protocol and domain name* */
|
|
@@ -150,70 +136,70 @@ export declare class DataLabsPaidSerpElementItem extends BaseDataforseoLabsApiEl
|
|
|
150
136
|
/** *page and domain rank information* */
|
|
151
137
|
rank_info?: RankInfo | undefined;
|
|
152
138
|
[key: string]: any;
|
|
153
|
-
constructor(data?:
|
|
139
|
+
constructor(data?: IDataLabsLocalPackSerpElementItem);
|
|
154
140
|
init(data?: any): void;
|
|
155
|
-
static fromJS(data: any):
|
|
141
|
+
static fromJS(data: any): DataLabsLocalPackSerpElementItem;
|
|
156
142
|
toJSON(data?: any): any;
|
|
157
143
|
}
|
|
158
144
|
export interface IDataLabsFeaturedSnippetSerpElementItem extends IBaseDataforseoLabsApiElementItem {
|
|
159
|
-
/** subdomain in SERP */
|
|
145
|
+
/** *subdomain in SERP* */
|
|
160
146
|
domain?: string | undefined;
|
|
161
|
-
/** title of the result in SERP */
|
|
147
|
+
/** *title of the result in SERP* */
|
|
162
148
|
title?: string | undefined;
|
|
163
|
-
/** the title of the featured snippets source page */
|
|
149
|
+
/** *the title of the featured snippets source page* */
|
|
164
150
|
featured_title?: string | undefined;
|
|
165
|
-
/** description of the results element in SERP */
|
|
151
|
+
/** *description of the results element in SERP* */
|
|
166
152
|
description?: string | undefined;
|
|
167
|
-
/** relevant URL in SERP */
|
|
153
|
+
/** *relevant URL in SERP* */
|
|
168
154
|
url?: string | undefined;
|
|
169
|
-
/** results table
|
|
155
|
+
/** *results table* if there are none, equals `null` */
|
|
170
156
|
table?: Table | undefined;
|
|
171
|
-
/** primary domain name in SERP */
|
|
157
|
+
/** *primary domain name in SERP* */
|
|
172
158
|
main_domain?: string | undefined;
|
|
173
|
-
/** URL in SERP that does not specify the HTTPs protocol and domain name */
|
|
159
|
+
/** *URL in SERP that does not specify the HTTPs protocol and domain name* */
|
|
174
160
|
relative_url?: string | undefined;
|
|
175
|
-
/** estimated traffic volume
|
|
161
|
+
/** *estimated traffic volume* estimated organic monthly traffic to the domain or webpage; calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain or webpage rank for; learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-etv-calculated) */
|
|
176
162
|
etv?: number | undefined;
|
|
177
|
-
/** estimated cost of
|
|
163
|
+
/** *estimated cost of converting organic search traffic into paid* represents the estimated monthly cost of running ads for all keywords that a domain or webpage ranks for; the metric is calculated as the product of organic `etv` and paid `cpc` values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search; learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-traffic-cost-calculated) */
|
|
178
164
|
estimated_paid_traffic_cost?: number | undefined;
|
|
179
|
-
/** estimated traffic volume based on clickstream data
|
|
165
|
+
/** *estimated traffic volume based on clickstream data* calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain or webpage ranks for; to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true`; learn more about how the metric is calculated in this [help center article](https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated) */
|
|
180
166
|
clickstream_etv?: number | undefined;
|
|
181
|
-
/** changes in rankings
|
|
167
|
+
/** *changes in rankings* contains information about the ranking changes of the SERP element since the `previous_updated_time` */
|
|
182
168
|
rank_changes?: RankChanges | undefined;
|
|
183
|
-
/** backlinks information for the
|
|
169
|
+
/** *backlinks information for the relevant page URL* */
|
|
184
170
|
backlinks_info?: BacklinksInfo | undefined;
|
|
185
|
-
/** page and domain rank information */
|
|
171
|
+
/** *page and domain rank information* */
|
|
186
172
|
rank_info?: RankInfo | undefined;
|
|
187
173
|
[key: string]: any;
|
|
188
174
|
}
|
|
189
175
|
export declare class DataLabsFeaturedSnippetSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsFeaturedSnippetSerpElementItem {
|
|
190
|
-
/** subdomain in SERP */
|
|
176
|
+
/** *subdomain in SERP* */
|
|
191
177
|
domain?: string | undefined;
|
|
192
|
-
/** title of the result in SERP */
|
|
178
|
+
/** *title of the result in SERP* */
|
|
193
179
|
title?: string | undefined;
|
|
194
|
-
/** the title of the featured snippets source page */
|
|
180
|
+
/** *the title of the featured snippets source page* */
|
|
195
181
|
featured_title?: string | undefined;
|
|
196
|
-
/** description of the results element in SERP */
|
|
182
|
+
/** *description of the results element in SERP* */
|
|
197
183
|
description?: string | undefined;
|
|
198
|
-
/** relevant URL in SERP */
|
|
184
|
+
/** *relevant URL in SERP* */
|
|
199
185
|
url?: string | undefined;
|
|
200
|
-
/** results table
|
|
186
|
+
/** *results table* if there are none, equals `null` */
|
|
201
187
|
table?: Table | undefined;
|
|
202
|
-
/** primary domain name in SERP */
|
|
188
|
+
/** *primary domain name in SERP* */
|
|
203
189
|
main_domain?: string | undefined;
|
|
204
|
-
/** URL in SERP that does not specify the HTTPs protocol and domain name */
|
|
190
|
+
/** *URL in SERP that does not specify the HTTPs protocol and domain name* */
|
|
205
191
|
relative_url?: string | undefined;
|
|
206
|
-
/** estimated traffic volume
|
|
192
|
+
/** *estimated traffic volume* estimated organic monthly traffic to the domain or webpage; calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain or webpage rank for; learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-etv-calculated) */
|
|
207
193
|
etv?: number | undefined;
|
|
208
|
-
/** estimated cost of
|
|
194
|
+
/** *estimated cost of converting organic search traffic into paid* represents the estimated monthly cost of running ads for all keywords that a domain or webpage ranks for; the metric is calculated as the product of organic `etv` and paid `cpc` values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search; learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-traffic-cost-calculated) */
|
|
209
195
|
estimated_paid_traffic_cost?: number | undefined;
|
|
210
|
-
/** estimated traffic volume based on clickstream data
|
|
196
|
+
/** *estimated traffic volume based on clickstream data* calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain or webpage ranks for; to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true`; learn more about how the metric is calculated in this [help center article](https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated) */
|
|
211
197
|
clickstream_etv?: number | undefined;
|
|
212
|
-
/** changes in rankings
|
|
198
|
+
/** *changes in rankings* contains information about the ranking changes of the SERP element since the `previous_updated_time` */
|
|
213
199
|
rank_changes?: RankChanges | undefined;
|
|
214
|
-
/** backlinks information for the
|
|
200
|
+
/** *backlinks information for the relevant page URL* */
|
|
215
201
|
backlinks_info?: BacklinksInfo | undefined;
|
|
216
|
-
/** page and domain rank information */
|
|
202
|
+
/** *page and domain rank information* */
|
|
217
203
|
rank_info?: RankInfo | undefined;
|
|
218
204
|
[key: string]: any;
|
|
219
205
|
constructor(data?: IDataLabsFeaturedSnippetSerpElementItem);
|
|
@@ -221,109 +207,142 @@ export declare class DataLabsFeaturedSnippetSerpElementItem extends BaseDatafors
|
|
|
221
207
|
static fromJS(data: any): DataLabsFeaturedSnippetSerpElementItem;
|
|
222
208
|
toJSON(data?: any): any;
|
|
223
209
|
}
|
|
224
|
-
export interface
|
|
225
|
-
/**
|
|
226
|
-
title?: string | undefined;
|
|
227
|
-
/** description of the results element in SERP */
|
|
228
|
-
description?: string | undefined;
|
|
229
|
-
/** subdomain in SERP */
|
|
210
|
+
export interface IDataLabsOrganicSerpElementItem extends IBaseDataforseoLabsApiElementItem {
|
|
211
|
+
/** *subdomain in SERP* */
|
|
230
212
|
domain?: string | undefined;
|
|
231
|
-
/**
|
|
232
|
-
|
|
233
|
-
/** relevant URL in SERP */
|
|
213
|
+
/** *title of the result in SERP* */
|
|
214
|
+
title?: string | undefined;
|
|
215
|
+
/** *relevant URL in SERP* */
|
|
234
216
|
url?: string | undefined;
|
|
235
|
-
/**
|
|
236
|
-
|
|
237
|
-
/**
|
|
217
|
+
/** *breadcrumb in SERP* */
|
|
218
|
+
breadcrumb?: string | undefined;
|
|
219
|
+
/** *relevant website name in SERP* */
|
|
220
|
+
website_name?: string | undefined;
|
|
221
|
+
/** *indicates whether the element contains an `image`* **Note:** this check no longer appears in SERP */
|
|
222
|
+
is_image?: boolean | undefined;
|
|
223
|
+
/** *indicates whether the element contains a `video`* **Note:** this check no longer appears in SERP */
|
|
224
|
+
is_video?: boolean | undefined;
|
|
225
|
+
/** *indicates whether the element is a `featured_snippet`* **Note:** this check no longer appears in SERP */
|
|
226
|
+
is_featured_snippet?: boolean | undefined;
|
|
227
|
+
/** *indicates whether the element is marked as malicious* **Note:** this check no longer appears in SERP */
|
|
228
|
+
is_malicious?: boolean | undefined;
|
|
229
|
+
/** *array of properties detected for the SERP element* lists the properties that are true for this element each value in the array represents a detected property example: if `is_image` is present in the array, the element contains an image possible values in the array: `is_image`, `is_video`, `is_featured_snippet`, `amp_version`, `is_malicious`, `is_web_story`, `is_highly_cited` equals `null` if none of the properties are detected for the element learn more about the `checks` array in [this Help Center article](https://dataforseo.com/help-center/whats-a-checks-array-in-the-google-organic-serp-api) */
|
|
230
|
+
checks?: string[] | undefined;
|
|
231
|
+
/** *description of the results element in SERP* */
|
|
232
|
+
description?: string | undefined;
|
|
233
|
+
/** *includes additional information appended before the result description in SERP* */
|
|
234
|
+
pre_snippet?: string | undefined;
|
|
235
|
+
/** *includes additional information appended after the result description in SERP* */
|
|
236
|
+
extended_snippet?: string | undefined;
|
|
237
|
+
/** *Accelerated Mobile Pages* indicates whether an item has the Accelerated Mobile Page (AMP) version **Note:** this check no longer appears in SERP */
|
|
238
|
+
amp_version?: boolean | undefined;
|
|
239
|
+
/** *the item's rating* the popularity rate based on reviews and displayed in SERP */
|
|
238
240
|
rating?: RatingInfo | undefined;
|
|
239
|
-
/**
|
|
241
|
+
/** *words highlighted in bold within the results `description`* */
|
|
242
|
+
highlighted?: string[] | undefined;
|
|
243
|
+
/** *sitelinks* the links shown below some of Google's search results if there are none, equals `null` */
|
|
244
|
+
links?: LinkElement[] | undefined;
|
|
245
|
+
/** @deprecated *contains information from the 'About this result' panel* ['About this result' panel](https://blog.google/products/search/learn-more-and-get-more-from-search/) provides additional context about why Google returned this result for the given query; this feature appears after clicking on the three dots next to most results */
|
|
246
|
+
about_this_result?: AboutThisResultElement | undefined;
|
|
247
|
+
/** *primary domain name in SERP* */
|
|
240
248
|
main_domain?: string | undefined;
|
|
241
|
-
/** URL in SERP that does not specify the HTTPs protocol and domain name */
|
|
249
|
+
/** *URL in SERP that does not specify the HTTPs protocol and domain name* */
|
|
242
250
|
relative_url?: string | undefined;
|
|
243
|
-
/** estimated traffic volume
|
|
251
|
+
/** *estimated traffic volume* estimated organic monthly traffic to the domain or webpage; calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain or webpage rank for; learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-etv-calculated) */
|
|
244
252
|
etv?: number | undefined;
|
|
245
|
-
/** estimated cost of
|
|
253
|
+
/** *estimated cost of converting organic search traffic into paid* represents the estimated monthly cost of running ads for all keywords that a domain or webpage ranks for; the metric is calculated as the product of organic `etv` and paid `cpc` values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search; learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-traffic-cost-calculated) */
|
|
246
254
|
estimated_paid_traffic_cost?: number | undefined;
|
|
247
|
-
/** estimated traffic volume based on clickstream data
|
|
255
|
+
/** *estimated traffic volume based on clickstream data* calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain or webpage ranks for; to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true`; learn more about how the metric is calculated in this [help center article](https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated) */
|
|
248
256
|
clickstream_etv?: number | undefined;
|
|
249
|
-
/** changes in rankings
|
|
257
|
+
/** *changes in rankings* contains information about the ranking changes of the SERP element since the `previous_updated_time` */
|
|
250
258
|
rank_changes?: RankChanges | undefined;
|
|
251
|
-
/** backlinks information for the
|
|
259
|
+
/** *backlinks information for the relevant page URL* */
|
|
252
260
|
backlinks_info?: BacklinksInfo | undefined;
|
|
253
|
-
/** page and domain rank information */
|
|
261
|
+
/** *page and domain rank information* */
|
|
254
262
|
rank_info?: RankInfo | undefined;
|
|
255
263
|
[key: string]: any;
|
|
256
264
|
}
|
|
257
|
-
export declare class
|
|
258
|
-
/**
|
|
259
|
-
title?: string | undefined;
|
|
260
|
-
/** description of the results element in SERP */
|
|
261
|
-
description?: string | undefined;
|
|
262
|
-
/** subdomain in SERP */
|
|
265
|
+
export declare class DataLabsOrganicSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsOrganicSerpElementItem {
|
|
266
|
+
/** *subdomain in SERP* */
|
|
263
267
|
domain?: string | undefined;
|
|
264
|
-
/**
|
|
265
|
-
|
|
266
|
-
/** relevant URL in SERP */
|
|
268
|
+
/** *title of the result in SERP* */
|
|
269
|
+
title?: string | undefined;
|
|
270
|
+
/** *relevant URL in SERP* */
|
|
267
271
|
url?: string | undefined;
|
|
268
|
-
/**
|
|
269
|
-
|
|
270
|
-
/**
|
|
272
|
+
/** *breadcrumb in SERP* */
|
|
273
|
+
breadcrumb?: string | undefined;
|
|
274
|
+
/** *relevant website name in SERP* */
|
|
275
|
+
website_name?: string | undefined;
|
|
276
|
+
/** *indicates whether the element contains an `image`* **Note:** this check no longer appears in SERP */
|
|
277
|
+
is_image?: boolean | undefined;
|
|
278
|
+
/** *indicates whether the element contains a `video`* **Note:** this check no longer appears in SERP */
|
|
279
|
+
is_video?: boolean | undefined;
|
|
280
|
+
/** *indicates whether the element is a `featured_snippet`* **Note:** this check no longer appears in SERP */
|
|
281
|
+
is_featured_snippet?: boolean | undefined;
|
|
282
|
+
/** *indicates whether the element is marked as malicious* **Note:** this check no longer appears in SERP */
|
|
283
|
+
is_malicious?: boolean | undefined;
|
|
284
|
+
/** *array of properties detected for the SERP element* lists the properties that are true for this element each value in the array represents a detected property example: if `is_image` is present in the array, the element contains an image possible values in the array: `is_image`, `is_video`, `is_featured_snippet`, `amp_version`, `is_malicious`, `is_web_story`, `is_highly_cited` equals `null` if none of the properties are detected for the element learn more about the `checks` array in [this Help Center article](https://dataforseo.com/help-center/whats-a-checks-array-in-the-google-organic-serp-api) */
|
|
285
|
+
checks?: string[] | undefined;
|
|
286
|
+
/** *description of the results element in SERP* */
|
|
287
|
+
description?: string | undefined;
|
|
288
|
+
/** *includes additional information appended before the result description in SERP* */
|
|
289
|
+
pre_snippet?: string | undefined;
|
|
290
|
+
/** *includes additional information appended after the result description in SERP* */
|
|
291
|
+
extended_snippet?: string | undefined;
|
|
292
|
+
/** *Accelerated Mobile Pages* indicates whether an item has the Accelerated Mobile Page (AMP) version **Note:** this check no longer appears in SERP */
|
|
293
|
+
amp_version?: boolean | undefined;
|
|
294
|
+
/** *the item's rating* the popularity rate based on reviews and displayed in SERP */
|
|
271
295
|
rating?: RatingInfo | undefined;
|
|
272
|
-
/**
|
|
296
|
+
/** *words highlighted in bold within the results `description`* */
|
|
297
|
+
highlighted?: string[] | undefined;
|
|
298
|
+
/** *sitelinks* the links shown below some of Google's search results if there are none, equals `null` */
|
|
299
|
+
links?: LinkElement[] | undefined;
|
|
300
|
+
/** @deprecated *contains information from the 'About this result' panel* ['About this result' panel](https://blog.google/products/search/learn-more-and-get-more-from-search/) provides additional context about why Google returned this result for the given query; this feature appears after clicking on the three dots next to most results */
|
|
301
|
+
about_this_result?: AboutThisResultElement | undefined;
|
|
302
|
+
/** *primary domain name in SERP* */
|
|
273
303
|
main_domain?: string | undefined;
|
|
274
|
-
/** URL in SERP that does not specify the HTTPs protocol and domain name */
|
|
304
|
+
/** *URL in SERP that does not specify the HTTPs protocol and domain name* */
|
|
275
305
|
relative_url?: string | undefined;
|
|
276
|
-
/** estimated traffic volume
|
|
306
|
+
/** *estimated traffic volume* estimated organic monthly traffic to the domain or webpage; calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain or webpage rank for; learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-etv-calculated) */
|
|
277
307
|
etv?: number | undefined;
|
|
278
|
-
/** estimated cost of
|
|
308
|
+
/** *estimated cost of converting organic search traffic into paid* represents the estimated monthly cost of running ads for all keywords that a domain or webpage ranks for; the metric is calculated as the product of organic `etv` and paid `cpc` values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search; learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-traffic-cost-calculated) */
|
|
279
309
|
estimated_paid_traffic_cost?: number | undefined;
|
|
280
|
-
/** estimated traffic volume based on clickstream data
|
|
310
|
+
/** *estimated traffic volume based on clickstream data* calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain or webpage ranks for; to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true`; learn more about how the metric is calculated in this [help center article](https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated) */
|
|
281
311
|
clickstream_etv?: number | undefined;
|
|
282
|
-
/** changes in rankings
|
|
312
|
+
/** *changes in rankings* contains information about the ranking changes of the SERP element since the `previous_updated_time` */
|
|
283
313
|
rank_changes?: RankChanges | undefined;
|
|
284
|
-
/** backlinks information for the
|
|
314
|
+
/** *backlinks information for the relevant page URL* */
|
|
285
315
|
backlinks_info?: BacklinksInfo | undefined;
|
|
286
|
-
/** page and domain rank information */
|
|
316
|
+
/** *page and domain rank information* */
|
|
287
317
|
rank_info?: RankInfo | undefined;
|
|
288
318
|
[key: string]: any;
|
|
289
|
-
constructor(data?:
|
|
319
|
+
constructor(data?: IDataLabsOrganicSerpElementItem);
|
|
290
320
|
init(data?: any): void;
|
|
291
|
-
static fromJS(data: any):
|
|
321
|
+
static fromJS(data: any): DataLabsOrganicSerpElementItem;
|
|
292
322
|
toJSON(data?: any): any;
|
|
293
323
|
}
|
|
294
|
-
export interface
|
|
295
|
-
/** subdomain in SERP */
|
|
296
|
-
domain?: string | undefined;
|
|
324
|
+
export interface IDataLabsPaidSerpElementItem extends IBaseDataforseoLabsApiElementItem {
|
|
297
325
|
/** title of the result in SERP */
|
|
298
326
|
title?: string | undefined;
|
|
299
|
-
/**
|
|
300
|
-
|
|
327
|
+
/** subdomain in SERP */
|
|
328
|
+
domain?: string | undefined;
|
|
329
|
+
/** description of the results element in SERP */
|
|
330
|
+
description?: string | undefined;
|
|
301
331
|
/** breadcrumb in SERP */
|
|
302
332
|
breadcrumb?: string | undefined;
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
is_image?: boolean | undefined;
|
|
306
|
-
/** indicates whether the element contains a videoNote: this check no longer appears in SERP */
|
|
307
|
-
is_video?: boolean | undefined;
|
|
308
|
-
/** indicates whether the element is a featured_snippetNote: this check no longer appears in SERP */
|
|
309
|
-
is_featured_snippet?: boolean | undefined;
|
|
310
|
-
/** indicates whether the element is marked as maliciousNote: this check no longer appears in SERP */
|
|
311
|
-
is_malicious?: boolean | undefined;
|
|
333
|
+
/** relevant URL in SERP */
|
|
334
|
+
url?: string | undefined;
|
|
312
335
|
/** array of properties detected for the SERP elementlists the properties that are true for this elementeach value in the array represents a detected property example:if is_image is present in the array, the element contains an imagepossible values in the array:is_image, is_video, is_featured_snippet, amp_version, is_malicious, is_web_story, is_highly_citedequals null if none of the properties are detected for the elementlearn more about the checks array in this Help Center article */
|
|
313
336
|
checks?: string[] | undefined;
|
|
314
|
-
/** description of the results element in SERP */
|
|
315
|
-
description?: string | undefined;
|
|
316
|
-
pre_snippet?: string | undefined;
|
|
317
|
-
extended_snippet?: string | undefined;
|
|
318
|
-
amp_version?: boolean | undefined;
|
|
319
|
-
/** the item's rating the popularity rate based on reviews and displayed in SERP */
|
|
320
|
-
rating?: RatingInfo | undefined;
|
|
321
337
|
/** words highlighted in bold within the results description */
|
|
322
338
|
highlighted?: string[] | undefined;
|
|
339
|
+
extra?: {
|
|
340
|
+
[key: string]: string;
|
|
341
|
+
} | undefined;
|
|
342
|
+
/** extended description if there is none, equals null */
|
|
343
|
+
description_rows?: string[] | undefined;
|
|
323
344
|
/** sitelinks the links shown below some of Google's search results if there are none, equals null */
|
|
324
|
-
links?:
|
|
325
|
-
/** @deprecated */
|
|
326
|
-
about_this_result?: AboutThisResultElement | undefined;
|
|
345
|
+
links?: AdLinkElement[] | undefined;
|
|
327
346
|
/** primary domain name in SERP */
|
|
328
347
|
main_domain?: string | undefined;
|
|
329
348
|
/** URL in SERP that does not specify the HTTPs protocol and domain name */
|
|
@@ -342,39 +361,28 @@ export interface IDataLabsOrganicSerpElementItem extends IBaseDataforseoLabsApiE
|
|
|
342
361
|
rank_info?: RankInfo | undefined;
|
|
343
362
|
[key: string]: any;
|
|
344
363
|
}
|
|
345
|
-
export declare class
|
|
346
|
-
/** subdomain in SERP */
|
|
347
|
-
domain?: string | undefined;
|
|
364
|
+
export declare class DataLabsPaidSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsPaidSerpElementItem {
|
|
348
365
|
/** title of the result in SERP */
|
|
349
366
|
title?: string | undefined;
|
|
350
|
-
/**
|
|
351
|
-
|
|
367
|
+
/** subdomain in SERP */
|
|
368
|
+
domain?: string | undefined;
|
|
369
|
+
/** description of the results element in SERP */
|
|
370
|
+
description?: string | undefined;
|
|
352
371
|
/** breadcrumb in SERP */
|
|
353
372
|
breadcrumb?: string | undefined;
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
is_image?: boolean | undefined;
|
|
357
|
-
/** indicates whether the element contains a videoNote: this check no longer appears in SERP */
|
|
358
|
-
is_video?: boolean | undefined;
|
|
359
|
-
/** indicates whether the element is a featured_snippetNote: this check no longer appears in SERP */
|
|
360
|
-
is_featured_snippet?: boolean | undefined;
|
|
361
|
-
/** indicates whether the element is marked as maliciousNote: this check no longer appears in SERP */
|
|
362
|
-
is_malicious?: boolean | undefined;
|
|
373
|
+
/** relevant URL in SERP */
|
|
374
|
+
url?: string | undefined;
|
|
363
375
|
/** array of properties detected for the SERP elementlists the properties that are true for this elementeach value in the array represents a detected property example:if is_image is present in the array, the element contains an imagepossible values in the array:is_image, is_video, is_featured_snippet, amp_version, is_malicious, is_web_story, is_highly_citedequals null if none of the properties are detected for the elementlearn more about the checks array in this Help Center article */
|
|
364
376
|
checks?: string[] | undefined;
|
|
365
|
-
/** description of the results element in SERP */
|
|
366
|
-
description?: string | undefined;
|
|
367
|
-
pre_snippet?: string | undefined;
|
|
368
|
-
extended_snippet?: string | undefined;
|
|
369
|
-
amp_version?: boolean | undefined;
|
|
370
|
-
/** the item's rating the popularity rate based on reviews and displayed in SERP */
|
|
371
|
-
rating?: RatingInfo | undefined;
|
|
372
377
|
/** words highlighted in bold within the results description */
|
|
373
378
|
highlighted?: string[] | undefined;
|
|
379
|
+
extra?: {
|
|
380
|
+
[key: string]: string;
|
|
381
|
+
} | undefined;
|
|
382
|
+
/** extended description if there is none, equals null */
|
|
383
|
+
description_rows?: string[] | undefined;
|
|
374
384
|
/** sitelinks the links shown below some of Google's search results if there are none, equals null */
|
|
375
|
-
links?:
|
|
376
|
-
/** @deprecated */
|
|
377
|
-
about_this_result?: AboutThisResultElement | undefined;
|
|
385
|
+
links?: AdLinkElement[] | undefined;
|
|
378
386
|
/** primary domain name in SERP */
|
|
379
387
|
main_domain?: string | undefined;
|
|
380
388
|
/** URL in SERP that does not specify the HTTPs protocol and domain name */
|
|
@@ -392,9 +400,9 @@ export declare class DataLabsOrganicSerpElementItem extends BaseDataforseoLabsAp
|
|
|
392
400
|
/** page and domain rank information */
|
|
393
401
|
rank_info?: RankInfo | undefined;
|
|
394
402
|
[key: string]: any;
|
|
395
|
-
constructor(data?:
|
|
403
|
+
constructor(data?: IDataLabsPaidSerpElementItem);
|
|
396
404
|
init(data?: any): void;
|
|
397
|
-
static fromJS(data: any):
|
|
405
|
+
static fromJS(data: any): DataLabsPaidSerpElementItem;
|
|
398
406
|
toJSON(data?: any): any;
|
|
399
407
|
}
|
|
400
408
|
export interface IDataLabsAnswerBoxSerpElementItem extends IBaseDataforseoLabsApiElementItem {
|