{ "openapi": "3.0.1", "info": { "title": "Sitejabber Scraper [PPR]", "description": "Scrape Sitejabber reviews, star ratings, business profiles, reviewer data, and star distributions. Enter company domains or category URLs. Filter by stars, date range, verified-only, or sort order. HTTP-only extraction — hundreds of reviews in seconds.", "version": "0.3", "x-build-id": "x1YDR47ARdaoYh4t2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zadexinho~sitejabber-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zadexinho-sitejabber-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/zadexinho~sitejabber-scraper/runs": { "post": { "operationId": "runs-sync-zadexinho-sitejabber-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/zadexinho~sitejabber-scraper/run-sync": { "post": { "operationId": "run-sync-zadexinho-sitejabber-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": { "companies": { "title": "Business Domains or URLs", "type": "array", "description": "Add business domains (e.g., amazon.com, ebay.com) or full Sitejabber URLs (e.g., https://www.sitejabber.com/reviews/amazon.com). One per entry.", "items": { "type": "string" } }, "categoryUrl": { "title": "Category URL", "type": "string", "description": "Enter a Sitejabber category URL to discover and scrape all businesses in that category (e.g., https://www.sitejabber.com/online-business/shopping)." }, "maxReviewsPerCompany": { "title": "Max Reviews Per Business", "minimum": 0, "type": "integer", "description": "Set the maximum number of reviews to scrape per business. Use 0 for unlimited.", "default": 100 }, "sort": { "title": "Sort Order", "enum": [ "most_recent", "highest_rated", "lowest_rated", "most_helpful" ], "type": "string", "description": "Select how reviews are sorted.", "default": "most_recent" }, "stars": { "title": "Star Rating Filter", "type": "array", "description": "Select star ratings to include. Leave empty for all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "dateRange": { "title": "Date Range", "enum": [ "", "lastWeek", "lastMonth", "last6months", "lastYear" ], "type": "string", "description": "Select a time period to filter reviews.", "default": "" }, "verifiedOnly": { "title": "Verified Reviews Only", "type": "boolean", "description": "Return only reviews marked as verified by Sitejabber.", "default": false }, "withRepliesOnly": { "title": "With Business Replies Only", "type": "boolean", "description": "Return only reviews that have a reply from the business.", "default": false }, "includeBusinessInfo": { "title": "Include Business Info", "type": "boolean", "description": "Attach business metadata (name, overall rating, total reviews, categories) to each review.", "default": true }, "includeReviewerInfo": { "title": "Include Reviewer Info", "type": "boolean", "description": "Attach reviewer metadata (display name, review count, helpful votes) to each review.", "default": true }, "startPage": { "title": "Start Page", "minimum": 1, "type": "integer", "description": "Page number to start scraping from. Use for incremental scraping (e.g., start from page 5 if you already have pages 1-4).", "default": 1 }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Set the delay between HTTP requests in milliseconds. Increase to 1000+ if you experience rate limiting.", "default": 300 }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Configure proxy settings. Not required for most use cases — Sitejabber has minimal anti-bot protection.", "default": { "useApifyProxy": 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 } } } } } } } } } }