{
  "openapi": "3.0.1",
  "info": {
    "title": "Google Maps Rank Tracker",
    "description": "Track Google Maps rankings across a geo-grid heatmap. Get SoLV score, competitor leaderboard, gap analysis, zone breakdown, trend tracking & interactive HTML dashboard. Bulk scan up to 10 businesses. White-label reports. Free LocalFalcon & BrightLocal alternative — 50% cheaper, no monthly fees.",
    "version": "1.2",
    "x-build-id": "1gcLCLEMNxaVVgecJ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/vasram~google-maps-rank-tracker/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-vasram-google-maps-rank-tracker",
        "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/vasram~google-maps-rank-tracker/runs": {
      "post": {
        "operationId": "runs-sync-vasram-google-maps-rank-tracker",
        "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/vasram~google-maps-rank-tracker/run-sync": {
      "post": {
        "operationId": "run-sync-vasram-google-maps-rank-tracker",
        "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": [
          "keyword"
        ],
        "properties": {
          "businessName": {
            "title": "Business Name",
            "minLength": 2,
            "maxLength": 200,
            "type": "string",
            "description": "🏢 Your business name **exactly as it appears on Google Maps** — copy it from the Maps listing so the spelling matches. If several businesses in the area share a name, also provide the Place ID below for exact matching."
          },
          "keyword": {
            "title": "Search Keyword",
            "minLength": 2,
            "maxLength": 100,
            "type": "string",
            "description": "🔍 The search a customer would type on Google Maps — rankings are checked for this keyword at **every grid point**. Use the words your customers use, e.g. `dentist near me`, `best pizza`, `emergency plumber Brooklyn`."
          },
          "location": {
            "title": "Location (Address / City)",
            "type": "string",
            "description": "📌 Where the grid is centered. A **full street address** is most accurate; a city or neighborhood (`Brooklyn, NY`) also works. Leave empty only if you provide Latitude & Longitude below."
          },
          "gridSize": {
            "title": "Grid Size",
            "enum": [
              "3x3",
              "5x5",
              "7x7",
              "9x9"
            ],
            "type": "string",
            "description": "📏 How many points around your business are scanned. More points = more detail = higher cost per scan. Start with **3×3** (cheapest) to test, or **5×5** for the sweet spot most agencies use.",
            "default": "3x3"
          },
          "businesses": {
            "title": "Businesses to Scan",
            "maxItems": 10,
            "type": "array",
            "description": "📦 A JSON array. Each item needs `businessName`; all other fields are optional overrides:\n```json\n[\n  { \"businessName\": \"Joe's Pizza\" },\n  { \"businessName\": \"Pizza Palace\", \"keyword\": \"pizza delivery\", \"location\": \"Manhattan, NY\" }\n]\n```\nEntries without a `businessName` are skipped with a warning."
          },
          "placeId": {
            "title": "Place ID",
            "type": "string",
            "description": "🏢 Optional. Google Place ID (starts with `ChI`) for **exact** business matching. Use it when several businesses share a name. Leave empty to match by name. Find it with Google's Place ID finder."
          },
          "lat": {
            "title": "Center Latitude",
            "minimum": -90,
            "maximum": 90,
            "type": "number",
            "description": "🗺️ Optional. Latitude of the grid center (−90 to 90). Use this + Longitude instead of Location for exact positioning (e.g. service-area businesses). Leave empty to geocode from Location."
          },
          "lng": {
            "title": "Center Longitude",
            "minimum": -180,
            "maximum": 180,
            "type": "number",
            "description": "🗺️ Optional. Longitude of the grid center (−180 to 180). Must be provided together with Latitude."
          },
          "radius": {
            "title": "Radius",
            "minimum": 0.1,
            "maximum": 100,
            "type": "number",
            "description": "⭕ How far the grid stretches from the center. 2–3 works for dense cities, the default 5 covers most towns, 10+ for wide service areas.",
            "default": 5
          },
          "measurement": {
            "title": "Measurement Unit",
            "enum": [
              "km",
              "miles"
            ],
            "type": "string",
            "description": "📏 Unit for the Radius above — kilometers or miles. Miles are converted to km internally.",
            "default": "km"
          },
          "language": {
            "title": "Language",
            "enum": [
              "en",
              "hi",
              "es",
              "fr",
              "de",
              "pt",
              "ar",
              "ja",
              "ko",
              "zh"
            ],
            "type": "string",
            "description": "🌐 Language of the Google Maps results — matching what a local customer would see. Does not translate your keyword.",
            "default": "en"
          },
          "country": {
            "title": "Search Country",
            "enum": [
              "us",
              "in",
              "uk",
              "ca",
              "au",
              "nz",
              "za",
              "sg",
              "ie",
              "ph",
              "ae",
              "de",
              "fr",
              "it",
              "es",
              "br",
              "mx",
              "jp",
              "kr",
              "cn",
              "id",
              "my",
              "th",
              "vn",
              "nl",
              "be",
              "ch",
              "at",
              "se",
              "no",
              "dk",
              "fi",
              "pl",
              "tr",
              "ru",
              "sa",
              "eg",
              "ng",
              "ke",
              "ar",
              "cl",
              "co",
              "pe"
            ],
            "type": "string",
            "description": "🏳️ Country bias for the Google Maps search. Auto-detected from Location when provided, so you usually don't need to touch this.",
            "default": "us"
          },
          "maxCompetitorsPerPoint": {
            "title": "Competitors per Grid Point",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "📊 How many competitor listings to save at each grid point (1–20, default 5). More detail in the report, same price.",
            "default": 5
          },
          "fetchReviews": {
            "title": "Fetch Review Breakdown",
            "type": "boolean",
            "description": "⭐ Adds a 1★–5★ star-distribution chart for your business to the report. Recommended: keep it on. No extra cost.",
            "default": true
          },
          "gridSpacingKm": {
            "title": "Custom Grid Spacing",
            "minimum": 0.1,
            "maximum": 50,
            "type": "number",
            "description": "📏 Advanced: exact distance between grid points in km. Leave empty to auto-calculate from Radius (2 × radius ÷ (points − 1)). Use smaller values (0.5) for dense urban areas."
          },
          "enableAiPlan": {
            "title": "Generate AI Action Plan",
            "type": "boolean",
            "description": "🤖 Adds an **AI Action Plan** section to the HTML report — e.g. 'collect 20 more reviews', 'add service-area keywords for the weak North zone'. **Requires the API key below** — without a key this section is skipped.",
            "default": true
          },
          "aiApiKey": {
            "title": "AI API Key (required for the AI plan)",
            "type": "string",
            "description": "🔑 Your API key — this is what powers the AI Action Plan, billed to your account. Works with OpenAI (platform.openai.com), OpenRouter, Groq, Together, DeepSeek, or any OpenAI-compatible provider. Stored encrypted, never included in results."
          },
          "aiBaseUrl": {
            "title": "AI Base URL (non-OpenAI providers)",
            "type": "string",
            "description": "🌐 Only needed if your key is NOT from OpenAI. Examples: `https://openrouter.ai/api/v1`, `https://api.groq.com/openai/v1`, `https://api.together.xyz/v1`, `https://api.deepseek.com/v1`. Leave empty for OpenAI."
          },
          "aiModel": {
            "title": "AI Model (advanced)",
            "type": "string",
            "description": "🧠 Model id on your provider. Default: `gpt-4o-mini` (~$0.001 per scan on OpenAI). Examples: `openrouter/auto`, `llama-3.3-70b-versatile` (Groq). Leave empty for the default."
          },
          "monitor": {
            "title": "Enable Monitor Mode",
            "type": "boolean",
            "description": "🔔 When ON, a run with changes vs the previous scan also pushes a compact `status=MONITOR_ALERT` item — ideal for webhooks. Rank history charts build on every scan regardless of this setting.",
            "default": false
          },
          "alertSolvDropPct": {
            "title": "SoLV Alert Threshold",
            "minimum": 1,
            "maximum": 100,
            "type": "number",
            "description": "📉 Trigger a monitoring alert when SoLV (Local Pack presence) changes by at least this many percentage points between scans. Drops and gains both alert. Default 5.",
            "default": 5
          },
          "agencyName": {
            "title": "Agency / Brand Name",
            "type": "string",
            "description": "🏷️ Your agency or brand name. Replaces the default branding in the report header and footer, so the report looks like it came from you."
          },
          "agencyLogo": {
            "title": "Agency Logo URL",
            "type": "string",
            "description": "🖼️ Public URL of your logo (PNG/JPG/SVG, ~120×40px looks best). Shown in the report navigation bar next to your agency name."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}