View raw JSON
{
"type": "object",
"required": [
"body"
],
"properties": {
"body": {
"type": "object",
"title": "Extract product reviews from Amazon using product IDs or URLs, including titles, review text, date, and more.",
"required": [
"products"
],
"properties": {
"sort": {
"enum": [
"helpful",
"recent"
],
"type": "string",
"title": "Sort by",
"default": "helpful",
"enumTitles": [
"Top reviews",
"Most recent"
],
"description": "Optional, default helpful for source-ranked top reviews. recent requests more recent reviews; it does not guarantee newest-first or complete coverage."
},
"limit": {
"type": "integer",
"unit": "page",
"title": "pages to scrape per product",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Optional per-product page cap, from 1 to 50, default 20. Individual source review views may be limited to 10 pages, so a higher setting does not guarantee more records. Pages are not review counts or a whole-request limit."
},
"stars": {
"type": "array",
"items": {
"enum": [
"five_star",
"four_star",
"three_star",
"two_star",
"one_star"
],
"type": "string",
"enumTitles": [
"5 star",
"4 star",
"3 star",
"2 star",
"1 star"
]
},
"title": "Filter multiple stars",
"editor": "select",
"description": "Optional list selecting one or more star-rating views. Choices are documented in the list-item row. Combined views can overlap and do not guarantee unique reviews or complete coverage."
},
"rating": {
"enum": [
"all",
"five_star",
"four_star",
"three_star",
"two_star",
"one_star",
"positive",
"critical"
],
"type": "string",
"title": "Rating stars",
"default": "all",
"enumTitles": [
"All",
"5 star",
"4 star",
"3 star",
"2 star",
"1 star",
"Positive only",
"Critical only"
],
"description": "Optional, default all. Choose a single star value from five_star through one_star, or the source-defined positive or critical groups. These groups do not independently analyze sentiment or quality. Do not assume a particular precedence when combining star options or URL settings.",
"sectionCaption": "Filters for more reviews",
"sectionDescription": "These filters apply to the provided ASINs. Filters for product URLs are automatically detected. Use a combination of these filters to retrieve thousands of reviews; note that some duplicate reviews may be returned."
},
"region": {
"enum": [
"amazon.com",
"amazon.ca",
"amazon.de",
"amazon.fr",
"amazon.co.uk",
"amazon.it",
"amazon.es",
"amazon.com.au",
"amazon.co.jp",
"amazon.com.br",
"amazon.com.mx",
"amazon.nl",
"amazon.ie",
"amazon.se",
"amazon.com.tr",
"amazon.ae",
"amazon.sg",
"amazon.sa",
"amazon.pl",
"amazon.com.be",
"amazon.eg",
"amazon.in"
],
"type": "string",
"title": "Amazon ASINs domain",
"default": "amazon.com",
"enumTitles": [
"United States (amazon.com)",
"Canada (amazon.ca)",
"Germany (amazon.de)",
"France (amazon.fr)",
"United Kingdom (amazon.co.uk)",
"Italy (amazon.it)",
"Spain (amazon.es)",
"Australia (amazon.com.au)",
"Japan (amazon.co.jp)",
"Brazil (amazon.com.br)",
"Mexico (amazon.com.mx)",
"Netherlands (amazon.nl)",
"Ireland (amazon.ie)",
"Sweden (amazon.se)",
"Turkey (amazon.com.tr)",
"United Arab Emirates (amazon.ae)",
"Singapore (amazon.sg)",
"Saudi Arabia (amazon.sa)",
"Poland (amazon.pl)",
"Belgium (amazon.com.be)",
"Egypt (amazon.eg)",
"India (amazon.in)"
],
"description": "Optional marketplace for bare ASINs, default amazon.com; choose a listed Amazon domain. URLs can carry their own marketplace and filter settings. This does not translate reviews or verify a reviewer's location.",
"sectionCaption": "Domain & Language"
},
"end_date": {
"type": "string",
"title": "End date",
"editor": "datepicker",
"pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$",
"description": "Optional inclusive end date: request reviews dated on or before this YYYY-MM-DD date. It refers to review publication rather than collection time; no time zone or default date is specified."
},
"keywords": {
"type": "array",
"title": "Filter by keywords",
"editor": "stringList",
"description": "Optional distinct keywords used to filter review text and narrow the returned subset. No particular all-keywords or any-keyword matching rule is promised.",
"uniqueItems": true
},
"language": {
"enum": [
"all",
"en",
"es",
"fr",
"de",
"pt",
"it",
"nl",
"pl",
"sv",
"cs",
"zh_CN",
"zh_TW",
"ja",
"ko",
"ar",
"tr"
],
"type": "string",
"title": "Reviews language",
"default": "all",
"enumTitles": [
"All languages",
"English (en)",
"Spanish (es)",
"French (fr)",
"German (de)",
"Portuguese (pt)",
"Italian (it)",
"Dutch (nl)",
"Polish (pl)",
"Swedish (sv)",
"Czech (cs)",
"Simplified Chinese (zh-CN)",
"Traditional Chinese (zh-TW)",
"Japanese (ja)",
"Korean (ko)",
"Arabic (ar)",
"Turkish (tr)"
],
"description": "Optional filter, default all. Select a listed language to narrow reviews in that language; the setting does not translate the text."
},
"products": {
"type": "array",
"title": "Start ASINs/URLs",
"editor": "stringList",
"prefill": [
"https://www.amazon.com/Logitech-LIGHTSPEED-Wireless-Gaming-Mouse/product-reviews/B07CMS5Q6P/ref=cm_cr_getr_mb_paging_btm_2?ie=UTF8&reviewerType=all_reviews&pageNumber=2&formatType=current_format",
"B07MVJZQTC"
],
"description": "Required distinct list of selected product ASINs, product URLs or product review-page URLs. Bare ASINs use the selected marketplace. URLs may supply their own domain and filters; do not assume ASIN options override them. Prefilled targets are examples, not defaults.",
"uniqueItems": true
},
"all_stars": {
"type": "boolean",
"title": "All Stars Mode (up to 500 review per product)",
"default": false,
"description": "Optional, default false. Requests collection across star-rating views when enabled. The views may overlap, and this does not guarantee 500 reviews, unique records or complete history.",
"sectionCaption": "Scraping Modes"
},
"start_date": {
"type": "string",
"title": "Start date",
"editor": "datepicker",
"pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$",
"description": "Optional inclusive start date: request reviews dated on or after this YYYY-MM-DD date. It refers to review publication rather than collection time; no time zone or default date is specified.",
"sectionCaption": "Filter by Date range",
"sectionDescription": "Filter reviews by date range. This option is useful for scraping reviews from a specific period. \nNOTE: You are charged per review scraped, so using date filter will not lower the cost."
},
"avp_reviews": {
"type": "boolean",
"title": "Only verified purchase",
"default": false,
"description": "Optional, default false. When true, requests only reviews with the source's verified-purchase badge. The badge is not an independent check of buyer identity or review authenticity.",
"groupCaption": "Options"
},
"personal_data": {
"type": "boolean",
"title": "Include personal data",
"default": false,
"description": "Optional, default false. When enabled, requests available reviewer personal fields such as names or identifiers. Availability varies; contact details are not guaranteed or verified, and this setting does not guarantee complete anonymization."
},
"include_variants": {
"type": "boolean",
"title": "Include all variants reviews",
"default": true,
"description": "Optional, default true. Controls inclusion of product-variant review views. Coverage depends on the source, may overlap, and does not guarantee every variant's complete history."
},
"scrape_image_reviews": {
"type": "boolean",
"title": "Scrape reviews with images",
"default": true,
"description": "Optional, default true. Requests reviews containing images; such records may have limited fields or overlap other views. It does not download images. Turning it off does not guarantee ordinary review records lack image references.",
"groupCaption": "Media reviews",
"sectionCaption": "Scrape media reviews (more reviews)",
"sectionDescription": "Scrape reviews that contain media (images/videos). This option is useful for extracting visual content from reviews. \nScraping media reviews can significantly increase the number of reviews returned, especially for products with rich media content. \nMedia reviews might return limited data."
},
"scrape_video_reviews": {
"type": "boolean",
"title": "Scrape reviews with videos",
"default": true,
"description": "Optional, default true. Requests reviews containing videos; such records may have limited fields or overlap other views. It does not download videos. Turning it off does not guarantee ordinary review records lack video references."
}
},
"description": "Required request object containing the selected products and optional review collection settings. Returned coverage depends on the chosen views, filters and source access.",
"schemaVersion": 1
}
},
"additionalProperties": false
}
