# SEOmator

> Help center for SEOmator, the AI SEO Manager for B2B SaaS. Track your keywords and prompts and see how ChatGPT, Google AI Mode and Gemini talk about your brand.

- [SEOmator help center](https://docs.seomator.com/index.md): Help center for SEOmator, the AI SEO Manager for B2B SaaS: track your keywords and prompts and see how AI assistants talk about your brand.
- [Quickstart: get your first AI visibility numbers](https://docs.seomator.com/getting-started/quickstart.md): Create your account, add your site and start daily tracking in seven steps, then read the first AI visibility numbers for your brand.
- [How SEOmator measures AI visibility](https://docs.seomator.com/getting-started/how-it-works.md): How SEOmator asks ChatGPT, Google AI Mode and Gemini your prompts every day and counts the brands they name and the pages they read.
- [Plans, pricing and credits](https://docs.seomator.com/getting-started/plans.md): What the Free, Starter, Growth and Scale plans include, how the 14-day trial works and what credits pay for.
- [Frequently asked questions](https://docs.seomator.com/getting-started/faq.md): What SEOmator is, and answers to common questions: missing brand mentions, when numbers appear, paused tracking, trials, credits and access.
- [Projects: set up, track and manage a site](https://docs.seomator.com/getting-started/projects.md): Add a site as a project, walk through its five setup steps, start daily tracking, then change its name, market, topic rules or Search Console.
- [Prompts: the questions SEOmator asks AI](https://docs.seomator.com/setup/prompts.md): Choose the questions SEOmator asks ChatGPT, Google AI Mode and Gemini every day, keep a healthy mix, and see how each one is answered.
- [Competitors: choose the brands to track](https://docs.seomator.com/setup/competitors.md): Choose the brands SEOmator looks for in every AI answer, and tell it how each brand is written.
- [Insights: how often AI names your brand](https://docs.seomator.com/reports/insights.md): See how often ChatGPT, Google AI Mode and Gemini name your brand, how you rank against your competitors, and how that changes over time.
- [Answers: read what each AI assistant said](https://docs.seomator.com/reports/answers.md): Read every answer the AI assistants gave to your prompts, with the brands they named and the sources they used.
- [Domains: the sites AI assistants read and cite](https://docs.seomator.com/reports/domains.md): See which sites the AI assistants read and cite when they answer your prompts, and how often they read yours.
- [URLs: the pages AI assistants read and cite](https://docs.seomator.com/reports/urls.md): See which single pages ChatGPT, Google AI Mode and Gemini read and cite for your prompts, such as articles, lists and product pages.
- [Fan-out: what ChatGPT searches before answering](https://docs.seomator.com/reports/fanout.md): Query fan-out: see the web searches ChatGPT runs before it answers your prompts, the terms they share and the brands they name.
- [Filter reports](https://docs.seomator.com/reports/filters.md): Narrow any report by period, assistant, prompt type, topic or intent, and compare it with the previous period.
- [Metrics: visibility, share of voice and citations](https://docs.seomator.com/reports/metrics.md): Visibility, named first, position, share of voice, retrieved, cited and linked: what each SEOmator metric means and how it is counted.
- [AI SEO Agent: ask about your AI visibility](https://docs.seomator.com/agent/overview.md): Ask SEOmator's AI SEO Agent about your brand's AI visibility, competitors and sources, and let it make changes with your approval.
- [MCP server: connect Claude, ChatGPT and more](https://docs.seomator.com/mcp/setup.md): Add SEOmator to Claude, ChatGPT, Claude Code, Cursor or VS Code through MCP, and see every tool it can use to read and change your projects.
- [Organization settings](https://docs.seomator.com/settings/organization.md): Rename your organization, change its logo and URL, leave it or delete it.
- [Members: invite teammates and set roles](https://docs.seomator.com/settings/members.md): Invite people to your organization, give each one a role (owner, admin, member or viewer), and change or remove members.
- [Billing and usage: plan, credits and spending](https://docs.seomator.com/settings/billing.md): Change your plan, buy credit packs and get invoices, then see your credit balance, allowances and what your organization spent credits on.
- [API keys: connect scripts and MCP clients](https://docs.seomator.com/settings/api-keys.md): Create organization API keys with read or write access, send them with your requests, and revoke them.
- [Integrations: MCP clients and connected apps](https://docs.seomator.com/settings/integrations.md): Find the setup line for Claude, ChatGPT, Claude Code, Cursor or VS Code, and disconnect apps you approved.
- [SEOmator API: keys, requests, errors and limits](https://docs.seomator.com/api-reference/introduction.md): Call the SEOmator API with an organization API key, page through lists, read errors and stay within the rate limits, with a first request to copy.
- [List projects, newest first](https://docs.seomator.com/api-reference/projects/list-projects-newest-first.md)
- [Create a project](https://docs.seomator.com/api-reference/projects/create-a-project.md)
- [Get a project](https://docs.seomator.com/api-reference/projects/get-a-project.md)
- [Change a project’s name or profile](https://docs.seomator.com/api-reference/projects/change-a-project’s-name-or-profile.md)
- [Delete a project (soft delete)](https://docs.seomator.com/api-reference/projects/delete-a-project-soft-delete.md)
- [Countries and languages a project can track](https://docs.seomator.com/api-reference/ai-visibility/countries-and-languages-a-project-can-track.md): `countries` are lowercase ISO 3166-1 alpha-2 codes, `languages` lowercase ISO 639-1 codes. A project’s `country` and `language` must be one of them.
- [The latest job of each onboarding step](https://docs.seomator.com/api-reference/ai-visibility/the-latest-job-of-each-onboarding-step.md): Each step is null until it first runs. A `queued` or `running` job is the step in progress: poll it with `GET /v1/jobs/{id}`, for example after a page reload. `research` is null until the latest keyword research is done; then it counts the competitors it confirmed (a profile competitor got a researc…
- [Propose the profile and competitors from the site](https://docs.seomator.com/api-reference/ai-visibility/propose-the-profile-and-competitors-from-the-site.md): Reads the site, then writes the profile (description, category, business type, products, personas, country, language), the own brand and the competitors. Running it again replaces them. When the site cannot be read the job fails with `site_unreadable`: set `description` on the project and run it aga…
- [Find keywords and more competitors](https://docs.seomator.com/api-reference/ai-visibility/find-keywords-and-more-competitors.md): Reads Search Console when it is connected, otherwise DataForSEO Labs, and writes up to 50 keywords with their volume and position. Adds competitors that rank for the same keywords or are named next to the brand in recorded AI answers, each with its reason. Running it again replaces what it wrote; ke…
- [Propose topics and prompts from the profile](https://docs.seomator.com/api-reference/ai-visibility/propose-topics-and-prompts-from-the-profile.md): Writes 25 prompts across 3 to 6 topics from the profile, the own brand, the competitors and the keywords. Questions seen in recorded AI answers keep their wording and the source `ai_search_data`. Running it again replaces every topic and prompt. One step runs at a time per project, and only before t…
- [Get a job](https://docs.seomator.com/api-reference/jobs/get-a-job.md)
- [Daily tracking settings](https://docs.seomator.com/api-reference/ai-visibility/daily-tracking-settings.md)
- [Start, pause or change daily tracking](https://docs.seomator.com/api-reference/ai-visibility/start-pause-or-change-daily-tracking.md): Setting `status` to `active` collects answers at once and sets `runAt` to now; later days run at the same UTC time.
- [Progress of the latest daily run](https://docs.seomator.com/api-reference/ai-visibility/progress-of-the-latest-daily-run.md): Counts of the answers planned for the latest run date: collected (returned by the assistant), analyzed (counted in the reports), failed (failed or of unknown outcome) and open (still being collected), in total and per assistant. `run` is null before the first run. `status` is `running` while any ans…
- [Days the measurement changed](https://docs.seomator.com/api-reference/ai-visibility/days-the-measurement-changed.md): Marks for trend charts. One kind is the day an assistant’s main model changed: the model of more than half of its answers that day moved from one known model to another. A day without such a model is skipped, and so are unknown models. The other kind is the days prompts were added or archived after…
- [List prompts, newest first](https://docs.seomator.com/api-reference/ai-visibility/list-prompts-newest-first.md)
- [Add an active prompt](https://docs.seomator.com/api-reference/ai-visibility/add-an-active-prompt.md): Active prompts past the plan’s prompt allowance are answered on credits.
- [Suggest prompts](https://docs.seomator.com/api-reference/ai-visibility/suggest-prompts.md): Writes new prompt texts for one topic, intent and branding with AI, without saving them. Branding is checked against the own brand, and texts that repeat a prompt of the project are left out, so fewer than `count` can come back. Costs no credits.
- [One prompt, active or archived](https://docs.seomator.com/api-reference/ai-visibility/one-prompt-active-or-archived.md)
- [Change a prompt](https://docs.seomator.com/api-reference/ai-visibility/change-a-prompt.md): Changing the text archives this prompt with its history and returns the new prompt that replaces it.
- [Stop running a prompt and keep its history](https://docs.seomator.com/api-reference/ai-visibility/stop-running-a-prompt-and-keep-its-history.md)
- [Run an archived prompt again](https://docs.seomator.com/api-reference/ai-visibility/run-an-archived-prompt-again.md)
- [Delete a prompt and all its answers: an archived one, or any while tracking has not started](https://docs.seomator.com/api-reference/ai-visibility/delete-a-prompt-and-all-its-answers:-an-archived-one-or-any-while-tracking-has-not-started.md)
- [List prompt topics](https://docs.seomator.com/api-reference/ai-visibility/list-prompt-topics.md)
- [Create a topic](https://docs.seomator.com/api-reference/ai-visibility/create-a-topic.md)
- [Rename a topic; its history follows](https://docs.seomator.com/api-reference/ai-visibility/rename-a-topic;-its-history-follows.md)
- [Delete a topic; its prompts keep running without one](https://docs.seomator.com/api-reference/ai-visibility/delete-a-topic;-its-prompts-keep-running-without-one.md)
- [List the project’s own brand and tracked competitors](https://docs.seomator.com/api-reference/ai-visibility/list-the-project’s-own-brand-and-tracked-competitors.md)
- [Track a brand](https://docs.seomator.com/api-reference/ai-visibility/track-a-brand.md): Saved answers are scanned again in the background, so the brand’s history appears without new collection.
- [Change a brand’s name, aliases or domains](https://docs.seomator.com/api-reference/ai-visibility/change-a-brand’s-name-aliases-or-domains.md)
- [Stop tracking a competitor and remove its counts](https://docs.seomator.com/api-reference/ai-visibility/stop-tracking-a-competitor-and-remove-its-counts.md)
- [List brands the answers name that the project does not track](https://docs.seomator.com/api-reference/ai-visibility/list-brands-the-answers-name-that-the-project-does-not-track.md): Open suggestions, most answers first. Each name was found by a model and its quote checked against the answer.
- [Track a suggested brand as a competitor](https://docs.seomator.com/api-reference/ai-visibility/track-a-suggested-brand-as-a-competitor.md): Creates the competitor and scans the saved answers again, so its history appears at once.
- [Hide a suggested brand](https://docs.seomator.com/api-reference/ai-visibility/hide-a-suggested-brand.md)
- [List the project’s keywords](https://docs.seomator.com/api-reference/ai-visibility/list-the-project’s-keywords.md): Most clicks first, then most searched. position comes only from Search Console; without it the position is null, because DataForSEO Labs positions lag and count removed pages.
- [Add a keyword](https://docs.seomator.com/api-reference/ai-visibility/add-a-keyword.md)
- [Remove a keyword](https://docs.seomator.com/api-reference/ai-visibility/remove-a-keyword.md)
- [Bring back a keyword archived when the plan dropped to Free](https://docs.seomator.com/api-reference/ai-visibility/bring-back-a-keyword-archived-when-the-plan-dropped-to-free.md)
- [Brand visibility in AI answers, with counts and the previous period](https://docs.seomator.com/api-reference/ai-visibility/brand-visibility-in-ai-answers-with-counts-and-the-previous-period.md): Every row returns numerators and their denominator (`answers`), so you can re-aggregate.
- [Domains and pages the AI answers cite](https://docs.seomator.com/api-reference/ai-visibility/domains-and-pages-the-ai-answers-cite.md): A source is a page the assistant retrieved (in its source list) or cited inline; a page only linked in the answer text is not a source. `appearances` counts each page once per answer. `answers` counts answers with the domain or page among their sources. `retrieved` counts answers that read it (divid…
- [The web searches ChatGPT ran behind its answers (query fan-out)](https://docs.seomator.com/api-reference/ai-visibility/the-web-searches-chatgpt-ran-behind-its-answers-query-fan-out.md): Only ChatGPT reports the searches it runs, so `answers` counts analyzed ChatGPT answers in scope. `totalQueries` counts every search, `distinctQueries` the different ones (case and spacing ignored).
- [How often the AI answers show shopping cards, ads and maps](https://docs.seomator.com/api-reference/ai-visibility/how-often-the-ai-answers-show-shopping-cards-ads-and-maps.md): `shopping` counts answers with at least one product card; divide by `shoppingAnswers` (ChatGPT and Google AI Mode answers, the assistants that report them). `ads` and `map` count ChatGPT answers that showed ads or a map; divide by `adsAnswers` (only ChatGPT reports them).
- [Totals of the answers read in a period and the one before it](https://docs.seomator.com/api-reference/ai-visibility/totals-of-the-answers-read-in-a-period-and-the-one-before-it.md): `answers` counts the answers that were read; `named` those that name your brand; `searched` those with at least one page in the source list; `citations` the inline citations across them (divide by `answers` for the average).
- [List collected answers, newest first](https://docs.seomator.com/api-reference/ai-visibility/list-collected-answers-newest-first.md): One row per prompt × assistant × day, including failed ones (`status`), so coverage can be shown.
- [One answer with its brand mentions and sources](https://docs.seomator.com/api-reference/ai-visibility/one-answer-with-its-brand-mentions-and-sources.md): `text` is GFM Markdown. Mention `spans` are `[start, end)` UTF-16 offsets into `text`; render it without raw HTML and highlight from the spans.
- [Read the Search Console connection](https://docs.seomator.com/api-reference/ai-visibility/read-the-search-console-connection.md): status is none before a connection and error when Google no longer grants access. Read from our database only; list the properties with GET /gsc/properties.
- [List the Search Console properties of the project domain and its subdomains that the connection can read](https://docs.seomator.com/api-reference/ai-visibility/list-the-search-console-properties-of-the-project-domain-and-its-subdomains-that-the-connection-can-read.md): Asks Google, so it needs the right to change the project. 503 when Google does not answer.
- [Start connecting Search Console](https://docs.seomator.com/api-reference/ai-visibility/start-connecting-search-console.md): Returns the Google consent URL. Google sends the person back to the dashboard, which returns them to returnTo.
- [Pick the Search Console property](https://docs.seomator.com/api-reference/ai-visibility/pick-the-search-console-property.md)
- [Disconnect Search Console and revoke its token](https://docs.seomator.com/api-reference/ai-visibility/disconnect-search-console-and-revoke-its-token.md)
- [Query Search Console clicks, impressions, CTR and position](https://docs.seomator.com/api-reference/search-console/query-search-console-clicks-impressions-ctr-and-position.md): Groups by `dimensions` (query, page, country, device, searchAppearance, date) over `startDate`–`endDate` (default: the last 28 final days, ending 3 days ago). `totals` cover every row; page with `limit` and `nextCursor`.
- [Inspect one URL with Search Console URL Inspection](https://docs.seomator.com/api-reference/search-console/inspect-one-url-with-search-console-url-inspection.md): Index status, last crawl, canonical, mobile usability and rich results for a URL on the project domain.
- [List the sitemaps submitted in Search Console](https://docs.seomator.com/api-reference/search-console/list-the-sitemaps-submitted-in-search-console.md): Each sitemap with when Google last read it, how many URLs it lists and its warning and error counts.

## OpenAPI Specs

- [openapi](https://api.seomator.com/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.