{
  "openapi": "3.0.1",
  "info": {
    "title": "Keyword Search Volume & CPC: Google + Bing via DataForSEO",
    "description": "Google Ads and Bing Ads keyword data with your own DataForSEO API key: monthly search volume, CPC, top-of-page bids, competition, 12-month trend, keyword difficulty and search intent. Keyword ideas from seeds or a domain. Up to 1,000 keywords per run.",
    "version": "0.1",
    "x-build-id": "iE3CnLfPDAdF3i73f"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/cliqtomedia~keyword-metrics/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-cliqtomedia-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/cliqtomedia~keyword-metrics/runs": {
      "post": {
        "operationId": "runs-sync-cliqtomedia-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/cliqtomedia~keyword-metrics/run-sync": {
      "post": {
        "operationId": "run-sync-cliqtomedia-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",
        "properties": {
          "dataforseoLogin": {
            "title": "DataForSEO API login",
            "type": "string",
            "description": "Your DataForSEO API login (usually your email). Find it at app.dataforseo.com → API Access. Required: without it the run returns one row explaining what to add; only the Apify start fee is charged, no keyword events."
          },
          "dataforseoPassword": {
            "title": "DataForSEO API password",
            "type": "string",
            "description": "Your DataForSEO API password from app.dataforseo.com → API Access (not the dashboard password). Stored encrypted; never written to logs or results."
          },
          "mode": {
            "title": "What to get",
            "enum": [
              "metrics",
              "ideas",
              "site"
            ],
            "type": "string",
            "description": "metrics: data for your own keywords. ideas: related keywords for up to 20 seed keywords. site: keywords for a domain or page.",
            "default": "metrics"
          },
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Keywords to check (mode metrics, up to 1,000) or seed keywords (mode ideas, up to 20). Each up to 80 characters and 10 words. Duplicates are removed.",
            "items": {
              "type": "string"
            }
          },
          "domain": {
            "title": "Domain or page URL",
            "type": "string",
            "description": "For mode site: a domain such as nike.com, or a page URL with Target type page."
          },
          "targetType": {
            "title": "Target type",
            "enum": [
              "site",
              "page"
            ],
            "type": "string",
            "description": "site: keywords for the whole domain. page: keywords for one page URL.",
            "default": "site"
          },
          "engine": {
            "title": "Search engine",
            "enum": [
              "google",
              "bing",
              "both"
            ],
            "type": "string",
            "description": "google, bing, or both (one row per keyword and engine). Bing supports English, French and German.",
            "default": "google"
          },
          "locationCode": {
            "title": "Location code",
            "minimum": 1,
            "maximum": 99999999,
            "type": "integer",
            "description": "DataForSEO location code: 2840 United States, 2826 United Kingdom, 2124 Canada, 2036 Australia, 2276 Germany, 2250 France. Full list in the README.",
            "default": 2840
          },
          "languageCode": {
            "title": "Language code",
            "type": "string",
            "description": "Language code such as en, de, fr, es. Bing: en, fr or de only.",
            "default": "en"
          },
          "includeKeywordDifficulty": {
            "title": "Add keyword difficulty",
            "type": "boolean",
            "description": "Adds keyword difficulty 0–100 to Google rows (DataForSEO Labs, about $0.01 + $0.0001 per keyword on your DataForSEO account).",
            "default": true
          },
          "includeSearchIntent": {
            "title": "Add search intent",
            "type": "boolean",
            "description": "Adds informational / navigational / commercial / transactional intent to Google rows (DataForSEO Labs, English keywords).",
            "default": false
          },
          "searchPartners": {
            "title": "Include search partners",
            "type": "boolean",
            "description": "Include Google or Bing search partner networks in volume and CPC.",
            "default": false
          },
          "includeAdultKeywords": {
            "title": "Include adult keywords",
            "type": "boolean",
            "description": "Modes ideas and site: allow adult keywords in the ideas.",
            "default": false
          },
          "dateFrom": {
            "title": "History from",
            "type": "string",
            "description": "Start of the monthly history, YYYY-MM-DD, up to 4 years back. Empty: last 12 months. Bing keeps 24 months."
          },
          "dateTo": {
            "title": "History to",
            "type": "string",
            "description": "End of the monthly history, YYYY-MM-DD. Empty: latest month."
          },
          "bingDevice": {
            "title": "Bing device",
            "enum": [
              "all",
              "mobile",
              "desktop",
              "tablet"
            ],
            "type": "string",
            "description": "Bing rows only: all devices, mobile, desktop or tablet.",
            "default": "all"
          },
          "minVolume": {
            "title": "Min search volume",
            "minimum": 0,
            "type": "integer",
            "description": "Drop keyword rows with a lower monthly volume. 0 keeps all.",
            "default": 0
          },
          "maxIdeas": {
            "title": "Max ideas",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Modes ideas and site: keep at most this many keywords.",
            "default": 1000
          },
          "sortBy": {
            "title": "Sort rows by",
            "enum": [
              "relevance",
              "search_volume",
              "cpc",
              "competition_index",
              "keyword_difficulty"
            ],
            "type": "string",
            "description": "Order of rows in the results, highest first. relevance keeps your order (metrics) or DataForSEO order (ideas, site).",
            "default": "relevance"
          },
          "maxProviderCostUsd": {
            "title": "Max DataForSEO spend per run (USD)",
            "minimum": 0.01,
            "maximum": 100,
            "type": "number",
            "description": "The run stops before a DataForSEO call that would take your DataForSEO spend for this run past this amount. Rows found so far are kept.",
            "default": 1
          },
          "deliveryConnector": {
            "title": "Send results to (optional)",
            "type": "string",
            "description": "Your Slack, Notion or other MCP connector. After the run the Actor posts a short summary there. Connect services once in Apify Console → MCP connectors."
          },
          "deliveryTarget": {
            "title": "Notion page or channel (optional)",
            "type": "string",
            "description": "Where to post the summary: a Notion page link (each run is added on top of that page) or a Slack channel ID. Leave empty to let the connector decide."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}