{ "openapi": "3.0.1", "info": { "title": "WordPress.org Plugin Reviews & Plugin Intel Scraper", "description": "Scrape WordPress.org plugin reviews + intel (installs, rating, version). Star/date filters & only-new monitoring. Official API.", "version": "1.0", "x-build-id": "nSiYtKC2dE2Rdxd7U" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sotto-data~wordpress-plugin-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sotto-data-wordpress-plugin-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/sotto-data~wordpress-plugin-reviews/runs": { "post": { "operationId": "runs-sync-sotto-data-wordpress-plugin-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/sotto-data~wordpress-plugin-reviews/run-sync": { "post": { "operationId": "run-sync-sotto-data-wordpress-plugin-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": { "plugins": { "title": "Plugins", "type": "array", "description": "Plugin slugs or wordpress.org/plugins/… URLs, e.g. woocommerce or https://wordpress.org/plugins/contact-form-7/.", "default": [ "https://wordpress.org/plugins/contact-form-7/", "woocommerce" ], "items": { "type": "string" } }, "searchQueries": { "title": "Search queries (optional)", "type": "array", "description": "Discover plugins via the official WordPress.org plugin search API (e.g. seo, backup).", "default": [], "items": { "type": "string" } }, "maxPluginsPerSearch": { "title": "Max plugins per search", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many plugins to take from each search query.", "default": 10 }, "includePluginDetails": { "title": "Include plugin details", "type": "boolean", "description": "One 'plugin' item per slug from the official api.wordpress.org info API: installs, rating breakdown, version, tested-up-to, author, tags, support stats.", "default": true }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Scrape written reviews from the public WordPress.org support forum.", "default": true }, "maxReviewsPerPlugin": { "title": "Max reviews per plugin", "minimum": 0, "type": "integer", "description": "30 reviews per list page. 0 = skip reviews. Keep small for the Apify daily auto-test.", "default": 30 }, "fetchReviewBodies": { "title": "Fetch full review text + replies", "type": "boolean", "description": "Open each review topic to get the full body and any developer reply. Turn off for faster title-only monitoring.", "default": true }, "ratings": { "title": "Only these star ratings", "type": "array", "description": "Uses WordPress.org's own ?filter= star filter. Empty = all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "reviewsSince": { "title": "Reviews since (YYYY-MM-DD)", "type": "string", "description": "Keep only reviews on/after this date. Newest-first pagination stops at the first older review." }, "onlyNewReviews": { "title": "Only new reviews (monitoring)", "type": "boolean", "description": "Remember review IDs between runs and output only unseen ones. Schedule daily for review alerts.", "default": false }, "addReviewStats": { "title": "Add review stats to plugin item", "type": "boolean", "description": "Average, negative share and reply rate of the scraped reviews.", "default": true }, "maxConcurrency": { "title": "Plugins in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "Plugins scraped in parallel.", "default": 2 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Usually not needed for wordpress.org; enable if you see 403/429.", "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 }, "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 } } } } } } } } } }