Get AI search visibility numbers for a date range
visibility_get_summaryReturns the numbers behind the Visibility dashboard in Hi, Moose for one date range, with the same filters the dashboard offers: topics, engines, prompts, branded or non-branded prompts, pages cited, sentiment, narrative, feature parity, plus mentioned, cited and competitor. Pick sections to keep the result small: totals (always), engines, topics, prompts, trend (per day), competitors (share of voice, per engine and topic, pages competitors get cited from, prompts competitors win), citations (pages and domains the engines cite, own pages flagged), mentions (every brand named, with rank and sentiment). Pass compare true for the equal window before, or compareFrom and compareTo, to get the same totals for a second window. Use this for reports, dashboards and "how are we doing" questions; use visibility_list_results for the individual answers behind a number and visibility_check_topic for a one-topic question in plain words. Counts cover the tracked prompts on the tracked engines only, sampled on run days, never the whole of AI search: report the window and sample size and never claim causation. Reads stored results only. Takes a few seconds.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day of the window as YYYY-MM-DD. Default today. | |
| from | No | First day of the window as YYYY-MM-DD. Default: lookbackDays before to. | |
| cited | No | true: only answers that cite a page of the brand. false: only answers that do not. | |
| pages | No | Only prompts whose answers cited one of these page URLs, then every engine for those prompts, which is how the Page filter works in Hi, Moose. | |
| topics | No | Only these topics, by the exact names from visibility_list_tracked. "Uncategorized" selects prompts with no topic. | |
| compare | No | true: also return totals for the window of the same length immediately before from. | |
| engines | No | Only these AI engines, by name from visibility_list_tracked, such as "ChatGPT" or "Perplexity". A plain name also matches its local-fetch variant. | |
| project | Yes | The Hi, Moose project, by its name as shown by list_projects. The projectId is also accepted. | |
| prompts | No | Only these prompts, by exact text or promptId from visibility_list_tracked. | |
| sections | No | Which sections to return. Default totals, engines and topics. | |
| compareTo | No | Last day of a custom comparison window, YYYY-MM-DD. Needs compareFrom. | |
| mentioned | No | true: only answers that mention the brand. false: only answers that do not. | |
| narrative | No | Only answers with this narrative verdict against the Brand Truth Profile: aligned, partial or drifted. | |
| sentiment | No | Only answers where the brand was mentioned with this sentiment. | |
| competitor | No | Only answers that mention this competitor, by name from visibility_list_tracked. | |
| promptType | No | Only branded prompts (the prompt names the brand, an alias or an owned domain) or only non-branded prompts. | |
| compareFrom | No | First day of a custom comparison window, YYYY-MM-DD. Needs compareTo. | |
| lookbackDays | No | Window length in days when from is not given. Default 30. | |
| featureParity | No | Only answers with this feature parity verdict: accurate, needs-review, inaccurate or not-applicable. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| jobId | No | ||
| range | No | ||
| trend | No | ||
| status | No | done, failed, pending or running. | |
| totals | No | Counts over the answers in scope. Rates are fractions of answers (0 to 1) and null when there are none. unavailable answers are excluded from the rates. | |
| byTopic | No | ||
| filters | No | The filters that were applied, after validation. | |
| byEngine | No | ||
| byPrompt | No | ||
| headline | No | One sentence with the window, sample size and the main numbers. | |
| mentions | No | ||
| progress | No | ||
| runCount | No | ||
| sections | No | ||
| citations | No | ||
| createdAt | No | ||
| comparison | No | ||
| dataNotice | No | ||
| competitors | No | ||
| projectName | No | ||
| promptCount | No | ||
| byTopicEngine | No | ||
| schemaVersion | No | Version of this result shape. Fields are only added within a version. | |
| trendByEngine | No | ||
| byPromptTruncated | No | true when more than 300 prompts matched; filter by topic to see the rest. |