{
  "openapi": "3.0.1",
  "info": {
    "title": "GBP Competitor Monitor",
    "description": "Stay ahead of the competition by monitoring their Google Business Profile (GBP), formerly Google My Business (GMB), activity. Know when competitors get new reviews, post updates, or change their listings.",
    "version": "2.0",
    "x-build-id": "9KvcdoKWueI37dtW0"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/alizarin_refrigerator-owner~competitor-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-competitor-monitor",
        "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/alizarin_refrigerator-owner~competitor-monitor/runs": {
      "post": {
        "operationId": "runs-sync-alizarin_refrigerator-owner-competitor-monitor",
        "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/alizarin_refrigerator-owner~competitor-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-alizarin_refrigerator-owner-competitor-monitor",
        "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": {
          "yourBusiness": {
            "title": "Your Business",
            "type": "object",
            "description": "Your business, for side-by-side comparison. Give a Google placeId (starts with ChIJ) or a searchQuery such as \"Business name, street, city\". Optional.",
            "default": {}
          },
          "competitors": {
            "title": "Competitors to Monitor",
            "type": "array",
            "description": "Competitors to track. Each needs a name plus a Google placeId (starts with ChIJ) or a searchQuery such as \"Business name, street, city\". A search that matches several places uses the first result.",
            "default": []
          },
          "previousRunId": {
            "title": "Previous Run Dataset",
            "type": "string",
            "description": "Default dataset (ID or name) of a previous run of this actor. Rating, review count and profile changes are detected against it."
          },
          "trackReviews": {
            "title": "Track Reviews",
            "type": "boolean",
            "description": "Report new reviews (review count increase since the previous run)",
            "default": true
          },
          "trackProfileChanges": {
            "title": "Track Profile Changes",
            "type": "boolean",
            "description": "Report rating, category, website, phone and address changes since the previous run",
            "default": true
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "URL to POST alerts to when changes are detected"
          },
          "alertThreshold": {
            "title": "Alert Threshold",
            "enum": [
              "all",
              "medium",
              "high"
            ],
            "type": "string",
            "description": "Minimum importance level to trigger webhook alerts",
            "default": "medium"
          },
          "trackPosts": {
            "title": "Track GBP Posts",
            "type": "boolean",
            "description": "Read the posts (updates) Google shows on each profile: text, date, image, call-to-action button and post link. Adds no extra charge.",
            "default": true
          },
          "maxPostsPerBusiness": {
            "title": "Max Posts per Business",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many of the newest posts to read per profile (1 to 20)",
            "default": 10
          },
          "trackPhotos": {
            "title": "Track Photos",
            "type": "boolean",
            "description": "Read the profile's photo count and the first photos Google shows for it (up to 10), each with its upload date and whether the owner or a customer added it. Adds no extra charge.",
            "default": true
          },
          "maxPhotosPerBusiness": {
            "title": "Max Photos per Business",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many photos to list per profile (1 to 10). The photo count covers all photos.",
            "default": 10
          },
          "trackRankings": {
            "title": "Track Keyword Rankings",
            "type": "boolean",
            "description": "For each keyword, find every business's position in the Google Maps results for the target location, and (with Check Local 3-Pack) whether it is in the Google Search local 3-pack. Needs Target Keywords and Target Location.",
            "default": false
          },
          "targetKeywords": {
            "title": "Target Keywords",
            "type": "array",
            "description": "Keywords to check, such as \"plumber\" or \"water heater repair\" (up to 10). Google Maps is searched for each keyword with the map centered on Target Location; a trailing \"near me\" is dropped. The Google Search 3-pack check searches \"keyword in Target Location\".",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "targetLocation": {
            "title": "Target Location",
            "type": "string",
            "description": "City or area for the ranking searches, such as \"Austin, TX\""
          },
          "rankingDepth": {
            "title": "Maps Results to Check",
            "minimum": 5,
            "maximum": 60,
            "type": "integer",
            "description": "How many Google Maps results to read per keyword (5 to 60). A business further down is reported as not in the results.",
            "default": 20
          },
          "rankingZoom": {
            "title": "Maps Zoom Level",
            "minimum": 10,
            "maximum": 16,
            "type": "integer",
            "description": "Map zoom for the ranking searches, centered on Target Location (10 = wide metro area, 12 = city, 14 = neighborhood). Results come from the area the map shows, the way a searcher there would see them.",
            "default": 12
          },
          "checkLocalPack": {
            "title": "Check Local 3-Pack",
            "type": "boolean",
            "description": "Also read the Google Search local 3-pack for each keyword by running our Google SERP Scraper actor (it charges its own price, $0.005 per keyword at the time of writing).",
            "default": true
          },
          "detectGoogleAds": {
            "title": "Detect Google Ads",
            "type": "boolean",
            "description": "Look up each business's website domain in the public Google Ads Transparency Center: whether it ran Google ads in the last 30 days, how many, its advertisers and sample ads. Adds no extra charge.",
            "default": false
          },
          "adsRegion": {
            "title": "Ads Region",
            "enum": [
              "US",
              "CA",
              "GB",
              "AU"
            ],
            "type": "string",
            "description": "Country the ad data is filtered to",
            "default": "US"
          },
          "maxSampleAds": {
            "title": "Sample Ads per Business",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "How many sample ads to return per business (0 to 10)",
            "default": 3
          },
          "trackSocialMedia": {
            "title": "Track Social Media",
            "type": "boolean",
            "description": "Find each business's social profile links on the website page listed on its Google profile, then read public follower counts and recent posts with our social actors (no social logins needed). Those actors charge their own prices.",
            "default": false
          },
          "socialPlatforms": {
            "title": "Platforms to Look Up",
            "type": "array",
            "description": "Platforms to read followers and recent posts for. Links for every platform found (including LinkedIn and X) are always listed.",
            "items": {
              "type": "string",
              "enum": [
                "instagram",
                "facebook",
                "tiktok",
                "youtube"
              ],
              "enumTitles": [
                "Instagram",
                "Facebook",
                "TikTok",
                "YouTube"
              ]
            },
            "default": [
              "instagram",
              "facebook",
              "tiktok",
              "youtube"
            ]
          },
          "socialRecentPosts": {
            "title": "Recent Posts per Profile",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "How many recent posts or videos to read per social profile (0 to 10)",
            "default": 3
          },
          "instagramSessionCookies": {
            "title": "Instagram Session Cookies",
            "type": "string",
            "description": "Optional. Follower counts, bio and recent posts are read from public Instagram profiles without a login. Paste cookies from your own Instagram account as a JSON array (Cookie-Editor export) to also read the logged-in page, which adds post likes."
          },
          "facebookSessionCookies": {
            "title": "Facebook Session Cookies",
            "type": "string",
            "description": "Optional. Page followers, likes, category and the post shown at the top of the Page are read from the public Page without a login. Paste cookies from your own Facebook account as a JSON array (Cookie-Editor export) to read recent posts from the Page feed."
          },
          "maxSubActorChargeUsd": {
            "title": "Max Sub-Actor Charge (USD)",
            "minimum": 0,
            "maximum": 50,
            "type": "number",
            "description": "Upper limit for what the sub-runs (local 3-pack check and social lookups) may charge together, worked out from their published prices before they start. A lookup that would go over it is skipped and marked skipped_budget. 0 turns sub-runs off.",
            "default": 3
          },
          "anthropicApiKey": {
            "title": "Anthropic API Key (BYOK)",
            "type": "string",
            "description": "Your Anthropic API key to enable AI-powered strategic analysis. Get yours at console.anthropic.com. Leave empty to skip AI analysis."
          },
          "enableAiAnalysis": {
            "title": "Enable AI Analysis",
            "type": "boolean",
            "description": "When enabled with an API key, Claude analyzes competitor data and provides: strategic recommendations, competitive positioning insights, and actionable next steps.",
            "default": true
          },
          "demoMode": {
            "title": "Demo Mode",
            "type": "boolean",
            "description": "Return one labeled sample record (free, nothing charged) instead of scraping. Off by default.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}