{ "openapi": "3.0.1", "info": { "title": "Target Product Reviews Scraper - Ratings & Text", "description": "Scrape Target product reviews from URLs or TCINs. Export ratings, text, verified status, customer media, votes, topics, timestamps, product aggregates, and canonical source URLs to JSON, CSV, or Excel. Built for review monitoring, research, and agent workflows. Pay only per saved review.", "version": "1.0", "x-build-id": "lwO5uM8TaeYOS3uzW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~target-product-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-target-product-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/khadinakbar~target-product-reviews-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-target-product-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/khadinakbar~target-product-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-target-product-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", "required": [ "productUrls" ], "properties": { "productUrls": { "title": "Target product URLs or TCINs", "minItems": 1, "maxItems": 100, "type": "array", "description": "Add one Target product page URL or 8–12 digit TCIN per line. Slugged URLs and canonical /A-{TCIN} URLs are accepted. Duplicate products are processed once. Other domains are rejected before any network request.", "items": { "type": "string", "minLength": 1 }, "default": [ "https://www.target.com/p/-/A-89827259" ] }, "maxReviews": { "title": "Maximum reviews for the run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Sets the hard billing and output cap across all products. The Actor checks this limit before every paid dataset write. The default of 50 costs at most $0.90 in review events. Choose 1–5,000 depending on your workload.", "default": 50 }, "maxReviewsPerProduct": { "title": "Maximum reviews per product", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Caps paid review rows for each individual product. This prevents one popular item from consuming the whole run. The whole-run maxReviews cap still takes precedence. Choose 1–1,000; the default is 50.", "default": 50 }, "sortBy": { "title": "Review order", "enum": [ "most_recent", "highest_rating", "lowest_rating", "helpfulness_desc" ], "type": "string", "description": "Controls the order requested from Target. Most recent is useful for monitoring fresh feedback. Highest and lowest rating support sentiment analysis. Most helpful prioritizes reviews voted useful by shoppers.", "default": "most_recent" }, "ratings": { "title": "Star ratings", "maxItems": 5, "uniqueItems": true, "type": "array", "description": "Optionally list exact star ratings to include, such as [1] or [4, 5]. Leave the array empty to include every rating. Values must be unique integers from 1 through 5. Filters are applied upstream before billing.", "items": { "type": "integer", "minimum": 1, "maximum": 5 }, "default": [] }, "verifiedOnly": { "title": "Verified reviews only", "type": "boolean", "description": "Enable this to request only reviews Target marks as verified. Disable it to include verified and unverified reviews. The flag comes directly from Target and is not inferred. Filtering happens before rows are saved or billed.", "default": false }, "hasOnlyPhotos": { "title": "Reviews with photos only", "type": "boolean", "description": "Enable this to request only reviews with customer photos. Disable it to include reviews with or without photos. Photo URLs are returned in the photos array. Filtering happens before rows are saved or billed.", "default": false }, "hasOnlyVideos": { "title": "Reviews with videos only", "type": "boolean", "description": "Enable this to request only reviews with customer videos. Disable it to include reviews with or without videos. Video URLs are returned when Target exposes them. A valid filter with no matches returns VALID_EMPTY rather than an error.", "default": false } } }, "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 } } } } } } } } } }