{ "openapi": "3.0.1", "info": { "title": "Flipkart Reviews Scraper", "description": "Scrapes customer reviews from Flipkart products including review text, rating, certified buyer status, helpful votes, and reviewer info.", "version": "1.0", "x-build-id": "G5J4ZBsW51kVxvn7U" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codingfrontend~flipkart-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codingfrontend-flipkart-reviews-scraper", "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/codingfrontend~flipkart-reviews-scraper/runs": { "post": { "operationId": "runs-sync-codingfrontend-flipkart-reviews-scraper", "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/codingfrontend~flipkart-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-codingfrontend-flipkart-reviews-scraper", "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", "properties": { "mode": { "title": "Scraping Mode", "enum": [ "productUrl", "search" ], "type": "string", "description": "Use productUrl for one or more public product URLs, or search for a public Flipkart search query.", "default": "productUrl" }, "productUrls": { "title": "Product URLs", "type": "array", "description": "HTTPS Flipkart product URLs. Only public pages on flipkart.com are accepted.", "items": { "type": "string" }, "default": [ "https://www.flipkart.com/apple-iphone-15-black-128-gb/p/itm6ac6485515ae4" ] }, "query": { "title": "Search Query", "type": "string", "description": "Public Flipkart search text used when mode is search.", "default": "iphone 15" }, "searchQuery": { "title": "Legacy Search Query Alias", "type": "string", "description": "Backward-compatible alias for query. query takes precedence when both are supplied." }, "maxItems": { "title": "Maximum Review Items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of review records emitted across the whole run. Diagnostics do not consume this review-item limit.", "default": 50 }, "maxReviewsPerProduct": { "title": "Maximum Reviews Per Product", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum accepted review records collected for each product before moving to the next product.", "default": 50 }, "maxReviews": { "title": "Legacy Maximum Reviews Alias", "minimum": 1, "maximum": 500, "type": "integer", "description": "Backward-compatible alias used when maxItems or maxReviewsPerProduct is omitted." }, "maxProducts": { "title": "Maximum Search Products", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum distinct public product links resolved from a search query.", "default": 3 }, "pagination": { "title": "Pagination", "required": [], "type": "object", "description": "Controls review-page traversal. The Actor stops early when a page contains fewer than ten public review blocks.", "properties": { "enabled": { "title": "Follow Review Pages", "type": "boolean", "description": "Whether to request subsequent public review pages.", "default": true }, "startPage": { "title": "Start Page", "type": "integer", "description": "One-based public review page to start from.", "minimum": 1, "maximum": 500, "default": 1 }, "maxPages": { "title": "Maximum Review Pages", "type": "integer", "description": "Upper bound on public review pages requested per product.", "minimum": 1, "maximum": 50, "default": 50 } }, "additionalProperties": true }, "ratingFilter": { "title": "Rating Filter", "required": [], "type": "object", "description": "Optional rating filter. Use enabled with min/max or an explicit values list.", "properties": { "enabled": { "title": "Enable Rating Filter", "type": "boolean", "description": "Only emit reviews matching the configured rating bounds.", "default": false }, "min": { "title": "Minimum Rating", "type": "integer", "description": "Inclusive minimum review rating.", "minimum": 1, "maximum": 5, "default": 1 }, "max": { "title": "Maximum Rating", "type": "integer", "description": "Inclusive maximum review rating.", "minimum": 1, "maximum": 5, "default": 5 }, "values": { "title": "Allowed Ratings", "type": "array", "description": "Optional explicit list of allowed integer ratings from 1 through 5.", "items": { "type": "integer", "minimum": 1, "maximum": 5 }, "default": [] } }, "additionalProperties": true }, "dateFilter": { "title": "Date Filter", "required": [], "type": "object", "description": "Optional date filter. Relative public dates are converted to bounded ISO dates when possible; unparseable dates are excluded when enabled.", "properties": { "enabled": { "title": "Enable Date Filter", "type": "boolean", "description": "Only emit reviews whose visible date falls inside the configured range.", "default": false }, "from": { "title": "Date From", "type": "string", "description": "Inclusive start date in YYYY-MM-DD format.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "title": "Date To", "type": "string", "description": "Inclusive end date in YYYY-MM-DD format.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "additionalProperties": true }, "verifiedPurchaseOnly": { "title": "Verified Purchases Only", "type": "boolean", "description": "Only emit reviews visibly marked Verified Purchase or Certified Buyer.", "default": false }, "includeDetails": { "title": "Include Product Details", "type": "boolean", "description": "Open the public product detail page to collect seller, aggregate, variant, aspect, and product-context fields.", "default": true }, "includeMedia": { "title": "Include Public Media Links", "type": "boolean", "description": "Collect bounded public image URLs and review-media links observed in the product and review DOM.", "default": true }, "includeRaw": { "title": "Include Bounded Raw Public Objects", "type": "boolean", "description": "Include bounded visible-DOM excerpts and leaf text objects for auditability. Raw content is never executed.", "default": false }, "maxRawTextLength": { "title": "Raw Text Limit", "minimum": 200, "maximum": 5000, "type": "integer", "description": "Maximum characters retained in each bounded raw public text excerpt.", "default": 2000 }, "maxConcurrency": { "title": "Maximum Concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum number of independent public product browser sessions.", "default": 2 }, "pacing": { "title": "Request Pacing", "required": [], "type": "object", "description": "Randomized bounded delay between paginated public review requests and retries.", "properties": { "minDelayMs": { "title": "Minimum Delay (ms)", "type": "integer", "description": "Minimum delay in milliseconds.", "minimum": 0, "maximum": 15000, "default": 1000 }, "maxDelayMs": { "title": "Maximum Delay (ms)", "type": "integer", "description": "Maximum delay in milliseconds.", "minimum": 0, "maximum": 30000, "default": 2500 } }, "additionalProperties": true }, "maxRetries": { "title": "Maximum Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of retries after a transient navigation or extraction failure. Access barriers fail closed immediately.", "default": 2 }, "timeouts": { "title": "Timeouts", "required": [], "type": "object", "description": "Bounded public navigation, selector, and render wait limits.", "properties": { "navigationMs": { "title": "Navigation Timeout (ms)", "type": "integer", "description": "Maximum wait for a public page navigation.", "minimum": 5000, "maximum": 120000, "default": 45000 }, "selectorMs": { "title": "Selector Timeout (ms)", "type": "integer", "description": "Default Puppeteer selector timeout.", "minimum": 1000, "maximum": 60000, "default": 10000 }, "renderMs": { "title": "Render Wait (ms)", "type": "integer", "description": "Short bounded wait after DOM content load for visible review content.", "minimum": 0, "maximum": 10000, "default": 1500 } }, "additionalProperties": true }, "headless": { "title": "Headless Browser", "type": "boolean", "description": "Run Puppeteer without a visible browser window. Set false only in a runtime with a display.", "default": true }, "proxyConfiguration": { "title": "Apify Proxy Configuration", "required": [], "type": "object", "description": "Apify Proxy settings honored only when the runtime exposes Actor.createProxyConfiguration. No custom or private proxy endpoints are accepted.", "default": { "useApifyProxy": false }, "additionalProperties": 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 } } } } } } } } } }