{
  "openapi": "3.0.1",
  "info": {
    "title": "Link Prospecting Tool",
    "description": "Monitor your brand visibility across AI and organic search platforms (ChatGPT, Google AI Mode, Google AI Overviews, and Perplexity). Check if quoted sources include your brand, and find link outreach opportunities.",
    "version": "0.0",
    "x-build-id": "acbXukso1MDvgjt7H"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/apify~link-prospecting-tool/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-apify-link-prospecting-tool",
        "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/apify~link-prospecting-tool/runs": {
      "post": {
        "operationId": "runs-sync-apify-link-prospecting-tool",
        "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/apify~link-prospecting-tool/run-sync": {
      "post": {
        "operationId": "run-sync-apify-link-prospecting-tool",
        "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": [
          "queries",
          "brand"
        ],
        "properties": {
          "queries": {
            "title": "Search queries",
            "pattern": "[^\\s]+",
            "type": "string",
            "description": "Enter one search query per line. These queries will be sent to the enabled AI platforms (ChatGPT, Google AI Mode, AI Overviews, and Perplexity) to check for your brand's visibility."
          },
          "brand": {
            "title": "Brand name",
            "type": "string",
            "description": "The brand name to search for in AI-generated responses and cited sources. The search is case-insensitive."
          },
          "organicResult": {
            "title": "Organic results to include",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "How many organic search results to include per query. Asking for more than 10 will slow down the Actor.",
            "default": 10
          },
          "enableChatGpt": {
            "title": "Enable ChatGPT Search",
            "type": "boolean",
            "description": "Enable ChatGPT Search to get AI-generated answers from OpenAI's search model. Additional fees apply per successful result via the Google Search Scraper Actor.",
            "default": true
          },
          "enableAiMode": {
            "title": "Enable Google AI Mode",
            "type": "boolean",
            "description": "Enable Google AI Mode to get Google's AI-generated responses. Additional fees apply per successful result via the Google Search Scraper Actor.",
            "default": true
          },
          "enableAiOverviews": {
            "title": "Process Google AI Overviews",
            "type": "boolean",
            "description": "Process Google AI Overviews that appear in search results. No additional cost - the Actor will analyze the AI Overview content and sources for brand mentions.",
            "default": true
          },
          "enablePerplexity": {
            "title": "Enable Perplexity AI Search",
            "type": "boolean",
            "description": "Enable Perplexity AI to get answers from the Sonar model. Additional fees apply per successful result via the Google Search Scraper Actor.",
            "default": true
          },
          "ownDomains": {
            "title": "Own domains (to exclude)",
            "type": "array",
            "description": "List your own domains to exclude from source analysis. Sources from these domains will be skipped since you already have presence there.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "competitorDomains": {
            "title": "Competitor domains (to exclude)",
            "type": "array",
            "description": "List competitor domains to exclude from source analysis. Sources from these domains will be skipped.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "ignoreDomains": {
            "title": "Other domains to exclude",
            "type": "array",
            "description": "List competitor domains to exclude. For example domain with user generated content like Quora and Youtube",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "maxContactsPerDomain": {
            "title": "Max contacts per domain",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Maximum number of contact leads to scrape from each source domain where the brand isn't mentioned. Higher values increase cost but provide more outreach contacts.",
            "default": 1
          },
          "includeMention": {
            "title": "Include mentions without backlink",
            "type": "boolean",
            "description": "By default, sources that mention your brand without giving you a backlink are included in the contact search.",
            "default": true
          },
          "department": {
            "title": "Department to search for leads",
            "type": "array",
            "description": "By default, the Actor looks for leads in the marketing department, as they're most likely to work on link building.",
            "items": {
              "type": "string",
              "enumTitles": [
                "C-Suite",
                "Engineering & Technical",
                "Product",
                "Design",
                "Finance",
                "Education",
                "Human Resources",
                "Information Technology",
                "Legal",
                "Marketing",
                "Medical & Health",
                "Operations",
                "Sales",
                "Consulting"
              ],
              "enum": [
                "c_suite",
                "engineering_technical",
                "product",
                "design",
                "finance",
                "education",
                "human_resources",
                "information_technology",
                "legal",
                "marketing",
                "medical_health",
                "operations",
                "sales",
                "consulting"
              ]
            },
            "default": [
              "marketing",
              "c_suite"
            ]
          },
          "searchAuthorName": {
            "title": "Search for author name",
            "type": "boolean",
            "description": "Uses AI to identify the author of the article and find their email address.",
            "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}