{ "openapi": "3.0.1", "info": { "title": "SERP Topic Gap Monitor", "description": "Find the topics your competitors rank for that your site is missing. This SEO content gap analyzer accepts pre-fetched SERP data, extracts topics from competitor pages, and returns a scored gap report for content planning and competitive analysis.", "version": "0.1", "x-build-id": "mechiAjKKM4jVUaN4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/joeslade~serp-topic-gap-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-joeslade-serp-topic-gap-monitor", "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/joeslade~serp-topic-gap-monitor/runs": { "post": { "operationId": "runs-sync-joeslade-serp-topic-gap-monitor", "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/joeslade~serp-topic-gap-monitor/run-sync": { "post": { "operationId": "run-sync-joeslade-serp-topic-gap-monitor", "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": [ "targetDomain", "serpResults" ], "properties": { "targetDomain": { "title": "Target domain", "minLength": 1, "maxLength": 200, "type": "string", "description": "Domain to evaluate gaps for (e.g. \"example.com\"). The actor checks which topics this domain is missing relative to competitors." }, "serpResults": { "title": "SERP results", "minItems": 1, "maxItems": 20, "type": "array", "description": "Pre-fetched SERP data. Each entry represents one keyword's search results with page content already extracted.", "items": { "type": "object", "required": [ "keyword", "organicResults" ], "properties": { "keyword": { "title": "Keyword", "type": "string", "description": "The search keyword this result set corresponds to." }, "organicResults": { "title": "Organic results", "type": "array", "description": "Top organic search results for this keyword.", "maxItems": 20, "items": { "type": "object", "required": [ "url", "title" ], "properties": { "url": { "title": "URL", "type": "string", "description": "URL of the search result." }, "title": { "title": "Title", "type": "string", "description": "Title of the search result." }, "snippet": { "title": "Snippet", "type": "string", "description": "Search result snippet text." }, "pageContent": { "title": "Page content", "type": "string", "description": "Extracted text content of the page (plain text, no HTML). If omitted, only title and snippet are used for topic extraction." } } } } } } }, "locale": { "title": "Locale", "type": "string", "description": "Locale of the SERP data, e.g. \"en\", \"de\", \"ja\". Stored in output metadata for downstream tracking. Set this when analyzing non-English markets.", "default": "en" }, "country": { "title": "Country", "type": "string", "description": "Country code for the SERP data, e.g. \"us\", \"gb\", \"de\". Stored in output metadata for downstream tracking. Useful when running gap analyses across multiple markets.", "default": "us" }, "minGapScore": { "title": "Minimum gap score", "minimum": 0, "maximum": 1, "type": "number", "description": "Minimum gap score (0-1) to include in output. Raise this (e.g. 0.3) to filter out low-signal gaps and focus on topics where many competitors outrank you.", "default": 0 } } }, "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 } } } } } } } } } }