{ "openapi": "3.0.1", "info": { "title": "WordPress & WooCommerce Plugin Scraper: Stats & Churn Leads", "description": "Extract WordPress.org and WooCommerce plugin active installs, historical downloads, unresolved support ticket ratios, abandonware risk flags, commercial URLs, and 1-5 star user reviews with churn classification.", "version": "1.0", "x-build-id": "IUvfkb4K0k1e8FyNe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/storeintel~wordpress-plugin-directory-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-storeintel-wordpress-plugin-directory-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/storeintel~wordpress-plugin-directory-scraper/runs": { "post": { "operationId": "runs-sync-storeintel-wordpress-plugin-directory-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/storeintel~wordpress-plugin-directory-scraper/run-sync": { "post": { "operationId": "run-sync-storeintel-wordpress-plugin-directory-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": { "pluginSlugsOrUrls": { "title": "Plugin Slugs or WordPress.org URLs", "type": "array", "description": "List of WordPress.org plugin slugs (e.g. 'woocommerce', 'elementor', 'contact-form-7') or full URLs ('https://wordpress.org/plugins/woocommerce/').", "default": [ "woocommerce", "elementor" ], "items": { "type": "string" } }, "searchQueries": { "title": "Search Queries (Optional Discovery)", "type": "array", "description": "Optional keywords (e.g. 'woocommerce checkout', 'seo', 'booking calendar') to discover plugins via the WordPress.org API.", "default": [], "items": { "type": "string" } }, "tagSlugs": { "title": "Tag Slugs (Optional Niche Discovery)", "type": "array", "description": "Optional WordPress plugin tags (e.g. 'woocommerce', 'blocks', 'ai', 'payment-gateway') to discover plugins in a specific tag.", "default": [], "items": { "type": "string" } }, "maxPluginsPerQuery": { "title": "Max Plugins per Search Query or Tag", "minimum": 1, "maximum": 250, "type": "integer", "description": "Maximum number of plugins to discover per search query or tag.", "default": 25 }, "scrapePluginProfiles": { "title": "Extract Plugin Profiles, Installs & Support Metrics", "type": "boolean", "description": "Fetch full plugin metadata, active installs, total downloads, support resolution rate, abandonware risk flag, and commercial URLs (triggers 'plugin-profile-scraped' event).", "default": true }, "scrapeReviews": { "title": "Extract User Reviews & Churn Leads", "type": "boolean", "description": "Fetch individual user reviews with star ratings, author profile, reply count, and pain-point classification (triggers 'review-scraped' event).", "default": true }, "maxReviewsPerPlugin": { "title": "Max Reviews per Plugin", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of user reviews to extract per plugin.", "default": 20 }, "reviewRatings": { "title": "Filter by Star Ratings (Optional)", "type": "array", "description": "Filter reviews by star ratings (e.g. [1, 2] for dissatisfied users and churn leads, or [] for all ratings 1-5).", "default": [ 1, 2 ] }, "onlyChurnLeads": { "title": "Only Emit Dissatisfied / Churn Leads", "type": "boolean", "description": "When enabled, only emits reviews flagged with is_churn_lead = true.", "default": false }, "maxSpendUsd": { "title": "Maximum Run Spend Cap (USD)", "minimum": 0.05, "type": "number", "description": "Safety cap in USD for Pay-Per-Event billing.", "default": 10 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional Apify Proxy settings.", "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 } } } } } } } } } }