-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathdataforseo_keywords_data_openapi.json
More file actions
198 lines (198 loc) · 8.71 KB
/
dataforseo_keywords_data_openapi.json
File metadata and controls
198 lines (198 loc) · 8.71 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
{
"openapi": "3.1.0",
"info": {
"title": "DataForSEO Keywords Data API",
"description": "Access to DataForSEO Keywords Data tools for SEO research and analysis",
"version": "v1.0.0"
},
"servers": [
{
"url": "https://api.dataforseo.com"
}
],
"paths": {
"/v3/keywords_data/google_ads_locations/live.ai": {
"post": {
"description": "Utility tool for keywords_data_google_ads_search_volume to get list of availible locations.",
"operationId": "keywords_data_google_ads_locations",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"country_iso_code": {
"type": "string",
"description": "ISO 3166-1 alpha-2 country code, for example: US, GB, MT"
},
"location_type": {
"type": "string",
"description": "Type of location. Possible variants: 'TV Region','Postal Code','Neighborhood','Governorate','National Park','Quarter','Canton','Airport','Okrug','Prefecture','City','Country','Province','Barrio','Sub-District','Congressional District','Municipality District','district','DMA Region','Union Territory','Territory','Colloquial Area','Autonomous Community','Borough','County','State','District','City Region','Commune','Region','Department','Division','Sub-Ward','Municipality','University'"
},
"location_name": {
"type": "string",
"description": "Name of location or it`s part."
}
},
"required": [
"country_iso_code"
]
}
}
}
}
}
},
"/v3/keywords_data/google_ads/search_volume/live.ai": {
"post": {
"description": "Get search volume data for keywords from Google Ads",
"operationId": "keywords_data_google_ads_search_volume",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location_name": {
"type": "string",
"default": "United States",
"description": "full name of the location\nrequired field\nLocation format - hierarchical, comma-separated (from most specific to least)\n Can be one of:\n 1. Country only: \"United States\"\n 2. Region,Country: \"California,United States\"\n 3. City,Region,Country: \"San Francisco,California,United States\""
},
"language_code": {
"type": [
"string",
"null"
],
"default": null,
"description": "Language two-letter ISO code (e.g., 'en').\noptional field"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of keywords to get search volume for"
}
},
"required": [
"keywords"
]
}
}
}
}
}
},
"/v3/keywords_data/google_trends/categories.ai": {
"get": {
"description": "This endpoint will provide you list of Google Trends Categories",
"operationId": "keywords_data_google_trends_categories"
}
},
"/v3/keywords_data/google_trends/explore/live.ai": {
"post": {
"description": "This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube",
"operationId": "keywords_data_google_trends_explore",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"location_name": {
"type": [
"string",
"null"
],
"default": null,
"description": "full name of the location\n optional field\n in format \"Country\"\n example:\n United Kingdom"
},
"language_code": {
"type": [
"string",
"null"
],
"default": null,
"description": "Language two-letter ISO code (e.g., 'en').\n optional field"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "keywords\n the maximum number of keywords you can specify: 5\n the maximum number of characters you can specify in a keyword: 100\n the minimum number of characters must be greater than 1\n comma characters (,) in the specified keywords will be unset and ignored\n Note: keywords cannot consist of a combination of the following characters: < > | \" - + = ~ ! : * ( ) [ ] { }\n\n Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword"
},
"type": {
"type": "string",
"enum": [
"web",
"news",
"youtube",
"images",
"froogle"
],
"default": "web",
"description": "google trends type"
},
"date_from": {
"type": "string",
"description": "starting date of the time range\n if you don’t specify this field, the current day and month of the preceding year will be used by default\n minimal value for the web type: 2004-01-01\n minimal value for other types: 2008-01-01\n date format: \"yyyy-mm-dd\"\n example:\n \"2019-01-15\""
},
"date_to": {
"type": "string",
"description": "ending date of the time range\n if you don’t specify this field, the today’s date will be used by default\n date format: \"yyyy-mm-dd\"\n example:\n \"2019-01-15\""
},
"time_range": {
"type": "string",
"enum": [
"past_hour",
"past_4_hours",
"past_day",
"past_7_days",
"past_30_days",
"past_90_days",
"past_12_months",
"past_5_years"
],
"default": "past_7_days",
"description": "preset time ranges\n if you specify date_from or date_to parameters, this field will be ignored when setting a task"
},
"item_types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"google_trends_graph",
"google_trends_map",
"google_trends_topics_list",
"google_trends_queries_list"
]
},
"default": [
"google_trends_graph"
],
"description": "types of items returned\n to speed up the execution of the request, specify one item at a time"
},
"category_code": {
"type": [
"number",
"null"
],
"default": null,
"description": "google trends search category\n you can receive the list of available categories with their category_code by making a separate request to the keywords_data_google_trends_categories tool"
}
},
"required": [
"keywords"
]
}
}
}
}
}
}
}
}