{ "openapi": "3.0.1", "info": { "title": "People Also Ask Scraper", "description": "Extract Google's People Also Ask questions for keywords, with optional tree expansion for multi-level questions. Perfect for SEO content research, topic cluster creation, FAQ generation, and content brief development.", "version": "1.0", "x-build-id": "bU0UCAJarJRHxt7hv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/happitap~people-also-ask-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-happitap-people-also-ask-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/happitap~people-also-ask-scraper/runs": { "post": { "operationId": "runs-sync-happitap-people-also-ask-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/happitap~people-also-ask-scraper/run-sync": { "post": { "operationId": "run-sync-happitap-people-also-ask-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": { "keywords": { "title": "Keywords", "type": "array", "description": "Array of keywords to search for PAA questions", "items": { "type": "string" } }, "keywordsText": { "title": "Keywords Text", "type": "string", "description": "Multiline string with keywords (one per line)" }, "inputDatasetId": { "title": "Input Dataset ID", "type": "string", "description": "Read keywords from existing dataset (optional)" }, "country": { "title": "Country", "pattern": "^[A-Z]{2}$", "type": "string", "description": "Two-letter ISO country code", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Language code (BCP-47 or simple)", "default": "en" }, "gl": { "title": "Google GL Parameter", "type": "string", "description": "Override Google 'gl' parameter for country targeting" }, "hl": { "title": "Google HL Parameter", "type": "string", "description": "Override Google 'hl' parameter for language targeting" }, "uule": { "title": "UULE Parameter", "type": "string", "description": "Encoded location for city-level geo targeting (optional)" }, "device": { "title": "Device", "enum": [ "desktop", "mobile" ], "type": "string", "description": "Device type for search", "default": "desktop" }, "mode": { "title": "Extraction Mode", "enum": [ "paa_only", "paa_tree" ], "type": "string", "description": "PAA extraction mode", "default": "paa_only" }, "treeDepth": { "title": "Tree Depth", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum depth for tree expansion (only for paa_tree mode)", "default": 2 }, "maxQuestionsPerKeyword": { "title": "Max Questions per Keyword", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of questions to extract per keyword", "default": 80 }, "maxExpansions": { "title": "Max Expansions", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of question expansions in tree mode", "default": 40 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify proxy configuration for avoiding Google blocks. Residential proxies are recommended for Google scraping.", "default": { "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum concurrent requests", "default": 3 }, "requestRetries": { "title": "Request Retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Number of retries for failed requests", "default": 3 }, "minDelayMs": { "title": "Min Delay (ms)", "minimum": 100, "maximum": 10000, "type": "integer", "description": "Minimum delay between requests in milliseconds", "default": 2000 }, "maxDelayMs": { "title": "Max Delay (ms)", "minimum": 100, "maximum": 30000, "type": "integer", "description": "Maximum delay between requests in milliseconds", "default": 5000 }, "timeoutSecs": { "title": "Timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Request timeout in seconds", "default": 30 }, "outputFormat": { "title": "Output Format", "enum": [ "dataset", "json", "csv" ], "type": "string", "description": "Output format for results", "default": "dataset" }, "dedupe": { "title": "Deduplicate", "type": "boolean", "description": "Remove duplicate questions", "default": true }, "includeSerpMeta": { "title": "Include SERP Meta", "type": "boolean", "description": "Include SERP metadata (URL, timestamp, etc.)", "default": true }, "includeAnswerSnippets": { "title": "Include Answer Snippets", "type": "boolean", "description": "Extract answer snippets when available", "default": 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 } } } } } } } } } }