{
  "openapi": "3.0.1",
  "info": {
    "title": "Facebook Reviews Scraper - Recommendations, Comments & Photos",
    "description": "Scrape public reviews (recommendations) from any Facebook Page: reviewer, date, recommends or not, text, tags, photos, reactions and comment counts, plus the Page's recommend % and review count. Page search, filters and monitor mode for new reviews. Optional review comments. No login or cookies.",
    "version": "0.1",
    "x-build-id": "31YRlukRLG2gcIht3"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/topapi~facebook-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-topapi-facebook-reviews-scraper",
        "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/topapi~facebook-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-topapi-facebook-reviews-scraper",
        "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/topapi~facebook-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-topapi-facebook-reviews-scraper",
        "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": {
          "startUrls": {
            "title": "🔗 Facebook Page URLs",
            "type": "array",
            "description": "Public Facebook Pages: a Page URL (https://www.facebook.com/katzsdeli), its /reviews URL, a profile.php?id= URL, a bare username (katzsdeli) or a numeric Page id. Groups and single posts have no reviews.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "searchQueries": {
            "title": "🔎 Search Pages by name",
            "type": "array",
            "description": "Business names to look up with Facebook's own Page search, e.g. \"Katz's Delicatessen\" or \"Joe's Stone Crab Miami\". The exact business name works best; the matched Pages are listed in the run summary.",
            "items": {
              "type": "string"
            }
          },
          "maxPagesPerQuery": {
            "title": "Pages per search",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many of Facebook's top Page results to scrape for each search name. 1 = the best match only.",
            "default": 1
          },
          "recommendationType": {
            "title": "👍 Recommendation",
            "enum": [
              "all",
              "positive",
              "negative"
            ],
            "type": "string",
            "description": "Keep every review, only the ones that recommend the Page, or only the ones that don't.",
            "default": "all"
          },
          "onlyReviewsNewerThan": {
            "title": "📅 Reviews newer than",
            "type": "string",
            "description": "Keep reviews posted on or after this date: absolute (2026-01-01) or relative (30 days, 6 months, 1 year). Leave empty for no lower bound."
          },
          "onlyReviewsOlderThan": {
            "title": "📅 Reviews older than",
            "type": "string",
            "description": "Keep reviews posted before this date, e.g. 2026-01-01 or 1 year. Combine with 'Reviews newer than' for a date range."
          },
          "keywords": {
            "title": "🔤 Keywords",
            "type": "array",
            "description": "Keep only reviews whose text or tags contain at least one of these words or phrases (not case-sensitive), e.g. \"service\", \"delivery\".",
            "items": {
              "type": "string"
            }
          },
          "onlyWithText": {
            "title": "📝 Only reviews with text",
            "type": "boolean",
            "description": "Skip reviews that are a recommendation with no written text.",
            "default": false
          },
          "onlyWithPhotos": {
            "title": "📷 Only reviews with photos",
            "type": "boolean",
            "description": "Keep only reviews that carry at least one photo.",
            "default": false
          },
          "includeComments": {
            "title": "💬 Include review comments",
            "type": "boolean",
            "description": "Add the public comments under each review (often the Page owner's reply), newest first: text, author, date, likes and reply count. Charged as review-comments at $0.001 per review that comes back with at least one comment.",
            "default": false
          },
          "maxCommentsPerReview": {
            "title": "Comments per review",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Most comments to collect under each review (only with 'Include review comments').",
            "default": 10
          },
          "maxRepliesPerComment": {
            "title": "Replies per comment",
            "minimum": 0,
            "maximum": 200,
            "type": "integer",
            "description": "Most replies to collect under each comment, nested in its `replies` list. 0 = no replies.",
            "default": 0
          },
          "monitorMode": {
            "title": "🆕 Only new reviews (monitor mode)",
            "type": "boolean",
            "description": "Return only reviews that previous runs have not delivered; the first run returns the latest reviews and sets the starting point. Memory is kept per Page in a named key-value store.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor memory name",
            "type": "string",
            "description": "Name of the key-value store that remembers what was delivered. Use a different name per schedule if you run separate monitors on the same Pages.",
            "default": "facebook-reviews-monitor"
          },
          "maxReviewsPerPage": {
            "title": "Max reviews per Page",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "Most reviews to return from each Page, newest first. 0 = every public review (up to 5,000 per Page per run). Facebook serves 3 reviews per request, so 100 reviews take about 34 requests.",
            "default": 100
          },
          "maxReviews": {
            "title": "Max reviews in total",
            "minimum": 0,
            "type": "integer",
            "description": "Most reviews for the whole run across all Pages. 0 = no total limit (the per-Page limit still applies).",
            "default": 0
          },
          "compact": {
            "title": "Compact output",
            "type": "boolean",
            "description": "Core fields only (review text, verdict, date, reviewer, counts, Page score), sized for AI agents and MCP clients.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "🛡️ Proxy",
            "type": "object",
            "description": "No proxy (default) is the fastest route: Facebook serves the reviews tab to Apify's own servers. If Facebook refuses a Page there, the run moves to Apify datacenter proxy and then to a residential IP by itself. A proxy you pick here is used as given.",
            "default": {
              "useApifyProxy": false
            }
          },
          "maxConcurrency": {
            "title": "Pages in parallel",
            "minimum": 1,
            "maximum": 8,
            "type": "integer",
            "description": "How many Pages are scraped at the same time.",
            "default": 3
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}