{ "openapi": "3.0.1", "info": { "title": "People Also Ask Question Extractor", "description": "Extract People Also Ask questions and visible answer/source snippets from SERP snapshots for content planning and FAQ research.", "version": "1.0", "x-build-id": "5rd4MAoII91wRSqyO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~people-also-ask-question-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-people-also-ask-question-extractor", "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/junipr~people-also-ask-question-extractor/runs": { "post": { "operationId": "runs-sync-junipr-people-also-ask-question-extractor", "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/junipr~people-also-ask-question-extractor/run-sync": { "post": { "operationId": "run-sync-junipr-people-also-ask-question-extractor", "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": { "startUrls": { "title": "Public snapshot/page URLs", "type": "array", "description": "Optional explicit public URLs. Private, loopback, and non-HTTP targets are rejected.", "items": { "type": "string" }, "default": [] }, "sitemapUrls": { "title": "Sitemap URLs", "type": "array", "description": "Optional public XML sitemap URLs constrained by allowedDomains.", "items": { "type": "string" }, "default": [] }, "htmlInputs": { "title": "HTML inputs", "type": "array", "description": "Deterministic HTML objects with sourceId, sourceUrl, html/currentHtml, and optional query.", "items": { "type": "object", "additionalProperties": true }, "default": [] }, "allowedDomains": { "title": "Allowed domains", "type": "array", "description": "Optional hostname allowlist for network fetches.", "items": { "type": "string" }, "default": [] }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 25, "type": "integer", "description": "Overall hard cap on HTML targets processed.", "default": 1 }, "maxDepth": { "title": "Maximum crawl depth", "minimum": 0, "maximum": 0, "type": "integer", "description": "Reserved at zero: this runtime does not follow discovered links.", "default": 0 }, "includeEvidence": { "title": "Include evidence", "type": "boolean", "description": "Include visible evidence snippets in dataset rows.", "default": true }, "includeRawSnapshots": { "title": "Store raw snapshots", "type": "boolean", "description": "Store capped supplied/fetched HTML in key-value storage.", "default": false }, "requestDelayMs": { "title": "Request delay", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Delay between permitted fetches.", "default": 250 }, "timeoutMs": { "title": "Request timeout", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "Per-request timeout in milliseconds.", "default": 15000 }, "userAgentMode": { "title": "User agent mode", "enum": [ "standard", "compatibility" ], "type": "string", "description": "Use the standard actor agent or a compatibility browser-style agent.", "default": "standard" }, "queries": { "title": "Search queries", "type": "array", "description": "Queries associated with supplied snapshots.", "items": { "type": "string" }, "default": [ "project management software" ] }, "serpHtmlInputs": { "title": "SERP HTML inputs", "type": "array", "description": "Captured SERP HTML objects containing visible People Also Ask markup.", "items": { "type": "object", "additionalProperties": true }, "default": [] }, "maxQueries": { "title": "Maximum queries", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum distinct queries processed.", "default": 1 }, "maxSnapshots": { "title": "Maximum snapshots", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum supplied or fetched snapshots processed.", "default": 1 }, "maxQuestionsPerQuery": { "title": "Questions per query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum visible question records emitted per query.", "default": 20 }, "maxBrowserPages": { "title": "Maximum fetched pages", "minimum": 1, "maximum": 25, "type": "integer", "description": "Hard cap on explicitly supplied public snapshot URLs fetched.", "default": 1 }, "expandQuestionsWhenPossible": { "title": "Request expanded-answer evidence", "type": "boolean", "description": "Report when an expanded answer is absent; this runtime does not simulate browser clicks.", "default": false }, "dedupeQuestions": { "title": "Deduplicate questions", "type": "boolean", "description": "Emit one row per normalized question.", "default": true }, "questionClusterMode": { "title": "Question clustering", "enum": [ "intent", "none" ], "type": "string", "description": "Apply deterministic intent clusters or disable clustering.", "default": "intent" }, "maxChargeUsd": { "title": "Maximum charge", "minimum": 0, "type": "number", "description": "Maximum accepted PPE spend before the actor stops without emitting unpaid output.", "default": 50 }, "includeReport": { "title": "Write reports", "type": "boolean", "description": "Write Markdown, CSV, JSON evidence, and run metadata to key-value storage.", "default": true } } }, "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 } } } } } } } } } }