{ "openapi": "3.0.1", "info": { "title": "Keyword Search Volume & Difficulty: CPC, Trends, Intent", "description": "Bulk search volume, 12-month trend, CPC, competition, keyword difficulty and search intent for 1–5,000 keywords in 37 markets, plus city and regional targeting. Pay per keyword with data.", "version": "0.1", "x-build-id": "JFfJjfKva5Q6zP7ff" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/benexe~keyword-metrics/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-benexe-keyword-metrics", "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/benexe~keyword-metrics/runs": { "post": { "operationId": "runs-sync-benexe-keyword-metrics", "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/benexe~keyword-metrics/run-sync": { "post": { "operationId": "run-sync-benexe-keyword-metrics", "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": [ "keywords" ], "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "1–5,000 keywords. Duplicates are merged; keywords over 80 characters or 10 words are skipped.", "items": { "type": "string" } }, "market": { "title": "Market", "enum": [ "us-en", "gb-en", "ca-en", "ca-fr", "au-en", "ie-en", "in-en", "es-es", "es-ca", "ad-ca", "ad-es", "mx-es", "ar-es", "co-es", "cl-es", "fr-fr", "be-fr", "be-nl", "ch-de", "ch-fr", "de-de", "at-de", "it-it", "pt-pt", "br-pt", "nl-nl", "pl-pl", "se-sv", "dk-da", "no-nb", "fi-fi", "cz-cs", "ro-ro", "gr-el", "hu-hu", "tr-tr", "jp-ja" ], "type": "string", "description": "Country and language of the search data.", "default": "us-en" }, "markets": { "title": "Compare more markets (optional)", "type": "array", "description": "Up to 5 extra markets in the same run (paid Apify plans).", "items": { "type": "string", "enum": [ "us-en", "gb-en", "ca-en", "ca-fr", "au-en", "ie-en", "in-en", "es-es", "es-ca", "ad-ca", "ad-es", "mx-es", "ar-es", "co-es", "cl-es", "fr-fr", "be-fr", "be-nl", "ch-de", "ch-fr", "de-de", "at-de", "it-it", "pt-pt", "br-pt", "nl-nl", "pl-pl", "se-sv", "dk-da", "no-nb", "fi-fi", "cz-cs", "ro-ro", "gr-el", "hu-hu", "tr-tr", "jp-ja" ], "enumTitles": [ "United States — English", "United Kingdom — English", "Canada — English", "Canada — French", "Australia — English", "Ireland — English", "India — English", "Spain — Spanish", "Spain — Catalan", "Andorra — Catalan", "Andorra — Spanish", "Mexico — Spanish", "Argentina — Spanish", "Colombia — Spanish", "Chile — Spanish", "France — French", "Belgium — French", "Belgium — Dutch", "Switzerland — German", "Switzerland — French", "Germany — German", "Austria — German", "Italy — Italian", "Portugal — Portuguese", "Brazil — Portuguese", "Netherlands — Dutch", "Poland — Polish", "Sweden — Swedish", "Denmark — Danish", "Norway — Norwegian", "Finland — Finnish", "Czechia — Czech", "Romania — Romanian", "Greece — Greek", "Hungary — Hungarian", "Turkey — Turkish", "Japan — Japanese" ] }, "default": [] }, "locationCode": { "title": "Custom location code (advanced)", "type": "integer", "description": "Google Ads location code (e.g. a city or region). Use together with a language code; overrides Market." }, "languageCode": { "title": "Custom language code (advanced)", "type": "string", "description": "Language code such as en, es, ca, de." }, "engine": { "title": "Data engine", "enum": [ "auto", "labs", "planner" ], "type": "string", "description": "Auto uses the keyword database where available (cheaper, adds difficulty and intent) and Google Ads data elsewhere.", "default": "auto" }, "useCache": { "title": "Use fresh cached results", "type": "boolean", "description": "Results fetched in the last 30 days are reused: no lookup fee for them. Search volumes are monthly, so freshness is unchanged.", "default": true }, "healthCheck": { "title": "Health check (owner only)", "type": "boolean", "description": "Internal monitoring run.", "default": false } } }, "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 } } } } } } } } } }