{ "openapi": "3.0.1", "info": { "title": "G2 Reviews Scraper", "description": "A robust, high-performance utility designed for developer automation, data integration, and AI training. Features built-in captcha bypass, headful/headless browser execution, and proxy support to scrape G2 Reviews data seamlessly, reliably, and at scale.", "version": "1.0", "x-build-id": "dkSLRW85IjhlsFcAD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codingfrontend~g2-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codingfrontend-g2-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~g2-reviews-scraper/runs": { "post": { "operationId": "runs-sync-codingfrontend-g2-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~g2-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-codingfrontend-g2-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": "Mode", "enum": [ "productUrl", "search" ], "type": "string", "description": "Use known product URLs or resolve one product through G2 public search.", "default": "productUrl" }, "productUrls": { "title": "Product URLs", "maxItems": 5, "type": "array", "description": "One to five public G2 product URLs in productUrl mode.", "items": { "type": "object", "properties": { "url": { "type": "string", "title": "G2 product URL", "description": "A public URL under g2.com/products/." } }, "required": [ "url" ], "additionalProperties": false }, "default": [ { "url": "https://www.g2.com/products/slack/reviews" } ] }, "searchQuery": { "title": "Product search", "maxLength": 100, "type": "string", "description": "Product name used in search mode." }, "maxItems": { "title": "Maximum reviews", "minimum": 1, "maximum": 100, "type": "integer", "description": "Global cap for unique review rows.", "default": 20 }, "startPage": { "title": "Starting page", "minimum": 1, "maximum": 20, "type": "integer", "description": "First review page number to request.", "default": 1 }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 5, "type": "integer", "description": "Per-product pagination safety cap.", "default": 3 }, "sortReviews": { "title": "Sort results", "enum": [ "most_recent", "most_helpful", "highest_rated", "lowest_rated" ], "type": "string", "description": "Local order applied after public extraction.", "default": "most_recent" }, "filters": { "title": "Local filters", "type": "object", "description": "Optional filters applied only to fields visible in public review cards.", "properties": { "minRating": { "title": "Minimum rating", "type": "number", "description": "Minimum public rating.", "minimum": 0, "maximum": 5 }, "maxRating": { "title": "Maximum rating", "type": "number", "description": "Maximum public rating.", "minimum": 0, "maximum": 5 }, "reviewerRole": { "title": "Reviewer role", "type": "string", "description": "Case-insensitive role substring." }, "reviewerIndustry": { "title": "Reviewer industry", "type": "string", "description": "Case-insensitive industry substring." }, "reviewerSegment": { "title": "Reviewer segment", "type": "string", "description": "Case-insensitive segment substring." }, "reviewSource": { "title": "Review source", "type": "string", "description": "Case-insensitive public source-tag substring." }, "isVerified": { "title": "Verified", "type": "boolean", "description": "Keep reviews matching the public verification flag." }, "isIncentivized": { "title": "Incentivized", "type": "boolean", "description": "Keep reviews matching the public incentive flag." } }, "additionalProperties": false }, "includeReviewDetails": { "title": "Include review details", "type": "boolean", "description": "Include visible full text and structured answers.", "default": true }, "includeMedia": { "title": "Include media", "type": "boolean", "description": "Include publicly displayed product media URLs.", "default": true }, "includeRatings": { "title": "Include ratings", "type": "boolean", "description": "Include review and product ratings.", "default": true }, "requestDelayMs": { "title": "Request delay (ms)", "minimum": 250, "maximum": 10000, "type": "integer", "description": "Minimum spacing between consecutive public requests.", "default": 750 }, "requestTimeoutMs": { "title": "Request timeout (ms)", "minimum": 5000, "maximum": 60000, "type": "integer", "description": "Per-request timeout.", "default": 30000 }, "maxAttempts": { "title": "Maximum attempts", "minimum": 1, "maximum": 2, "type": "integer", "description": "One or two attempts for transient network or server failures; access boundaries are never retried.", "default": 2 }, "maxRunMillis": { "title": "Actor-side deadline (ms)", "minimum": 30000, "maximum": 300000, "type": "integer", "description": "Maximum actor-side work duration.", "default": 120000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy for ordinary public requests. Access boundaries stop the run.", "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 } } } } } } } } } }