{ "openapi": "3.0.1", "info": { "title": "Content Gap By SERP Pages Auditor", "description": "Compare owned pages against top-ranking SERP pages to identify missing subtopics, headings, FAQs, entities, media signals, and content-format gaps", "version": "1.0", "x-build-id": "fz7uKv5ecfoSUfxEp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~content-gap-by-serp-pages-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-content-gap-by-serp-pages-auditor", "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~content-gap-by-serp-pages-auditor/runs": { "post": { "operationId": "runs-sync-junipr-content-gap-by-serp-pages-auditor", "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~content-gap-by-serp-pages-auditor/run-sync": { "post": { "operationId": "run-sync-junipr-content-gap-by-serp-pages-auditor", "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": { "ownedUrls": { "title": "Owned page URLs", "type": "array", "description": "Public owned-page URLs to compare.", "items": { "type": "string" }, "default": [] }, "competitorUrls": { "title": "Competitor page URLs", "type": "array", "description": "Public competitor-page URLs for the same target queries.", "items": { "type": "string" }, "default": [] }, "serpResults": { "title": "Structured SERP evidence", "type": "array", "description": "Query-linked owned and competitor page snapshots. Each record may include query, ownedUrl, ownedHtml, and a competitors array with url, title, snippet, html, or text.", "items": { "type": "object" }, "default": [] }, "targetQueries": { "title": "Target queries", "type": "array", "description": "Queries used to group owned and competitor evidence.", "items": { "type": "string" }, "default": [ "project management software" ] }, "gapDimensions": { "title": "Gap dimensions", "type": "array", "description": "Observable page-signal groups to compare.", "items": { "type": "string" }, "default": [ "topics", "questions", "formats", "entities" ] }, "maxOwnedPages": { "title": "Maximum owned pages per query", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum owned pages to compare for each query.", "default": 5 }, "maxCompetitorPages": { "title": "Maximum competitor pages per query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum competitor pages to compare for each query.", "default": 10 }, "maxQueries": { "title": "Maximum queries", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum search queries or topics to evaluate in one run.", "default": 10 }, "maxSectionsPerPage": { "title": "Maximum gaps per query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum page sections to inspect per source page.", "default": 25 }, "minCompetitorFrequency": { "title": "Minimum competitor frequency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Minimum number of accepted competitor pages that must show a signal before it can be emitted as a gap.", "default": 1 }, "startUrls": { "title": "Additional page URLs", "type": "array", "description": "Optional public URLs. Use ownedUrls and competitorUrls when roles matter.", "items": { "type": "string" }, "default": [] }, "sitemapUrls": { "title": "Sitemap URLs", "type": "array", "description": "Optional public XML sitemap URLs. Accepted page URLs remain bounded by maxPages.", "items": { "type": "string" }, "default": [] }, "htmlInputs": { "title": "Captured page HTML", "type": "array", "description": "Optional captured HTML records with sourceUrl, html or currentHtml, role, and query.", "items": { "type": "object" }, "default": [] }, "allowedDomains": { "title": "Allowed domains", "type": "array", "description": "Optional hostname allowlist for fetched pages.", "items": { "type": "string" }, "default": [] }, "maxPages": { "title": "Maximum fetched pages", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum pages to fetch in one run.", "default": 1 }, "maxDepth": { "title": "Link depth", "minimum": 0, "maximum": 0, "type": "integer", "description": "General link discovery is disabled.", "default": 0 }, "includeEvidence": { "title": "Include evidence", "type": "boolean", "description": "Include short source evidence snippets in output rows.", "default": true }, "includeRawSnapshots": { "title": "Store raw snapshots", "type": "boolean", "description": "Opt in to raw HTML artifacts in key-value storage.", "default": false }, "requestDelayMs": { "title": "Request delay in milliseconds", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Delay in milliseconds between outbound page requests.", "default": 250 }, "timeoutMs": { "title": "Request timeout in milliseconds", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "Maximum time in milliseconds to wait for a page request.", "default": 15000 }, "userAgentMode": { "title": "User-agent mode", "enum": [ "standard", "browser" ], "type": "string", "description": "User agent profile to use for public page requests.", "default": "standard" }, "maxChargeUsd": { "title": "Maximum charge", "minimum": 0, "maximum": 35, "type": "number", "description": "Maximum estimated PPE spend before the actor exits gracefully.", "default": 35 }, "includeReport": { "title": "Write reports", "type": "boolean", "description": "Write the markdown summary report to the run key-value store.", "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 } } } } } } } } } }