{ "openapi": "3.0.1", "info": { "title": "Keyword Gap — Keywords Your Competitors Rank For", "description": "Compare your domain against competitors and get every keyword they rank for that you're missing, plus keywords where they outrank you. Sorted by search volume. Excel export included.", "version": "0.1", "x-build-id": "DVgoPkRslspBMQOk2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/amassuo~semrush-keyword-gap/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-amassuo-semrush-keyword-gap", "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/amassuo~semrush-keyword-gap/runs": { "post": { "operationId": "runs-sync-amassuo-semrush-keyword-gap", "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/amassuo~semrush-keyword-gap/run-sync": { "post": { "operationId": "run-sync-amassuo-semrush-keyword-gap", "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": [ "yourDomain" ], "properties": { "yourDomain": { "title": "Your domain", "type": "string", "description": "The domain you want to find gaps for, e.g. moz.com" }, "competitorDomains": { "title": "Competitor domains", "type": "array", "description": "Competitors to compare against.", "items": { "type": "string" } }, "competitorsText": { "title": "Competitors (bulk paste)", "type": "string", "description": "Alternative: paste competitor domains separated by new lines or commas." }, "database": { "title": "Database (country market)", "type": "string", "description": "Semrush country database: us, uk, de, fr, es, it, ca, au, in…", "default": "us" }, "maxKeywordsPerDomain": { "title": "Max keywords per domain", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Keywords pulled per domain (yours and each competitor), highest traffic first. Drives both depth and cost.", "default": 1000 }, "minVolume": { "title": "Minimum search volume", "minimum": 0, "type": "integer", "description": "Ignore keywords below this monthly volume. Applied by Semrush before billing, so it also reduces cost." }, "maxPosition": { "title": "Maximum position", "minimum": 1, "maximum": 100, "type": "integer", "description": "Only consider keywords ranking at or above this position (e.g. 20)." }, "gapTypes": { "title": "Gap types to return", "type": "array", "description": "missing = they rank, you don't at all. weak = you both rank but they beat you.", "items": { "type": "string", "enum": [ "missing", "weak" ], "enumTitles": [ "Missing (you don't rank)", "Weak (they outrank you)" ] }, "default": [ "missing", "weak" ] }, "xlsxOutput": { "title": "Excel (.xlsx) export", "type": "boolean", "description": "Also save a formatted Excel file to the run's key-value store.", "default": true }, "semrushApiKey": { "title": "Semrush API key (optional override)", "type": "string", "description": "Optional. Normally the operator sets SEMRUSH_API_KEY as an actor environment variable." }, "excludeKeywords": { "title": "Exclude keywords containing", "type": "array", "description": "Drop keywords containing any of these terms (case-insensitive). Applied by Semrush before billing where possible, so it also reduces cost. Useful for stripping irrelevant/brand/adult terms big domains rank for.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }