Amazon Reviews Scraper with Advanced Filters

1{
2  "openapi": "3.0.1",
3  "info": {
4    "version": "0.0",
5    "x-build-id": "6YGEjov02msxqoPRy"
6  },
7  "servers": [
8    {
9      "url": "https://api.apify.com/v2"
10    }
11  ],
12  "paths": {
13    "/acts/delicious_zebu~amazon-reviews-scraper-with-advanced-filters/run-sync-get-dataset-items": {
14      "post": {
15        "operationId": "run-sync-get-dataset-items-delicious_zebu-amazon-reviews-scraper-with-advanced-filters",
16        "x-openai-isConsequential": false,
17        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18        "tags": [
19          "Run Actor"
20        ],
21        "requestBody": {
22          "required": true,
23          "content": {
24            "application/json": {
25              "schema": {
26                "$ref": "#/components/schemas/inputSchema"
27              }
28            }
29          }
30        },
31        "parameters": [
32          {
33            "name": "token",
34            "in": "query",
35            "required": true,
36            "schema": {
37              "type": "string"
38            },
39            "description": "Enter your Apify token here"
40          }
41        ],
42        "responses": {
43          "200": {
44            "description": "OK"
45          }
46        }
47      }
48    },
49    "/acts/delicious_zebu~amazon-reviews-scraper-with-advanced-filters/runs": {
50      "post": {
51        "operationId": "runs-sync-delicious_zebu-amazon-reviews-scraper-with-advanced-filters",
52        "x-openai-isConsequential": false,
53        "summary": "Executes an Actor and returns information about the initiated run in response.",
54        "tags": [
55          "Run Actor"
56        ],
57        "requestBody": {
58          "required": true,
59          "content": {
60            "application/json": {
61              "schema": {
62                "$ref": "#/components/schemas/inputSchema"
63              }
64            }
65          }
66        },
67        "parameters": [
68          {
69            "name": "token",
70            "in": "query",
71            "required": true,
72            "schema": {
73              "type": "string"
74            },
75            "description": "Enter your Apify token here"
76          }
77        ],
78        "responses": {
79          "200": {
80            "description": "OK",
81            "content": {
82              "application/json": {
83                "schema": {
84                  "$ref": "#/components/schemas/runsResponseSchema"
85                }
86              }
87            }
88          }
89        }
90      }
91    },
92    "/acts/delicious_zebu~amazon-reviews-scraper-with-advanced-filters/run-sync": {
93      "post": {
94        "operationId": "run-sync-delicious_zebu-amazon-reviews-scraper-with-advanced-filters",
95        "x-openai-isConsequential": false,
96        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97        "tags": [
98          "Run Actor"
99        ],
100        "requestBody": {
101          "required": true,
102          "content": {
103            "application/json": {
104              "schema": {
105                "$ref": "#/components/schemas/inputSchema"
106              }
107            }
108          }
109        },
110        "parameters": [
111          {
112            "name": "token",
113            "in": "query",
114            "required": true,
115            "schema": {
116              "type": "string"
117            },
118            "description": "Enter your Apify token here"
119          }
120        ],
121        "responses": {
122          "200": {
123            "description": "OK"
124          }
125        }
126      }
127    }
128  },
129  "components": {
130    "schemas": {
131      "inputSchema": {
132        "type": "object",
133        "required": [
134          "ASIN_or_URL",
135          "sort_reviews_by",
136          "filter_by_verified_purchase_only",
137          "filter_by_ratings",
138          "filter_by_mediaType",
139          "unique_only",
140          "country"
141        ],
142        "properties": {
143          "ASIN_or_URL": {
144            "title": "ASIN or Product URL",
145            "maxItems": 10000,
146            "uniqueItems": false,
147            "type": "array",
148            "description": "Provide either an ASIN (E.G., B0CC1F5CGH) or a product URL (E.G., https://www.amazon.com/iPad-8th-Gen-Cellular-Renewed/dp/B0BFC42HQR).",
149            "default": [
150              "B0CC1F5CGH"
151            ],
152            "items": {
153              "type": "string"
154            }
155          },
156          "country": {
157            "title": "ASIN Country",
158            "enum": [
159              "United States",
160              "Canada",
161              "United Kingdom",
162              "Germany (Deutschland)",
163              "France",
164              "Italy (Italia)",
165              "Japan (日本)",
166              "Mexico (México)",
167              "Spain (España)",
168              "India",
169              "Brazil (Brasil)",
170              "Belgium (Belgique)"
171            ],
172            "type": "string",
173            "description": "Select the country corresponding to the ASIN. This determines the marketplace from which reviews will be scraped. Default: United States.",
174            "default": "United States"
175          },
176          "End_date": {
177            "title": "End Date",
178            "type": "string",
179            "description": "Select the end date to scrape all reviews from today until this specified date.",
180            "default": "1990-01-01"
181          },
182          "unique_only": {
183            "title": "Unique Reviews Only",
184            "type": "boolean",
185            "description": "Enable this option to deduplicate reviews. If disabled, the same review may appear multiple times in different filters (e.g., both 'All stars' and '5 star only').",
186            "default": false
187          },
188          "sort_reviews_by": {
189            "title": "Sort Reviews By",
190            "type": "array",
191            "description": "Select how to sort reviews. Default: All options ('Top reviews' and 'Most recent') are selected.",
192            "items": {
193              "type": "string",
194              "enum": [
195                "helpful",
196                "recent"
197              ],
198              "enumTitles": [
199                "Top reviews",
200                "Most recent"
201              ]
202            },
203            "default": [
204              "helpful",
205              "recent"
206            ]
207          },
208          "filter_by_verified_purchase_only": {
209            "title": "Filter By Verified Purchase",
210            "type": "array",
211            "description": "Filter reviews based on purchase verification. Default: All options ('All reviewers' and 'Verified purchase only') are selected.",
212            "items": {
213              "type": "string",
214              "enum": [
215                "all_reviews",
216                "avp_only_reviews"
217              ],
218              "enumTitles": [
219                "All reviewers",
220                "Verified purchase only"
221              ]
222            },
223            "default": [
224              "all_reviews",
225              "avp_only_reviews"
226            ]
227          },
228          "filter_by_ratings": {
229            "title": "Filter By Ratings",
230            "type": "array",
231            "description": "Filter reviews by rating type. Default: All rating types are selected.",
232            "items": {
233              "type": "string",
234              "enum": [
235                "all_stars",
236                "five_star",
237                "four_star",
238                "three_star",
239                "two_star",
240                "one_star",
241                "positive",
242                "critical"
243              ],
244              "enumTitles": [
245                "All stars",
246                "5 star only",
247                "4 star only",
248                "3 star only",
249                "2 star only",
250                "1 star only",
251                "Positive reviews",
252                "Critical reviews"
253              ]
254            },
255            "default": [
256              "all_stars",
257              "five_star",
258              "four_star",
259              "three_star",
260              "two_star",
261              "one_star",
262              "positive",
263              "critical"
264            ]
265          },
266          "filter_by_mediaType": {
267            "title": "Filter By Media Type",
268            "type": "array",
269            "description": "Filter reviews by media content. Default: All options ('Text, image, video' and 'Image and video reviews only') are selected.",
270            "items": {
271              "type": "string",
272              "enum": [
273                "all_contents",
274                "media_reviews_only"
275              ],
276              "enumTitles": [
277                "Text, image, video",
278                "Image and video reviews only"
279              ]
280            },
281            "default": [
282              "all_contents",
283              "media_reviews_only"
284            ]
285          }
286        }
287      },
288      "runsResponseSchema": {
289        "type": "object",
290        "properties": {
291          "data": {
292            "type": "object",
293            "properties": {
294              "id": {
295                "type": "string"
296              },
297              "actId": {
298                "type": "string"
299              },
300              "userId": {
301                "type": "string"
302              },
303              "startedAt": {
304                "type": "string",
305                "format": "date-time",
306                "example": "2025-01-08T00:00:00.000Z"
307              },
308              "finishedAt": {
309                "type": "string",
310                "format": "date-time",
311                "example": "2025-01-08T00:00:00.000Z"
312              },
313              "status": {
314                "type": "string",
315                "example": "READY"
316              },
317              "meta": {
318                "type": "object",
319                "properties": {
320                  "origin": {
321                    "type": "string",
322                    "example": "API"
323                  },
324                  "userAgent": {
325                    "type": "string"
326                  }
327                }
328              },
329              "stats": {
330                "type": "object",
331                "properties": {
332                  "inputBodyLen": {
333                    "type": "integer",
334                    "example": 2000
335                  },
336                  "rebootCount": {
337                    "type": "integer",
338                    "example": 0
339                  },
340                  "restartCount": {
341                    "type": "integer",
342                    "example": 0
343                  },
344                  "resurrectCount": {
345                    "type": "integer",
346                    "example": 0
347                  },
348                  "computeUnits": {
349                    "type": "integer",
350                    "example": 0
351                  }
352                }
353              },
354              "options": {
355                "type": "object",
356                "properties": {
357                  "build": {
358                    "type": "string",
359                    "example": "latest"
360                  },
361                  "timeoutSecs": {
362                    "type": "integer",
363                    "example": 300
364                  },
365                  "memoryMbytes": {
366                    "type": "integer",
367                    "example": 1024
368                  },
369                  "diskMbytes": {
370                    "type": "integer",
371                    "example": 2048
372                  }
373                }
374              },
375              "buildId": {
376                "type": "string"
377              },
378              "defaultKeyValueStoreId": {
379                "type": "string"
380              },
381              "defaultDatasetId": {
382                "type": "string"
383              },
384              "defaultRequestQueueId": {
385                "type": "string"
386              },
387              "buildNumber": {
388                "type": "string",
389                "example": "1.0.0"
390              },
391              "containerUrl": {
392                "type": "string"
393              },
394              "usage": {
395                "type": "object",
396                "properties": {
397                  "ACTOR_COMPUTE_UNITS": {
398                    "type": "integer",
399                    "example": 0
400                  },
401                  "DATASET_READS": {
402                    "type": "integer",
403                    "example": 0
404                  },
405                  "DATASET_WRITES": {
406                    "type": "integer",
407                    "example": 0
408                  },
409                  "KEY_VALUE_STORE_READS": {
410                    "type": "integer",
411                    "example": 0
412                  },
413                  "KEY_VALUE_STORE_WRITES": {
414                    "type": "integer",
415                    "example": 1
416                  },
417                  "KEY_VALUE_STORE_LISTS": {
418                    "type": "integer",
419                    "example": 0
420                  },
421                  "REQUEST_QUEUE_READS": {
422                    "type": "integer",
423                    "example": 0
424                  },
425                  "REQUEST_QUEUE_WRITES": {
426                    "type": "integer",
427                    "example": 0
428                  },
429                  "DATA_TRANSFER_INTERNAL_GBYTES": {
430                    "type": "integer",
431                    "example": 0
432                  },
433                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
434                    "type": "integer",
435                    "example": 0
436                  },
437                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
438                    "type": "integer",
439                    "example": 0
440                  },
441                  "PROXY_SERPS": {
442                    "type": "integer",
443                    "example": 0
444                  }
445                }
446              },
447              "usageTotalUsd": {
448                "type": "number",
449                "example": 0.00005
450              },
451              "usageUsd": {
452                "type": "object",
453                "properties": {
454                  "ACTOR_COMPUTE_UNITS": {
455                    "type": "integer",
456                    "example": 0
457                  },
458                  "DATASET_READS": {
459                    "type": "integer",
460                    "example": 0
461                  },
462                  "DATASET_WRITES": {
463                    "type": "integer",
464                    "example": 0
465                  },
466                  "KEY_VALUE_STORE_READS": {
467                    "type": "integer",
468                    "example": 0
469                  },
470                  "KEY_VALUE_STORE_WRITES": {
471                    "type": "number",
472                    "example": 0.00005
473                  },
474                  "KEY_VALUE_STORE_LISTS": {
475                    "type": "integer",
476                    "example": 0
477                  },
478                  "REQUEST_QUEUE_READS": {
479                    "type": "integer",
480                    "example": 0
481                  },
482                  "REQUEST_QUEUE_WRITES": {
483                    "type": "integer",
484                    "example": 0
485                  },
486                  "DATA_TRANSFER_INTERNAL_GBYTES": {
487                    "type": "integer",
488                    "example": 0
489                  },
490                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
491                    "type": "integer",
492                    "example": 0
493                  },
494                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
495                    "type": "integer",
496                    "example": 0
497                  },
498                  "PROXY_SERPS": {
499                    "type": "integer",
500                    "example": 0
501                  }
502                }
503              }
504            }
505          }
506        }
507      }
508    }
509  }
510}