Vantage tools reference

Returns. Per keyword: whether the domain is cited (in at least half the samples), in how many of the sampled answers, its best rank among the sources, the domains that are cited when it is not, how much of that is community sites such as Reddit and YouTube (source_mix), whether the answer names it without linking to it, the model and time of the answer, and previous and change: your last check of the same domain and keyword, and whether the citation rate went up, down or stayed the same. Overall: keywords checked, keywords cited, coverage percentage, the keywords where the domain is not cited, and the keywords newly cited or no longer cited since your last check.

Note. "Cited" and "mentioned" are reported separately and never merged: a keyword where the answer names you but does not link to you is listed under mentioned_not_cited. A keyword the provider fails on carries an error field instead of failing the whole call. Results are kept for 180 days against your API key and only your key can read them.

{
  "domain": "example.com",
  "keywords": ["best project management software", "asana alternatives"],
  "brand": "Example"
}

Returns. The structure of the winning answer and of your page, each with its section outline; the plain-English gaps; the winning answer's points your page does not appear to cover (word matching, so check each); and fix_brief, the changes to make, most important first. The brief always ends with one step beyond the page: which community sites the cited answer relies on, or which other sites to get mentioned on, because being cited is decided mostly by what other sites say about you. The brief never contains the cited answer's text. If either side cannot be fetched or parsed you get an error instead.

Note. This is the tool to use for "what should I change on this page". For only the winner's shape, use analyze_citation_structure.

{
  "keyword": "best project management tool",
  "your_url": "https://example.com/best-project-management-tools"
}

Returns. The most-cited domains with their mention counts, the provider's own cap on that list, source_mix (the share of those mentions that go to community sites such as Reddit, YouTube and X), and, when compare_domain or compare_domains was given, each domain's rank or null.

Note. Absence from the list is not proof of zero citations, only that the domain did not rank within the provider's cap. This tool reads the provider's tracked mentions, which is a different measurement from the single live answer that analyze_citation_structure reads, so the two can disagree.

{
  "keyword": "best project management tool",
  "platform": "chat_gpt",
  "compare_domain": "example.com"
}

Returns. A list of months, oldest to newest, each with its citation count (a month with no tracked mentions comes back as 0), and a trend: up, down, flat or no_data. With compare_domains, a comparisons list with the same months and trend for each extra domain.

Note. The current month is returned but left out of the trend comparison while it is still in progress. Read isolated zeros with care: in September 2026 checks, July 2026 came back as 0 for all three large domains we tried while June and August were high, which looks like a gap in the provider's history rather than a real drop.

{
  "domain": "example.com",
  "platform": "chat_gpt",
  "months": 6
}

Returns. Whether the answer leads with a list, the opening word count, whether the opening contains a number, the section outline, whether it has a table, the number of sources cited, up to 10 source domains, source_mix (how many of those sources are community sites such as Reddit, YouTube and X), and the model and time of the answer. With more than one sample, also source_frequency: how many of the answers cited each site.

Note. For more than one keyword use analyze_citation_structure_batch. For a comparison against your own page use analyze_citation_gap.

{
  "keyword": "how to reduce churn"
}

Returns. One result per keyword, in the order given, plus a summary: topics analyzed, topics requested, how many lead with a list, the average number of sources cited, and the average share of community sources.

Note. A keyword the provider fails on carries an error field; the rest of the batch still returns.

{
  "keywords": ["how to reduce churn", "churn rate benchmarks", "reduce customer churn saas"]
}

Returns. The total number of tracked questions citing the domain, and up to 20 of them, most asked first, each with its estimated monthly AI search volume, your position among that answer's sources, the other sites it cites, and when the answer was last recorded.

Note. Reads the provider's tracked answers, like find_citation_leaders, not a live answer. An empty list means the tracked answers do not cite you, not that no answer anywhere does. Re-check a question live with analyze_citation_coverage.

{
  "domain": "example.com",
  "platform": "chat_gpt"
}

Returns. Each saved check: keyword, engine, market, samples, how many answers cited you, best rank, how many named you, which of your pages were cited, and when. With page: whether that page was cited in each check, plus times_cited.

Note. Kept 180 days per API key, visible only to that key. It never touches the data provider.

{
  "domain": "example.com"
}

Returns. The engines for the live-answer tools, the Perplexity countries, the platforms for the tracked-data tools, the one market ChatGPT tracked data covers, the default market, and the limits (samples, keywords, trend months, compared domains).

Note. A market the provider does not cover comes back as an error that is refunded, never charged.

{}

Returns. Your tier, the billing period (YYYY-MM), units used, units limit and units remaining.

Note. Use it before a large batch to see whether the batch will fit.

{}