{
"openapi": "3.0.1",
"info": {
"title": "Keyword Gap & Opportunity Report - Competitor Keyword Gap",
"description": "Keywords up to 3 competitors rank for on Google and your client's domain doesn't: volume, difficulty, intent, competing URLs and why each was picked. Top 20 re-checked on the live Google top 10. CSV-ready dataset + HTML report. One flat price per report.",
"version": "1.0",
"x-build-id": "x7OJcuaomGoMofEIg"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/wrenfield-data~keyword-gap-report/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-wrenfield-data-keyword-gap-report",
"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/wrenfield-data~keyword-gap-report/runs": {
"post": {
"operationId": "runs-sync-wrenfield-data-keyword-gap-report",
"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/wrenfield-data~keyword-gap-report/run-sync": {
"post": {
"operationId": "run-sync-wrenfield-data-keyword-gap-report",
"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": [
"clientDomain",
"competitors"
],
"properties": {
"clientDomain": {
"title": "Your (or your client's) domain",
"type": "string",
"description": "The site you want new keywords for, e.g. helpscout.com. https://, www. and paths are removed."
},
"competitors": {
"title": "Competitor domains (up to 3)",
"minItems": 1,
"maxItems": 3,
"type": "array",
"description": "1 to 3 competitors that rank where you want to rank, e.g. zendesk.com. Pick real search competitors (the sites that outrank you), not only business rivals.",
"items": {
"type": "string"
}
},
"location": {
"title": "Country",
"type": "string",
"description": "Country of the Google results: name (United States), 2-letter code (GB) or location code (2840).",
"default": "United States"
},
"language": {
"title": "Language",
"type": "string",
"description": "Language name or code (English, de). Empty = main language of the country."
},
"excludeTerms": {
"title": "Exclude keywords containing",
"type": "array",
"description": "Drop keywords that contain any of these words or phrases, e.g. jobs, free download, your own brand. Case-insensitive.",
"items": {
"type": "string"
}
},
"excludeCompetitorBrands": {
"title": "Exclude competitor brand searches",
"type": "boolean",
"description": "Drop keywords containing a competitor's name taken from its domain (for example zendesk from zendesk.com). Usually what you want: you can't win \"zendesk pricing\".",
"default": true
},
"topicTerms": {
"title": "Only keywords about (optional)",
"type": "array",
"description": "Keep only keywords containing at least one of these words, e.g. help desk, support, ticket. Useful when competitors are broad sites.",
"items": {
"type": "string"
}
},
"minSearchVolume": {
"title": "Minimum monthly searches",
"minimum": 0,
"type": "integer",
"description": "Skip keywords with fewer Google searches a month. 0 also keeps keywords whose volume is unavailable.",
"default": 30
},
"maxKeywordDifficulty": {
"title": "Maximum keyword difficulty",
"minimum": 0,
"maximum": 100,
"type": "integer",
"description": "Skip keywords harder than this (0-100). 100 = no limit.",
"default": 100
},
"maxCompetitorPosition": {
"title": "Competitor must rank in the top",
"minimum": 1,
"maximum": 100,
"type": "integer",
"description": "Only count a competitor ranking at this position or better. 20 = first two pages (recommended); 10 = page one only.",
"default": 20
},
"includeNavigational": {
"title": "Include navigational searches",
"type": "boolean",
"description": "Keep brand and login searches (\"x login\", \"x support phone\"). Off by default: they are rarely winnable.",
"default": false
},
"includeCompetitorSubdomains": {
"title": "Count competitor subdomains",
"type": "boolean",
"description": "Also count rankings on competitor subdomains. Off by default, because hosted subdomains (for example customer help centers on *.zendesk.com) are not the competitor's own content.",
"default": false
},
"candidatesPerCompetitor": {
"title": "Candidates per competitor",
"minimum": 10,
"maximum": 100,
"type": "integer",
"description": "How many gap keywords to pull per competitor (highest competitor traffic first), before merging duplicates. Max 100, so a report has up to 300.",
"default": 100
},
"liveSerpChecks": {
"title": "Live Google checks",
"minimum": 0,
"maximum": 20,
"type": "integer",
"description": "How many of the best candidates to re-check on the live Google top 10 (confirms the gap is still open today). Max 20. 0 = database only.",
"default": 20
},
"preparedBy": {
"title": "Prepared by (optional)",
"type": "string",
"description": "Your name or agency, shown on the HTML report. No Wrenfield branding appears in the report."
},
"maxSpendUsd": {
"title": "Maximum spend (USD)",
"minimum": 0,
"type": "integer",
"description": "Optional. The run stops before collecting anything, and charges nothing, if the report price is above this. Same effect as \"Maximum cost per run\" in Run options."
}
}
},
"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
},
"PROXY_UNBLOCKER_UNITS": {
"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
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}