{
  "openapi": "3.0.1",
  "info": {
    "title": "Google Maps Reviews Scraper + Reputation Intelligence",
    "description": "Scrapes Google Maps reviews from a business name, postcode, or place URL. Returns the complete review set with a coverage audit (claimed vs collected), sentiment, complaint themes, rating trajectory, response health, and a ranked reputation attention queue.",
    "version": "1.0",
    "x-build-id": "MY1BsiYcKJUOaKzos"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/ryanclinton~google-maps-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-ryanclinton-google-maps-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/ryanclinton~google-maps-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-ryanclinton-google-maps-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/ryanclinton~google-maps-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-ryanclinton-google-maps-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": {
          "input": {
            "title": "Business name, place URL, or place ID",
            "type": "string",
            "description": "Type anything: a business name (\"Domino's Pizza Belfast BT9 6AA\"), a Google Maps place URL, a share.google short link, a place ID (ChIJ...), a feature ID (0x...:0x...), or a CID. The actor auto-detects the shape and resolves it to a place before scraping reviews. For bulk runs use the advanced 'places' or 'placeUrls' lists instead."
          },
          "maxReviewsPerPlace": {
            "title": "Max reviews per place",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Maximum reviews to collect per place. Set to 0 for NO LIMIT — collect every review the place has, all the way back (pagination stops naturally when Google runs out). If a positive value is lower than a place's review count, coverage status is reported as 'capped' (an honest, explained cap, never a silent truncation). Collection is always newest-first, so a low cap drops the OLDEST reviews. No limit uses the most memory and runtime.",
            "default": 200
          },
          "outputProfile": {
            "title": "Output profile",
            "enum": [
              "signals",
              "compat",
              "minimal"
            ],
            "type": "string",
            "description": "signals (default) = full reputation intelligence on top of every field. compat = exact compass/Google-Maps-Reviews-Scraper field set for drop-in migration and raw ingestion (no intelligence layer). minimal = reviewId, text, stars, publishedAt only.",
            "default": "signals"
          },
          "mode": {
            "title": "Input mode",
            "enum": [
              "auto",
              "search",
              "places",
              "placeUrls"
            ],
            "type": "string",
            "description": "auto (default) lets the actor classify the 'input' string by shape. search forces free-text search. places uses the 'places' bulk list. placeUrls uses the 'placeUrls' bulk list (compass parity).",
            "default": "auto"
          },
          "places": {
            "title": "Places (bulk list)",
            "type": "array",
            "description": "Bulk list of business names / queries, optionally with lat-lng to disambiguate. Each item: a plain string query, or an object {\"query\": \"...\", \"lat\": 54.5, \"lng\": -5.9}.",
            "default": []
          },
          "placeUrls": {
            "title": "Place URLs / IDs (bulk list)",
            "type": "array",
            "description": "Bulk list of Google Maps place URLs, place IDs, feature IDs, CIDs, or share.google links (compass parity).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "reviewsOrigin": {
            "title": "Reviews origin",
            "enum": [
              "google",
              "all"
            ],
            "type": "string",
            "description": "google = Google-native reviews only (recommended, full coverage). all = include third-party aggregated reviews (Google reports reduced hotel coverage here; the actor flags this as 'degraded' when relevant).",
            "default": "google"
          },
          "sort": {
            "title": "Sort",
            "enum": [
              "newest",
              "relevant",
              "highest",
              "lowest"
            ],
            "type": "string",
            "description": "Pagination always uses 'newest' internally to guarantee complete coverage (Google's date-range sort silently stops scraping). Date-range filtering is applied client-side after fetch. This field only affects the order of the emitted review rows.",
            "default": "newest"
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Two-letter UI language for the Google Maps requests (e.g. en, fr, de).",
            "default": "en"
          },
          "watchlistName": {
            "title": "Watchlist name",
            "type": "string",
            "description": "Set a name to enable managed cross-run monitoring. The actor persists per-place state in a named key-value store and returns deltas (what changed since last run), a reputation timeline, and rank movement. Use the same name on a schedule for a daily reputation feed."
          },
          "comparisonDatasetId": {
            "title": "Comparison dataset ID",
            "type": "string",
            "description": "Diff this run against any prior Apify dataset (an old export or a competitor's run). Returns the same delta block as watchlist mode, on your first run. If both this and watchlistName are set, watchlistName wins."
          },
          "includeReviewImages": {
            "title": "Include review images",
            "type": "boolean",
            "description": "Include reviewImageUrls on review records.",
            "default": true
          },
          "includeReviewerMetadata": {
            "title": "Include reviewer metadata",
            "type": "boolean",
            "description": "Include reviewer fields (name, reviewerId, reviewerNumberOfReviews, isLocalGuide, etc.).",
            "default": true
          },
          "failOnPartialCoverage": {
            "title": "Fail on partial coverage",
            "type": "boolean",
            "description": "If any place returns a coverage status other than 'complete', fail the whole run instead of finishing with a silent gap. For trust-critical pipelines.",
            "default": false
          },
          "debugCoverage": {
            "title": "Always emit the coverage proof ledger",
            "type": "boolean",
            "description": "Emit the full coverageProof ledger (pages fetched, retries, duplicates dropped, stop condition) on every place, even when coverage is complete.",
            "default": false
          },
          "includeClientSummary": {
            "title": "Include client summary (agency report mode)",
            "type": "boolean",
            "description": "Assemble a deterministic wins / risks / changes summary per place, ready to drop into a monthly client deck. Most meaningful with a watchlist or comparison dataset.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy settings. Residential proxies are strongly recommended for Google Maps. Defaults to Apify residential.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}