{ "openapi": "3.0.1", "info": { "title": "Serp Feature Opportunity Finder", "description": "Scrape Google SERPs to find Featured Snippet and People Also Ask (PAA) opportunities. Automatically track competitor gaps, check your organic position, and get actionable content suggestions to win SERP features without ongoing rank-tracking costs.", "version": "1.0", "x-build-id": "90n8TKjplYNlmIOyK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apage~serp-feature-opportunity-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apage-serp-feature-opportunity-finder", "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/apage~serp-feature-opportunity-finder/runs": { "post": { "operationId": "runs-sync-apage-serp-feature-opportunity-finder", "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/apage~serp-feature-opportunity-finder/run-sync": { "post": { "operationId": "run-sync-apage-serp-feature-opportunity-finder", "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", "required": [ "keywords" ], "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "List of search queries to analyze. The Actor will scrape the current SERP for each keyword and produce one result item per keyword with SERP features, your ranking (if yourDomain is set), and opportunity suggestions.", "items": { "type": "string" } }, "yourDomain": { "title": "Your domain", "type": "string", "description": "The domain to check for presence in SERP features and organic results (e.g. example.com). Do not include protocol (http/https). When provided, the Actor will report your organic position, whether you hold the featured snippet or appear in PAA, and tailor opportunity and content suggestions. Leave empty for a feature-only audit without “your site” analysis." }, "competitorDomains": { "title": "Competitor domains", "type": "array", "description": "List of competitor domains to track (e.g. competitor.com). The Actor will check if they hold the featured snippet or appear in PAA, giving you a competitive gap analysis.", "items": { "type": "string" } }, "apifyToken": { "title": "Apify Token", "type": "string", "description": "Your Apify API token (starts with 'apify_api_'). Required only if you're on a plan that restricts public Actor execution. Providing this token allows the tool to run the underlying Google Scraper using your account's access." }, "country": { "title": "Country", "type": "string", "description": "Country code for SERP geography (e.g. US, UK, DE). Used when fetching Google search results so SERPs match the target market.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Language code for search results (e.g. en, es, de). Affects the language of the SERP and results.", "default": "en" }, "maxKeywords": { "title": "Max keywords", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of keywords to process. Caps the run to avoid excessive cost and run time. If the keywords array has more than this number, only the first maxKeywords are processed.", "default": 100 }, "maxOrganicResults": { "title": "Max organic results to check", "minimum": 10, "maximum": 100, "type": "integer", "description": "How many organic results to consider when determining “your” position. The Actor will report your first occurrence within this range (1-based position, or 0 if not found).", "default": 20 }, "includePaaQuestions": { "title": "Include PAA questions", "type": "boolean", "description": "If true, the output will include the full list of People Also Ask questions in paaQuestions for each keyword. If false, PAA presence is still reported but the question list may be omitted or truncated to save output size.", "default": true }, "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "If true, SERP requests are sent through Apify Proxy to reduce blocking. Recommended for production runs.", "default": true }, "delayBetweenRequestsMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Delay in milliseconds between processing each keyword. Helps avoid rate limiting when scraping SERPs.", "default": 2000 } } }, "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 } } } } } } } } } }