{
  "openapi": "3.0.1",
  "info": {
    "title": "Google AI Overview Tracker: Brand Mentions & Citations",
    "description": "Track brands and citations in Google AI Overviews and AI Mode, with repeat-sample rates and 95% intervals. Search sections include places and top stories when supplied. On paying plans layout is null. $3.90/1,000 AI Overview searches on Free; $2.45 on Business.",
    "version": "0.1",
    "x-build-id": "sfqzSQKY3kYrhW0Tm"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/fetchwright~google-ai-overviews-ai-mode-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-fetchwright-google-ai-overviews-ai-mode-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/fetchwright~google-ai-overviews-ai-mode-scraper/runs": {
      "post": {
        "operationId": "runs-sync-fetchwright-google-ai-overviews-ai-mode-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/fetchwright~google-ai-overviews-ai-mode-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-fetchwright-google-ai-overviews-ai-mode-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": {
          "queries": {
            "title": "Search queries",
            "type": "array",
            "description": "Required, unless you read queries from a dataset. One Google search per line, written the way a customer would ask it, for example **best crm for small business** or **harvest vs toggl**. Questions and comparisons get AI Overviews most often.",
            "items": {
              "type": "string"
            }
          },
          "samplesPerQuery": {
            "title": "Samples per query ($)",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many times to run each query, for example **3**. AI answers change between runs, so 3 to 5 samples show how stable an answer and its citations are. Each sample is a separate search and is charged as one, so this is also your cost multiplier. Default: 1.",
            "default": 1
          },
          "country": {
            "title": "Country",
            "type": "string",
            "description": "Two-letter country code for the search, for example **US**, **GB** (UK also works), **DE** or **SE**. An unknown code stops the run at once with a message, before anything is charged. Default: US.",
            "default": "US"
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Interface language code, for example **en**, **de**, **fr** or **pt-br**. It sets the language of the AI answer. Default: en.",
            "default": "en"
          },
          "brands": {
            "title": "Brands or domains to track",
            "type": "array",
            "description": "Optional. A list of brand names or domains, for example **[\"Harvest\", \"toggl.com\"]**. For more control, an entry can be an object such as **{\"name\": \"Toggl Track\", \"aliases\": [\"Toggl\"], \"domains\": [\"toggl.com\"], \"isCompetitor\": true}**. Each result then says whether and how often the brand is named, whether it is named before \"Show more\", in which order the brands are named, and whether its site is cited. A name typed with a capital letter (\"Square\") does not match the ordinary word (\"square\"). Brand tracking has no extra charge. First-view measurements are included on Free; on paying plans enable the optional first-view add-on at $0.90 per 1,000 searches. Several brands pasted on a single line, separated by commas or semicolons, are read as separate brands, for example **HubSpot, Pipedrive, monday.com**."
          },
          "firstViewCheck": {
            "title": "Measure what Google shows before 'Show more' (add-on)",
            "type": "boolean",
            "description": "On paying plans, also measure which matched passages, cited pages and tracked brands Google shows before \"Show more\", with the first-view text and source shares. For example, turn this on for a brand visibility report. $0.90 per 1,000 searches where matching evidence decides at least one passage or cited-page visibility flag. Checks with no such evidence have no add-on charge. Unknown flags stay null; firstViewReason explains unavailable or unmatched observations. Included on the Free plan without this switch. Default: false.",
            "default": false
          },
          "writeReport": {
            "title": "Write a client-ready report (free)",
            "type": "boolean",
            "description": "At the end of the run, turn this run's AI Overview answers into a report you can send to a client: REPORT.html and REPORT.md in the run storage, linked from the run summary. For example, track your brand and two rivals over three queries and forward the page. Mark rivals with \"isCompetitor\": true and the report is written about the one brand left unmarked. Every figure is counted from this run's rows and every sentence comes from a fixed template; no AI model writes it. A report covers the queries with three or more searches per query that returned a finished AI Overview (set \"Samples per query\" to 3 or more); other queries are named as left out, and a closing table lists every query with its outcome. Free.",
            "default": false
          },
          "includeAiMode": {
            "title": "Add-on: Google AI Mode answer ($)",
            "type": "boolean",
            "description": "Also fetch the answer from Google's AI Mode for each sample, and compare its cited sites with the AI Overview's (shared, only in one, overlap score). Charged only when AI Mode returns a reply. Slower: with AI Mode on, 20 queries took 702 seconds on 12 November 2026, and one slow answer can take over two minutes.",
            "default": false
          },
          "compareWithPreviousRun": {
            "title": "Compare with the previous run",
            "type": "boolean",
            "description": "For scheduled tracking. The run summary then says, for each query, what changed since the last run of the same watch: sites that entered or left the AI Overview's sources, the share before and now of each site whose share changed, and the mention and citation rates before and now of tracked brands both runs have a record for. When the two runs are comparable (same settings, a previous record that saved its settings, and decided samples in both runs), a change is flagged when the two rates differ by more than their 95% intervals allow (the intervals do not overlap), for these samples at that time, country and language. Samples in one run can move together, so the flag is a change indicator, a rule of thumb rather than a statistical test: a flagged change can still be chance and a real change can go unflagged. When Google stops or starts showing an AI Overview for a query, the run says so once. Only counts are remembered, in a key-value store in your own account. No extra charge. Default: off.",
            "default": false
          },
          "monitorName": {
            "title": "Watch name",
            "type": "string",
            "description": "Optional. Give each scheduled watch its own name, for example **crm-us-weekly**, so several watches on the same queries keep separate histories. Leave empty to identify the watch by query, country and language."
          },
          "notifyWebhookUrl": {
            "title": "Send the result to Slack, Discord or a webhook",
            "type": "string",
            "description": "Optional. Paste a Slack or Discord incoming-webhook address, or any https:// address that accepts JSON. After the run a short message is posted there: for each query, how many samples showed an AI Overview, how often each tracked brand was named and cited, and, with **Compare with the previous run** on, the sources that appeared or disappeared and the flagged changes. No extra charge."
          },
          "notifyOnlyOnChange": {
            "title": "Alert only when something changed",
            "type": "boolean",
            "description": "With **Compare with the previous run** on, post the message only when a source appeared or disappeared, the AI Overview itself was lost or came back, or a change was flagged (the two rates differ by more than their 95% intervals allow; a change indicator and rule of thumb for these samples, not a statistical test). Off by default: every run posts its result.",
            "default": false
          },
          "retryMissingAiOverview": {
            "title": "Search again when Google shows no AI Overview yet",
            "type": "boolean",
            "description": "Google sometimes reports that an AI Overview is not available, or is still preparing it, for a query that gets one a moment later. With this on, the Actor searches again before giving up, at no extra charge (see **Re-searches for a missing AI Overview**). Each row records the first result in `firstAiOverviewStatus`. Turn it off to measure how often Google shows an AI Overview on a single try.",
            "default": true
          },
          "maxAiOverviewRetries": {
            "title": "Re-searches for a missing AI Overview",
            "minimum": 0,
            "maximum": 3,
            "type": "integer",
            "description": "How many times at most to search again when Google shows no AI Overview yet, from 0 to 3, for example **1**. Re-searches are free. Ignored when the option above is off. Default: 1.",
            "default": 1
          },
          "maxOrganicResults": {
            "title": "Organic results to keep",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "How many of the regular search results to include with each sample, from 0 to 10, for example **10**. One results page shows up to about ten. They are part of the same page and cost nothing extra. Default: 10.",
            "default": 10
          },
          "queriesDatasetId": {
            "title": "Read queries from a dataset",
            "type": "string",
            "description": "Optional. Pick a dataset from another run, for example a keyword list from a keyword research Actor, and its values are added to the queries above. Up to 5,000 items are read; the run log warns when the dataset holds more. Use it to chain Actors without exporting anything."
          },
          "queriesDatasetField": {
            "title": "Dataset field",
            "type": "string",
            "description": "Name of the field that holds the queries, for example **keyword**. Leave empty to detect it automatically (query, keyword, searchTerm, searchQuery, question, term, title)."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}