{
  "openapi": "3.0.1",
  "info": {
    "title": "LLM Brand Visibility Tracker – ChatGPT, Perplexity, Gemini",
    "description": "Track if AI search engines recommend your brand. Ask Perplexity, OpenAI GPT and Gemini (official APIs with web search) your customers' questions; get mention, rank, share of voice vs competitors, cited URLs and sentiment. $0.01 per check.",
    "version": "0.1",
    "x-build-id": "ha8lNTyM6MfwLMPKp"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/gazidev~llm-brand-visibility-tracker/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-gazidev-llm-brand-visibility-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/gazidev~llm-brand-visibility-tracker/runs": {
      "post": {
        "operationId": "runs-sync-gazidev-llm-brand-visibility-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/gazidev~llm-brand-visibility-tracker/run-sync": {
      "post": {
        "operationId": "run-sync-gazidev-llm-brand-visibility-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",
        "properties": {
          "brand": {
            "title": "Brand name",
            "type": "string",
            "description": "The brand, product or company to track in AI answers, e.g. \"Notion\". Matching is case-insensitive and on whole words."
          },
          "aliases": {
            "title": "Brand aliases",
            "type": "array",
            "description": "Other names that count as a mention of your brand, e.g. product names, old names or spellings (\"Notion AI\", \"Notion Labs\").",
            "items": {
              "type": "string"
            }
          },
          "domain": {
            "title": "Your website domain",
            "type": "string",
            "description": "Your domain, e.g. \"notion.com\". Used to detect whether the AI engine cites your website as a source (subdomains count too)."
          },
          "competitors": {
            "title": "Competitors",
            "type": "array",
            "description": "Competitor brand names. Used for share of voice, competitor ranks and competitor mention rates (max 30).",
            "items": {
              "type": "string"
            }
          },
          "prompts": {
            "title": "Prompts (questions people ask AI)",
            "type": "array",
            "description": "Questions your customers ask ChatGPT, Perplexity or Gemini, e.g. \"What is the best note-taking app for startups?\". Write them neutrally (without your brand name) to measure organic visibility. Leave empty to auto-generate prompts from Category + Audience.",
            "items": {
              "type": "string"
            }
          },
          "category": {
            "title": "Category (for auto-generated prompts)",
            "type": "string",
            "description": "Used only when Prompts is empty: your product category in plural, e.g. \"CRM software\" or \"running shoes\". Generates prompts like \"What are the best CRM software for small businesses?\"."
          },
          "audience": {
            "title": "Audience (for auto-generated prompts)",
            "type": "string",
            "description": "Used only with Category: who is asking, e.g. \"small businesses\", \"marathon beginners\". Default: small businesses."
          },
          "maxAutoPrompts": {
            "title": "Number of auto-generated prompts",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many prompts to generate from Category + Audience (1-10).",
            "default": 5
          },
          "engines": {
            "title": "AI engines",
            "type": "array",
            "description": "Answer engines to ask. All are called through their official APIs with live web search via Apify's OpenRouter Actor. Each prompt x engine is one check.",
            "items": {
              "type": "string",
              "enum": [
                "perplexity",
                "chatgpt",
                "gemini"
              ],
              "enumTitles": [
                "Perplexity Sonar (built-in web search)",
                "OpenAI GPT-5 mini + web search (ChatGPT model family)",
                "Google Gemini 2.5 Flash + web search"
              ]
            },
            "default": [
              "perplexity",
              "chatgpt",
              "gemini"
            ]
          },
          "customModels": {
            "title": "Extra models (OpenRouter IDs)",
            "type": "array",
            "description": "Optional extra OpenRouter model IDs to check, e.g. \"anthropic/claude-sonnet-4.5\" or \"x-ai/grok-4.7\". Web search is added automatically (except perplexity/* and IDs ending in :online). See openrouter.ai/models.",
            "items": {
              "type": "string"
            }
          },
          "userLocation": {
            "title": "User location",
            "type": "string",
            "description": "Optional country or city to simulate a local user, e.g. \"Germany\" or \"Austin, Texas\". Added to the instructions as context."
          },
          "answerLanguage": {
            "title": "Answer language",
            "type": "string",
            "description": "Optional language for the answers, e.g. \"German\". Empty = language of the prompt."
          },
          "analyzeSentiment": {
            "title": "Analyze sentiment",
            "type": "boolean",
            "description": "When your brand is mentioned, rate how the answer portrays it (positive / neutral / negative / mixed) with a small extra call to gemini-2.5-flash-lite (about $0.0001 in tokens).",
            "default": true
          },
          "includeFullAnswer": {
            "title": "Include full answer text",
            "type": "boolean",
            "description": "Save the complete AI answer in each row (the excerpt around your brand is always saved).",
            "default": true
          },
          "onlyChanged": {
            "title": "Only save changed results (for schedules)",
            "type": "boolean",
            "description": "For scheduled runs: remember the last result per prompt x engine and only save rows whose mention, rank, domain citation or sentiment changed. Every check is still performed and charged; summary rows are always saved.",
            "default": false
          },
          "stateStoreName": {
            "title": "State store name",
            "type": "string",
            "description": "Name of the key-value store that remembers previous results for \"Only save changed results\". Use a different name per brand/project.",
            "default": "llm-brand-visibility-state"
          },
          "maxPrompts": {
            "title": "Max prompts",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Safety limit on the number of prompts per run. Checks = prompts x engines.",
            "default": 50
          },
          "concurrency": {
            "title": "Parallel checks",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many checks run at the same time.",
            "default": 4
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}