{
  "openapi": "3.0.1",
  "info": {
    "title": "Forums and Blogs: online discussions scraper",
    "description": "Find mentions of your brand, competitors, and products across forums and online communities. Enable Include blogs to find matching blog posts too. Export matching excerpts and links to the original discussions. Explore customer questions and follow linked replies on supported communities.",
    "version": "0.1",
    "x-build-id": "qFV0EHdt0WTnk2Jax"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/monkey.d.scraping~forum-search-engine/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-monkey.d.scraping-forum-search-engine",
        "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/monkey.d.scraping~forum-search-engine/runs": {
      "post": {
        "operationId": "runs-sync-monkey.d.scraping-forum-search-engine",
        "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/monkey.d.scraping~forum-search-engine/run-sync": {
      "post": {
        "operationId": "run-sync-monkey.d.scraping-forum-search-engine",
        "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 or brands",
            "type": "array",
            "description": "One keyword, brand, product or phrase per line. Each one is searched across all forums. Use quotes for an exact phrase, for example \"ikea kallax\".",
            "items": {
              "type": "string"
            }
          },
          "maxResultsPerKeyword": {
            "title": "Mentions per keyword",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum forum mentions to collect for each keyword. Popular brands return 1,000+ mentions. Even small values include threads from many different forums.",
            "default": 200
          },
          "timeRange": {
            "title": "Time period",
            "enum": [
              "any",
              "year",
              "month",
              "week",
              "day",
              "hour"
            ],
            "type": "string",
            "description": "Only mentions from this period. Use \"Past week\" or \"Past day\" for monitoring.",
            "default": "any"
          },
          "languages": {
            "title": "Mention languages",
            "type": "array",
            "description": "Keep mentions whose title and excerpt can be identified in a selected language. Leave empty for all languages.",
            "items": {
              "type": "string",
              "enum": [
                "en",
                "it",
                "fr",
                "de",
                "es",
                "pt",
                "nl",
                "pl",
                "ru",
                "uk",
                "ja",
                "ko",
                "zh",
                "ar",
                "tr",
                "sv",
                "da",
                "no",
                "fi",
                "el",
                "ro",
                "hu",
                "cs",
                "sk",
                "id",
                "vi",
                "th",
                "he"
              ],
              "enumTitles": [
                "English",
                "Italian",
                "French",
                "German",
                "Spanish",
                "Portuguese",
                "Dutch",
                "Polish",
                "Russian",
                "Ukrainian",
                "Japanese",
                "Korean",
                "Chinese",
                "Arabic",
                "Turkish",
                "Swedish",
                "Danish",
                "Norwegian",
                "Finnish",
                "Greek",
                "Romanian",
                "Hungarian",
                "Czech",
                "Slovak",
                "Indonesian",
                "Vietnamese",
                "Thai",
                "Hebrew"
              ]
            },
            "default": []
          },
          "countries": {
            "title": "Forum countries",
            "type": "array",
            "description": "Choose the country of the community. International communities without a known country are included when this field is empty.",
            "items": {
              "type": "string",
              "enum": [
                "ar",
                "au",
                "bg",
                "br",
                "ca",
                "cn",
                "cz",
                "de",
                "es",
                "fi",
                "fr",
                "gb",
                "gr",
                "hk",
                "hr",
                "hu",
                "id",
                "ie",
                "il",
                "in",
                "it",
                "jp",
                "kr",
                "my",
                "ng",
                "nl",
                "no",
                "pl",
                "pt",
                "ro",
                "rs",
                "ru",
                "sa",
                "se",
                "sg",
                "sk",
                "th",
                "tr",
                "tw",
                "ua",
                "us",
                "vn",
                "za"
              ],
              "enumTitles": [
                "Argentina",
                "Australia",
                "Bulgaria",
                "Brazil",
                "Canada",
                "China",
                "Czechia",
                "Germany",
                "Spain",
                "Finland",
                "France",
                "United Kingdom",
                "Greece",
                "Hong Kong SAR China",
                "Croatia",
                "Hungary",
                "Indonesia",
                "Ireland",
                "Israel",
                "India",
                "Italy",
                "Japan",
                "South Korea",
                "Malaysia",
                "Nigeria",
                "Netherlands",
                "Norway",
                "Poland",
                "Portugal",
                "Romania",
                "Serbia",
                "Russia",
                "Saudi Arabia",
                "Sweden",
                "Singapore",
                "Slovakia",
                "Thailand",
                "Türkiye",
                "Taiwan",
                "Ukraine",
                "United States",
                "Vietnam",
                "South Africa"
              ]
            },
            "default": []
          },
          "regions": {
            "title": "Regions",
            "type": "array",
            "description": "Search only forums from these regions. Leave empty to search all of them.",
            "items": {
              "type": "string",
              "enum": [
                "english",
                "europe",
                "asia",
                "russia",
                "latin_america",
                "middle_east_africa"
              ],
              "enumTitles": [
                "English-speaking (US, UK, Canada, Australia, India, global)",
                "Europe (Italy, France, Spain, Portugal, Germany, Nordics, Poland, Czechia, Romania, Balkans, Ukraine…)",
                "Asia (China, Taiwan, Hong Kong, Japan, Korea, Southeast Asia)",
                "Russia",
                "Latin America (Brazil, Argentina)",
                "Middle East & Africa (Turkey, Arab world, Israel, Nigeria, South Africa)"
              ]
            },
            "default": []
          },
          "includeReddit": {
            "title": "Include Reddit",
            "type": "boolean",
            "description": "Also search Reddit. Turn off if you already monitor Reddit separately.",
            "default": true
          },
          "includeBlogs": {
            "title": "Include blogs",
            "type": "boolean",
            "description": "Also search 50 blog platforms (Medium, Substack, Blogspot, WordPress.com, Tumblr, Naver, note, CSDN and more). Blog posts come with page type \"blog\".",
            "default": false
          },
          "onlyExplicitMentions": {
            "title": "Only results that name the keyword",
            "type": "boolean",
            "description": "Keep only threads whose title or text contains every word of the keyword. Turn off to also get related discussions.",
            "default": true
          },
          "includeProfilesAndTagPages": {
            "title": "Include profile and tag pages",
            "type": "boolean",
            "description": "Also return user profiles, tag pages and forum index pages. Off by default: you get discussions and articles only.",
            "default": false
          },
          "communityFocus": {
            "title": "Community focus",
            "enum": [
              "all",
              "coffee",
              "home"
            ],
            "type": "string",
            "description": "Choose all communities or focus on specialist discussions about coffee or home improvement and furniture. Region choices also apply.",
            "default": "all"
          },
          "includeReplyContext": {
            "title": "Include reply context",
            "type": "boolean",
            "description": "Include linked messages and the comments they reply to or quote on supported OzBargain and Mumsnet discussions.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}