{ "openapi": "3.0.1", "info": { "title": "Track Google Search AI mentions of your brand and competitors", "description": "Track whether Google AI Overview mentions your brand, cites your domain, or gives visibility to competitors. Returns one JSON row per query with answer text, citation URLs, brand and competitor matches, share of voice, and optional organic results.", "version": "0.1", "x-build-id": "2ujh08se535imh1A1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/netm8_solutions~google-aio-brand-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-netm8_solutions-google-aio-brand-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/netm8_solutions~google-aio-brand-tracker/runs": { "post": { "operationId": "runs-sync-netm8_solutions-google-aio-brand-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/netm8_solutions~google-aio-brand-tracker/run-sync": { "post": { "operationId": "run-sync-netm8_solutions-google-aio-brand-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": [ "queries" ], "properties": { "queries": { "title": "Queries", "minItems": 1, "maxItems": 500, "type": "array", "description": "Search queries to check (1–500). Question-style and commercial queries trigger AI Overviews most often.", "items": { "type": "string" } }, "targetBrand": { "title": "Target brand name", "type": "string", "description": "Brand to detect in the AI Overview answer text (e.g. \"HubSpot\"). Enables brand-match analysis." }, "targetDomain": { "title": "Target domain", "type": "string", "description": "Domain to detect among cited sources (e.g. \"hubspot.com\"). Enables citation matching." }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Alternative names counted as mentions of the target brand.", "items": { "type": "string" } }, "competitors": { "title": "Competitors", "maxItems": 10, "type": "array", "description": "Up to 10 competitor brand names (optionally \"Name|domain.com\") for share-of-voice comparison.", "items": { "type": "string" } }, "countryCode": { "title": "Country", "type": "string", "description": "Google gl parameter (2-letter country code).", "default": "us" }, "languageCode": { "title": "Language", "type": "string", "description": "Google hl parameter.", "default": "en" }, "includeOrganicResults": { "title": "Include top organic results", "type": "boolean", "description": "Also extract top-10 organic results per query (no extra charge in v1).", "default": false }, "maxRetries": { "title": "Max retries per query", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times a failed query is retried from a fresh proxy session before being marked failed (failed queries are never charged).", "default": 3 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many queries are checked in parallel.", "default": 5 }, "debugHtml": { "title": "Debug: store raw HTML", "type": "boolean", "description": "Stores fetched SERP HTML in the key-value store (for troubleshooting).", "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 } } }, "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 } } } } } } } } } }