{ "openapi": "3.0.1", "info": { "title": "Sitejabber Scraper (Reviews, Ratings and Replies)", "description": "Scrape Sitejabber (now SmartCustomer) reviews for any business: stars, title, text, date, verified purchase flag, sub-scores and the business reply, plus average stars, star breakdown and ratings from other review sites. Get only new reviews on schedules. No login. $0.50 per 1,000 rows.", "version": "0.1", "x-build-id": "l83pkVmuUApLxyo6h" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/locaihost~sitejabber-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-locaihost-sitejabber-reviews", "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/locaihost~sitejabber-reviews/runs": { "post": { "operationId": "runs-sync-locaihost-sitejabber-reviews", "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/locaihost~sitejabber-reviews/run-sync": { "post": { "operationId": "run-sync-locaihost-sitejabber-reviews", "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": { "companies": { "title": "Businesses", "type": "array", "description": "Businesses to read reviews for. Type the website domain (amazon.com) or paste a Sitejabber or SmartCustomer review link (https://www.sitejabber.com/reviews/amazon.com).", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Sitejabber category names or links, for example vpn, computers-technology or https://www.sitejabber.com/categories/clothing-apparel. Returns the top businesses the category page lists (up to 10), as business rows.", "items": { "type": "string" } }, "maxReviewsPerCompany": { "title": "Max reviews per business", "minimum": 0, "type": "integer", "description": "Newest first, 20 per page. 0 returns only the business row (stars, review count, star breakdown, sub-scores) with no reviews. Every page of a business's reviews is public, so a large number like 100000 gets them all (up to 2,000 pages).", "default": 100 }, "maxBusinessesPerCategory": { "title": "Max businesses per category", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many of the businesses a category page lists to return (it lists 10). 0 means all 10.", "default": 10 }, "reviewsForFoundBusinesses": { "title": "Also get reviews of businesses found in categories", "type": "boolean", "description": "Read the reviews of every business a category returns, using the review settings below. Their business rows are not repeated.", "default": false }, "includeCompanyInfo": { "title": "Business row for each business ($)", "type": "boolean", "description": "Add one business row per business in Businesses: average stars, review count, reviews in the last 12 months, star breakdown, service, value, shipping, returns and quality scores, categories, and the ratings the page shows from other review sites.", "default": true }, "stars": { "title": "Star ratings", "type": "array", "description": "Only reviews with these ratings. Leave empty for all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "dateFrom": { "title": "Published on or after", "type": "string", "description": "Only reviews published on or after this date. A date (2026-09-01) or a period (30 days, 6 months). The run stops reading a business at the first older review." }, "verifiedOnly": { "title": "Verified purchases only", "type": "boolean", "description": "Only reviews Sitejabber marks as a verified purchase.", "default": false }, "withRepliesOnly": { "title": "Only reviews with a business reply", "type": "boolean", "description": "Only reviews the business has publicly replied to.", "default": false }, "onlyNew": { "title": "Only new since the last run", "type": "boolean", "description": "Return only reviews that earlier runs with the same businesses and filters did not, and business rows only when their stars or review count changed. For daily or weekly schedules. A run with nothing new charges nothing.", "default": false }, "maxResults": { "title": "Max rows in total", "minimum": 0, "type": "integer", "description": "Stop after this many charged rows (reviews plus businesses) across the whole run. 0 means no limit.", "default": 0 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }