{
  "openapi": "3.0.1",
  "info": {
    "title": "AI Overviews Tracker — Brand Visibility in AI Answers",
    "description": "Track brand mention rate, sentiment & share of voice in AI-generated overviews. Perplexity, ChatGPT, Claude & Gemini. GEO & brand monitoring audit.",
    "version": "1.0",
    "x-build-id": "STgE3271Cgd5fINzC"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/khadinakbar~ai-overviews-tracker/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-khadinakbar-ai-overviews-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/khadinakbar~ai-overviews-tracker/runs": {
      "post": {
        "operationId": "runs-sync-khadinakbar-ai-overviews-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/khadinakbar~ai-overviews-tracker/run-sync": {
      "post": {
        "operationId": "run-sync-khadinakbar-ai-overviews-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": [
          "brandName",
          "keywords"
        ],
        "properties": {
          "brandName": {
            "title": "Brand / product name to track",
            "type": "string",
            "description": "Your brand, product, or company name to track in AI-generated overviews. The actor detects mentions, recommendation phrases, and sentiment for this exact name. Example: 'HubSpot', 'Notion', 'Figma', 'Stripe'. NOT a domain name (use ai-search-visibility-tracker for domain citation tracking) — this field expects the brand name humans and AI would use in sentences."
          },
          "keywords": {
            "title": "Commercial keywords to query",
            "type": "array",
            "description": "Purchase-intent or commercial keywords to submit to AI platforms as overview queries. Each keyword generates queries like 'best [keyword] tools' or 'how to choose [keyword]'. Example: ['best CRM for small business', 'email marketing software', 'project management tools']. NOT brand names — enter the product category or use case your brand serves. Supports up to 20 keywords per run.",
            "items": {
              "type": "string"
            }
          },
          "competitors": {
            "title": "Competitor brand names (optional)",
            "type": "array",
            "description": "Competitor brand names to compare against your brand in AI overviews. The actor tracks whether each competitor is mentioned, recommended, and at what position — and computes share of voice (your brand's mentions vs total brand+competitor mentions). Example: ['Salesforce', 'Pipedrive', 'Monday.com']. NOT domains — enter brand names as they appear in sentences. Leave empty to skip competitor comparison.",
            "items": {
              "type": "string"
            }
          },
          "platforms": {
            "title": "AI platforms to query",
            "type": "array",
            "description": "Which AI platforms to check for brand visibility in overviews. Valid values: 'perplexity' (Sonar with real-time citations), 'chatgpt' (GPT-4o Search Preview), 'claude' (Claude Sonnet with web_search tool), 'gemini' (Gemini 2.5 Flash with Google Search grounding). All four use live web search — results reflect current AI overview content. Defaults to all four platforms.",
            "items": {
              "type": "string"
            },
            "default": [
              "perplexity",
              "chatgpt",
              "claude",
              "gemini"
            ]
          },
          "queryTemplates": {
            "title": "Query template categories",
            "type": "array",
            "description": "Built-in purchase-intent query templates to generate for each keyword. Options: 'best_of' (best [keyword] solutions in 2026), 'comparison' (how do leading [keyword] platforms compare), 'how_to_choose' (how to select the right [keyword] for your business), 'buyer_intent' (what [keyword] do most companies use), 'feature_query' (what features matter in a good [keyword]), 'versus' (your brand vs alternatives for [keyword] — requires brandName). Defaults to best_of, comparison, how_to_choose.",
            "items": {
              "type": "string"
            },
            "default": [
              "best_of",
              "comparison",
              "how_to_choose"
            ]
          },
          "customQueries": {
            "title": "Custom queries (optional)",
            "type": "array",
            "description": "Specific questions to submit verbatim to all AI platforms for every keyword. Supports {keyword} and {brand} placeholders (e.g., 'What do industry analysts say about {brand} for {keyword}?'). These run in addition to queryTemplates. Example: 'What are the most recommended {keyword} tools for enterprise use?'. NOT URLs — provide full question strings in plain English.",
            "items": {
              "type": "string"
            }
          },
          "maxQueriesPerKeyword": {
            "title": "Max queries per keyword",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Maximum number of distinct queries to run per keyword across all templates. Each query × platform = one check billed at $0.096. Default is 3 queries/keyword — covers best_of + comparison + how_to_choose at one query each. Set to 5–6 for deeper coverage including buyer_intent and feature_query. Lower to 1–2 for fast overview spot-checks.",
            "default": 3
          },
          "responseFormat": {
            "title": "Response format",
            "enum": [
              "concise",
              "detailed"
            ],
            "type": "string",
            "description": "Controls the length of the overview_excerpt field stored per result. 'concise' stores the first 300 characters of the AI response — faster to review and lower storage. 'detailed' stores the first 550 characters — better for reading the full brand context and competitor mentions. Does not affect what is tracked or scored — only the excerpt length.",
            "default": "detailed"
          },
          "webhookUrl": {
            "title": "Webhook URL (optional)",
            "type": "string",
            "description": "An HTTPS endpoint that receives a POST request when the run completes. Payload is the full run summary JSON including brand_visibility_score, overview_presence_score, competitor_threats, share_of_voice map, keyword_scores, and recommendations. Compatible with Make.com, Zapier, n8n, Slack incoming webhooks, and any HTTP endpoint that accepts JSON."
          },
          "demoMode": {
            "title": "Demo / health check mode",
            "type": "boolean",
            "description": "Set to true to verify the actor is functional without making any AI API calls and without consuming credits. The actor exits immediately with a success message. Use for integration testing, scheduling health checks, or MCP tool validation in CI pipelines. Set to false (default) for real brand visibility tracking runs.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}