{ "openapi": "3.0.1", "info": { "title": "Shopify Fera Reviews Scraper API", "description": "Scrape Fera product reviews and site reviews from any Shopify store URL or product URL.", "version": "0.0", "x-build-id": "G5oijYBsro1RV43Nz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lurkapi~shopify-fera-reviews-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lurkapi-shopify-fera-reviews-scraper-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/lurkapi~shopify-fera-reviews-scraper-api/runs": { "post": { "operationId": "runs-sync-lurkapi-shopify-fera-reviews-scraper-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/lurkapi~shopify-fera-reviews-scraper-api/run-sync": { "post": { "operationId": "run-sync-lurkapi-shopify-fera-reviews-scraper-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Store, product, or landing page URLs", "maxItems": 1000, "type": "array", "description": "Paste a Shopify store URL to collect public Fera reviews across that store, a product URL to collect one product's reviews, or a landing page that embeds a product review widget. These URL types can be mixed in one run.", "items": { "type": "string", "maxLength": 2048 } }, "maxResultsPerUrl": { "title": "Maximum results per URL", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum review rows delivered for each store domain in this run.", "default": 50 }, "filterRatings": { "title": "Star ratings", "uniqueItems": true, "type": "array", "description": "Only keep reviews with the selected star ratings. Leave empty to include every rating. Free with the base row price.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "verifiedOnly": { "title": "Only verified buyers", "type": "boolean", "description": "Only keep reviews marked as verified. Free.", "default": false }, "searchText": { "title": "Search review text", "maxLength": 500, "type": "string", "description": "Only keep reviews whose title or body contains this phrase. Case-insensitive and free." }, "sortBy": { "title": "Sort reviews by", "enum": [ "newest", "oldest", "highest_rating", "lowest_rating", "best_quality", "photos_first", "videos_first", "media_first", "most_helpful" ], "type": "string", "description": "All choices except Most helpful are free. Most helpful is computed after collection and counts as an add-on.", "default": "newest" }, "onlyWithPhotos": { "title": "Only reviews with photos ($)", "type": "boolean", "description": "Only keep reviews that include at least one customer photo.", "default": false }, "onlyWithVideos": { "title": "Only reviews with videos ($)", "type": "boolean", "description": "Only keep reviews that include at least one customer video.", "default": false }, "onlyWithMedia": { "title": "Only reviews with media ($)", "type": "boolean", "description": "Only keep reviews that include at least one photo or video.", "default": false }, "merchantReplyOnly": { "title": "Only reviews with store replies ($)", "type": "boolean", "description": "Only keep reviews where the store replied publicly.", "default": false }, "reviewContent": { "title": "Written vs. rating-only ($)", "enum": [ "all", "with_text", "rating_only" ], "type": "string", "description": "Keep every review, only reviews with written text, or only star ratings without text.", "default": "all" }, "filterStartDate": { "title": "Published on or after ($)", "type": "string", "description": "Only keep reviews posted on or after this date, inclusive." }, "filterEndDate": { "title": "Published on or before ($)", "type": "string", "description": "Only keep reviews posted on or before this date, inclusive." }, "filterChannels": { "title": "Review source channels ($)", "maxItems": 20, "type": "array", "description": "Only keep reviews from these channels. Use native for store-collected reviews, or codes such as google, etsy, or aliexpress for imported reviews.", "items": { "type": "string", "maxLength": 32 } }, "filterLanguages": { "title": "Review languages ($)", "maxItems": 50, "type": "array", "description": "Only keep reviews in these languages. Use codes such as en, eng, es, spa, or pt-BR. This also turns language detection on.", "items": { "type": "string", "maxLength": 16 } }, "detectLanguage": { "title": "Detect review language ($)", "type": "boolean", "description": "Add detectedLanguage when detection succeeds on a delivered review.", "default": false }, "translateReviews": { "title": "Translate reviews ($)", "type": "boolean", "description": "Translate the review title and text into the selected target language.", "default": false }, "translationTarget": { "title": "Translate into", "maxLength": 16, "type": "string", "description": "Target language code, such as en, es, fr, de, ja, or pt-BR.", "default": "en" }, "downloadMedia": { "title": "Archive review media ($)", "type": "boolean", "description": "Save up to 10 photos or videos per review, with a 3 MB limit per file. Source URLs remain available without this option.", "default": false }, "outputStoreDomain": { "title": "Store domain", "type": "boolean", "description": "Normalized store hostname.", "default": true }, "outputStoreUrl": { "title": "Store URL", "type": "boolean", "description": "Canonical store home page URL.", "default": true }, "outputStoreSummary": { "title": "Store rating summary", "type": "boolean", "description": "Store name, country, average rating, and total review count.", "default": true }, "outputProductHandle": { "title": "Product handle", "type": "boolean", "description": "Product URL slug.", "default": true }, "outputProductTitle": { "title": "Product title", "type": "boolean", "description": "Public product name.", "default": true }, "outputProductUrl": { "title": "Product URL", "type": "boolean", "description": "Canonical product link.", "default": true }, "outputProductImageUrl": { "title": "Product image", "type": "boolean", "description": "Product thumbnail URL.", "default": true }, "outputProductRating": { "title": "Product rating summary", "type": "boolean", "description": "Average rating, review count, and 1 to 5 star counts.", "default": true }, "outputPrice": { "title": "Product price", "type": "boolean", "description": "Public price when a product URL supplies it.", "default": true }, "outputCurrency": { "title": "Currency", "type": "boolean", "description": "Storefront currency code when detected.", "default": true }, "outputAvailable": { "title": "Availability", "type": "boolean", "description": "Whether the product is publicly available.", "default": true }, "outputReviewTitle": { "title": "Review title", "type": "boolean", "description": "Review headline when present.", "default": true }, "outputPublishedAt": { "title": "Review dates", "type": "boolean", "description": "Published and updated timestamps.", "default": true }, "outputReviewerName": { "title": "Reviewer name and location", "type": "boolean", "description": "Public display name, public location, and anonymous flag.", "default": true }, "outputVerifiedBuyer": { "title": "Verified buyer flag", "type": "boolean", "description": "Whether the review is marked verified.", "default": true }, "outputReply": { "title": "Store reply", "type": "boolean", "description": "Public reply, author, and timestamp.", "default": true }, "outputChannel": { "title": "Source channel", "type": "boolean", "description": "Review source channel and public link.", "default": true }, "outputHelpfulCount": { "title": "Helpful votes", "type": "boolean", "description": "Public helpful-vote count.", "default": true }, "outputMediaUrls": { "title": "Media URLs", "type": "boolean", "description": "Customer photo, video, and thumbnail URLs.", "default": true }, "outputReviewUrl": { "title": "Review link", "type": "boolean", "description": "Public storefront review link.", "default": true }, "outputInputUrl": { "title": "Input URL", "type": "boolean", "description": "Input URL that produced the row.", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }