# Qwairy Documentation - [Use cases (71 pages)](https://docs.qwairy.co/_llms/en/use-cases.txt): Documentation for Use cases. ## Product ### Get started - [What is Qwairy](https://docs.qwairy.co/documentation/get-started/what-is-qwairy.md): Learn how Qwairy observes brand visibility in AI answers, detects mentions, citations and competitors, and turns monitoring data into analysis and actions. - [Quickstart](https://docs.qwairy.co/documentation/get-started/quickstart.md): Follow the five-step onboarding wizard to create a workspace, review the generated topics and prompts, choose monitoring settings, and inspect first answers. - [Core concepts](https://docs.qwairy.co/documentation/get-started/core-concepts.md): Definitions for prompts, topics, tags, models, countries, personas, answers, mentions, citations, and the dashboard metrics used throughout Qwairy. - [Interpreting your first results](https://docs.qwairy.co/documentation/get-started/first-results.md): Review your first monitoring snapshot, check its scope of prompts and models, and trace each dashboard metric back to the prompts and answers behind it. - [Providers and credits](https://docs.qwairy.co/documentation/get-started/credits.md): Review the AI models Qwairy supports, how each one collects answers, and the credit cost of every operation, from monitoring runs to the settings that add cost. - [Frequently asked questions](https://docs.qwairy.co/documentation/get-started/faq.md): Find answers about monitoring and data, metrics, topics, prompts, credits, website access, competitors, exports, and integrations in one place. ### Monitor - [Overview](https://docs.qwairy.co/documentation/cockpit/performance-dashboard.md): Read the five dashboard metrics, trends, competitors, sources, and breakdowns in Cockpit Overview for the current workspace and its filter scope. - [GEO Matrix](https://docs.qwairy.co/documentation/cockpit/geo-matrix.md): Compare a visibility metric across AI providers and topics, tags, personas, funnel stages, prompts, or countries, with provider columns showing the same metric. - [Prompt Tracking](https://docs.qwairy.co/documentation/monitor/tracking-queries.md): Review monitored prompts, see how your brand ranks across providers over time, and use the page filters and signals to decide which prompts to prioritize. - [Response Analysis](https://docs.qwairy.co/documentation/monitor/analyzing-answers.md): Search and filter individual AI answers by prompt, funnel stage, or competitors, then inspect the mentions, sources, and insight metadata attached to each one. - [Competitor Mentions](https://docs.qwairy.co/documentation/monitor/competitor-mentions.md): Review detected brands, correct their relationship to your brand, fix their domains, and inspect competitor presence in your monitored answers. - [Source Explorer](https://docs.qwairy.co/documentation/monitor/content-sources.md): Analyze cited domains and pages, their ownership and usage type, and whether sources mention your brand on the page, with an export for each tab. #### Signals and insights - [Query Fan-Out](https://docs.qwairy.co/documentation/monitor/insights/query-fan-out.md): Review the web search queries AI models run before answering, with their types, priorities and brand mention rate, and add relevant queries to monitoring. - [Follow-Ups](https://docs.qwairy.co/documentation/monitor/insights/follow-ups.md): Review the follow-up questions AI models suggest after monitored answers, see their usage and types, and add relevant ones to your monitoring. - [Shopping Results](https://docs.qwairy.co/documentation/monitor/insights/shopping-intelligence.md): Inspect the products, stores, ratings, and shopping opportunities detected in monitored AI answers, including prompts where your products could appear. - [Local Businesses](https://docs.qwairy.co/documentation/monitor/insights/local-intelligence.md): Inspect local businesses detected in monitored AI answers, with their locations, categories, ratings, and the local visibility opportunities that stand out. - [Social Signals](https://docs.qwairy.co/documentation/monitor/insights/social-intelligence.md): Review the social platforms and pages cited in monitored AI answers, with social citations, share of voice, and their contribution to the source mix. - [Sponsored Content](https://docs.qwairy.co/documentation/monitor/insights/sponsored-content.md): Review the ads, advertisers, products, and prompts detected in sponsored AI answer metadata, with summary cards and an overview of the sponsored records. ### Analyze - [Compare](https://docs.qwairy.co/documentation/cockpit/compare.md): Compare up to 10 brands, your own included, side by side across metrics, positioning, co-mentions, trends, and breakdowns in one analytical scope. - [Sentiment](https://docs.qwairy.co/documentation/analyze/sentiment-analysis.md): Review the 0 to 100 sentiment score assigned to brand mentions, its evolution and breakdown, and the evidence behind each score in monitored answers. - [Perception](https://docs.qwairy.co/documentation/analyze/brand-perception.md): Measure how AI providers describe your brand compared with the attributes you define, through sentiment, alignment, consistency, and factual scores. - [Fact Check](https://docs.qwairy.co/documentation/analyze/fact-check.md): Extract claims from monitored answers, compare them with a source of truth, and record human verification decisions. Available in private beta on request. ### Act and optimize - [Action Center](https://docs.qwairy.co/documentation/cockpit/action-center.md): Review prioritized suggestions from your monitoring data, plan the actions you accept, and tune the strategy that ranks these suggestions for your workspace. - [Content Opportunities](https://docs.qwairy.co/documentation/act/content-opportunities.md): Find prompts where direct competitors are mentioned without your brand, ranked by the visibility you could gain, to decide which content to create or revise. - [Backlink Opportunities](https://docs.qwairy.co/documentation/act/backlink-opportunities.md): Find placements available to buy on domains that AI models already cite, with priority, domain rating, and prices from sponsored content marketplaces. - [Content Studio](https://docs.qwairy.co/documentation/act/content-studio.md): Create AI-citable articles from briefs built on Qwairy insights, then generate the outline, content, and SEO metadata as a draft for human review. - [Site Readiness](https://docs.qwairy.co/documentation/optimize/site-readiness.md): Check robots.txt, llms.txt, and sitemap.xml, review AI crawler access and your AI Readiness Score, and get an llms.txt template for the monitored domain. - [Site Diagnostics](https://docs.qwairy.co/documentation/optimize/site-diagnostics.md): Import pages from your sitemap, audit their technical, content, AEO, and PageSpeed scores, and track results over time for the monitored brand. ### Measure - [Google Search Console](https://docs.qwairy.co/documentation/measure/google-search-console.md): Connect a Search Console property, review Google Search queries and pages next to Qwairy data, and turn relevant queries into prompts or content. - [Bing Webmaster Tools](https://docs.qwairy.co/documentation/measure/bing-webmaster.md): Connect a verified Bing Webmaster Tools site with an API key and review the Bing Search queries and pages that can inform Copilot visibility. - [Crawler Analytics](https://docs.qwairy.co/documentation/measure/crawler-analytics.md): Configure a supported server-log collector and analyze retained snapshots of requests classified as AI crawlers, accepted from a connected log source. - [Referrer Analytics](https://docs.qwairy.co/documentation/measure/referrer-analytics.md): Analyze sessions that a connected analytics provider classifies as referrals from AI platforms, covering human traffic from detected AI referrers. - [AI Revenue](https://docs.qwairy.co/documentation/measure/ai-revenue.md): Attribute configured business conversions to AI referral or acquisition evidence while keeping measured revenue separate from estimated value. - [Page Performance](https://docs.qwairy.co/documentation/measure/page-performance.md): Compare page-level signals from AI answers, GA4 referrals, retained crawler rollups, Google Search Console, and Bing Webmaster Tools in one table. #### Crawler collectors - [Generic HTTP collector](https://docs.qwairy.co/documentation/measure/crawler-analytics/connectors/generic-http.md): Send filtered server or edge request logs to Crawler Analytics through the generic ingestion endpoint, with only the fields needed for crawler aggregation. - [Cloudflare Worker](https://docs.qwairy.co/documentation/measure/crawler-analytics/connectors/cloudflare-worker.md): Deploy Qwairy's generated edge collector on a Cloudflare Worker route and verify crawler delivery safely when Cloudflare Logpush is not your delivery source. - [WordPress](https://docs.qwairy.co/documentation/measure/crawler-analytics/connectors/wordpress.md): Install Qwairy's generated PHP tracker in WordPress, protect its key, and verify eligible HTML page requests from crawlers reported to Crawler Analytics. - [Vercel Drains](https://docs.qwairy.co/documentation/measure/crawler-analytics/connectors/vercel.md): Connect Vercel production request logs to Crawler Analytics through a dedicated JSON drain, using a Vercel Pro or Enterprise team that can manage Drains. - [Cloudflare Logpush](https://docs.qwairy.co/documentation/measure/crawler-analytics/connectors/cloudflare.md): Configure a bounded Cloudflare Logpush HTTP job that sends a filtered HTTP Requests dataset to Crawler Analytics from a Cloudflare Enterprise zone. - [AWS CloudFront through Firehose](https://docs.qwairy.co/documentation/measure/crawler-analytics/connectors/aws-cloudfront.md): Send CloudFront Standard Logging v2 records to Crawler Analytics through Amazon Data Firehose as a minimal JSON request dataset for your distribution. - [Akamai DataStream 2](https://docs.qwairy.co/documentation/measure/crawler-analytics/connectors/akamai.md): Configure an Akamai DataStream 2 custom HTTPS destination that sends a minimal JSON request dataset to Crawler Analytics for the target property. - [Fastly HTTPS Logging](https://docs.qwairy.co/documentation/measure/crawler-analytics/connectors/fastly.md): Configure a bounded Fastly HTTPS logging endpoint that delivers a minimal request record from a Fastly CDN service for your hostname to Crawler Analytics. - [Netlify Log Drains](https://docs.qwairy.co/documentation/measure/crawler-analytics/connectors/netlify.md): Connect Netlify traffic logs to Crawler Analytics through a General HTTP log drain, using a Netlify Enterprise account with access to the target site. #### Analytics integrations - [Analytics integrations](https://docs.qwairy.co/documentation/measure/integrations/overview.md): Choose an analytics connection for AI-referral traffic, revenue attribution, and page-level reporting, from Google Analytics 4, Piwik PRO, Matomo, and more. - [Google Analytics 4](https://docs.qwairy.co/documentation/measure/integrations/google-analytics.md): Connect a GA4 property for measured AI-referral traffic and configurable purchase or event conversions, starting from Measure Referrer Analytics. - [Piwik PRO](https://docs.qwairy.co/documentation/measure/integrations/piwik-pro.md): Connect a Piwik PRO site for AI-referral traffic and configurable purchase or event conversions using a Client ID and Client Secret with read access. - [Matomo](https://docs.qwairy.co/documentation/measure/integrations/matomo.md): Connect a Matomo site for AI-referral traffic and configurable purchase or goal conversions using an authentication token with read access to the site. - [Piano Analytics](https://docs.qwairy.co/documentation/measure/integrations/piano-analytics.md): Connect the Piano Analytics Data API for AI-referral traffic and configurable purchase or metric conversions with a Data API key and numeric Site ID. - [Amplitude](https://docs.qwairy.co/documentation/measure/integrations/amplitude.md): Connect an Amplitude project with its API key, Secret Key, and region to track AI-referrer users or events when referring-domain data is available. - [Adobe Analytics](https://docs.qwairy.co/documentation/measure/integrations/adobe-analytics.md): Connect an Adobe Analytics report suite for AI-referral traffic and configurable purchase or metric conversions using OAuth Server to Server credentials. ### AI Assistant - [AI Assistant](https://docs.qwairy.co/documentation/assistant/ai-assistant.md): Ask questions about a workspace's monitoring data and get text, tables, and charts, start from an Agent Skill, and check the data behind each answer. ### Manage workspace - [Workspaces](https://docs.qwairy.co/documentation/workspace/workspaces.md): List your workspaces with their market, engines, schedule, last run, and monthly credits, then create, group, archive, reactivate, or delete them. - [Configuration](https://docs.qwairy.co/documentation/workspace/brand-settings.md): Edit the brand details, countries, competitor detection, and domain scope of the current workspace, find its Brand ID, or archive and delete it. - [Monitoring](https://docs.qwairy.co/documentation/workspace/monitoring.md): Set the workspace monitoring schedule, choose AI models, review the credit estimate, and launch a manual analysis. Not available on the Free plan. - [Activity](https://docs.qwairy.co/documentation/workspace/activity.md): Follow scheduled, manual, onboarding, and new-prompt generation runs with their scope, progress, status, and failed responses, from newest to oldest. - [Prompts](https://docs.qwairy.co/documentation/workspace/prompts.md): Add, import, organize, schedule, pause, boost, assign, regenerate, and remove the prompts monitored for a workspace, all from its Settings page. - [Topics](https://docs.qwairy.co/documentation/workspace/topics.md): Group prompts into thematic topics and use those groups in dashboard filters and breakdowns such as GEO Matrix, Compare, and Content Opportunities. - [Tags](https://docs.qwairy.co/documentation/workspace/tags.md): Create reusable labels, assign several tags to a prompt, and filter Qwairy views by custom groupings such as campaigns, markets, or audiences. - [Lists](https://docs.qwairy.co/documentation/workspace/lists.md): Save a named set of filters, such as provider and topic, from the filter bar or settings, and reuse it across compatible dashboard and analysis views. - [Personas](https://docs.qwairy.co/documentation/workspace/personas.md): Describe the readers you monitor for, so that prompts run from their point of view and results can be compared by persona, with one run per persona. - [Notifications](https://docs.qwairy.co/documentation/workspace/notifications.md): Enable or disable the weekly email report for the current workspace, see when the last report was sent, and understand related transactional emails. - [Viewers](https://docs.qwairy.co/documentation/workspace/viewers.md): Grant and remove read-only access to selected workspaces for team members with the Viewer role, and review the active viewers of the current workspace. - [Shared Links](https://docs.qwairy.co/documentation/workspace/shared-links.md): Create, review, expire, and revoke public links that expose selected Qwairy views, such as Overview or GEO Matrix, outside the signed-in workspace. - [Exports](https://docs.qwairy.co/documentation/workspace/exports.md): Monitor, download, and remove the point-in-time data exports generated from dashboard pages for the current workspace, from pending to completed. ### Availability - [Supported countries and territories](https://docs.qwairy.co/documentation/availability/countries.md): Compare market and AI engine availability for continuous workspaces and one-off Pitch Audits, and see how country scope works on each surface. - [Supported languages](https://docs.qwairy.co/documentation/availability/languages.md): Review the languages available for continuous workspaces and one-off Pitch Audits, and how the language affects generated content and reports. ### Team and security - [Your account](https://docs.qwairy.co/documentation/account/settings.md): Update your name, review your sign-in email, and choose the language of the dashboard interface. These settings apply to every team you belong to. - [Settings](https://docs.qwairy.co/documentation/team/settings.md): Review the immutable team identifier, change the team's display name, and see the feature overrides and beta access that apply to the account. - [Members](https://docs.qwairy.co/documentation/team/manage-members.md): Review the team roster, invite members, assign roles and see what each role can do, manage Viewer workspace access, and track pending invitations. - [Roles and permissions](https://docs.qwairy.co/documentation/team/roles-and-permissions.md): Compare what Owners, Managers, Members, and Viewers can see and change in Qwairy, with a permissions table and practical guidance for team members. - [Usage](https://docs.qwairy.co/documentation/team/usage.md): Review the team credit balance, consumption, additions, projection, breakdowns, and transaction history, for the billing period or a scope you choose. - [Billing](https://docs.qwairy.co/documentation/team/billing.md): Review the current plan, change plan, manage additional workspaces and credit packs, and download invoices for the root team's subscription. - [Virtual Teams](https://docs.qwairy.co/documentation/team/virtual-teams.md): Create isolated sub-teams, allocate credits and workspace quota, and move eligible workspaces on Business, Enterprise and Agency Business plans. - [SSO](https://docs.qwairy.co/documentation/team/sso.md): Configure an OIDC identity provider, verify email domains, enable sign-in, and optionally enforce SSO. Available on the Enterprise plan for team Owners. ## API ### Get started - [Introduction](https://docs.qwairy.co/developers/introduction.md): Start with Qwairy API v1 authentication, response shapes, pagination, and core endpoints to read answers, citations, competitors, and aggregate metrics. - [Quick start](https://docs.qwairy.co/developers/guides/index.md): Make your first Qwairy API call with an API token and brand ID, get your brand's performance scores, then build on the shared client and worked guides. - [Authentication](https://docs.qwairy.co/developers/authentication.md): Authenticate Qwairy API requests with a team-scoped Bearer token created under Team Management REST API, which gives access to all brands in your account. - [API tokens](https://docs.qwairy.co/developers/api-keys.md): Create and manage API tokens for programmatic access to your Qwairy data, with a separate token per integration so you can revoke access independently. - [Rate limits](https://docs.qwairy.co/developers/rate-limits.md): Understand the team-level API limits of 1,000 requests per minute and 20,000 per day, plus rate-limit headers and Retry-After handling in your client. - [Error codes](https://docs.qwairy.co/developers/errors.md): Handle the two error shapes API v1 returns, resource errors raised inside an endpoint and gateway errors raised before an endpoint runs, with their codes. - [Entities](https://docs.qwairy.co/developers/entities.md): Reference the shared objects and metric fields returned by API v1, including pagination, while endpoint pages remain the source of truth for each route. ### Configure data #### Brands - [List brands](https://docs.qwairy.co/developers/endpoints/brands/list.md): Retrieve all live brands accessible to your team, ordered by name, using a Bearer token. The response follows the Brand object described in Entities. - [Get brand](https://docs.qwairy.co/developers/endpoints/brands/get.md): Retrieve detailed information about one accessible brand, with current counts of non-deleted prompts and answers and SELF or DIRECT competitor domains. #### Topics - [List topics](https://docs.qwairy.co/developers/endpoints/keywords/list.md): Analyze performance by topic, with answer counts and response-level SELF metrics for the selected scope. Routes keep the keywords name for compatibility. - [Topic evolution](https://docs.qwairy.co/developers/endpoints/keywords/evolution.md): Get daily time-series metrics for one topic, including Mention Rate, Source Rate, and Share of Voice at the response level for the selected period. #### Tags - [List tags](https://docs.qwairy.co/developers/endpoints/tags/list.md): Analyze performance by tag, with answer counts and response-level SELF metrics for the selected scope. Tag objects are described in Entities. - [Tag evolution](https://docs.qwairy.co/developers/endpoints/tags/evolution.md): Get daily time-series metrics for one tag, including Mention Rate, Source Rate, and Share of Voice at the response level for the selected period. ### Monitor and measure - [Get crawler analytics](https://docs.qwairy.co/developers/endpoints/crawler-analytics.md): Retrieve retained AI crawler activity, delivery coverage, and page-level observations for a brand, as daily aggregates that never include raw log events. #### Performance - [Get performance snapshot](https://docs.qwairy.co/developers/endpoints/performance.md): Read response-level mention, citation, sentiment, and Share of Voice metrics for a brand, plus topic, tag, competitor, and source breakdowns. - [Get GEO matrix](https://docs.qwairy.co/developers/endpoints/matrix.md): Get the GEO visibility matrix for your brand as a cross tabulation, with rows grouped by topic, tag, prompt, or funnel stage and columns grouped by provider. #### Prompts - [List prompts](https://docs.qwairy.co/developers/endpoints/prompts/list.md): Get paginated monitored prompts with answer counts, response-level SELF metrics, funnel stage, topic and tags, plus search and filtering options. - [Get prompt](https://docs.qwairy.co/developers/endpoints/prompts/get.md): Retrieve one prompt with response-level metrics and up to 100 aggregated query fan-outs, with an include option for mention and citation aggregates. - [Prompt answers](https://docs.qwairy.co/developers/endpoints/prompts/answers.md): Retrieve all stored AI-generated answers for a specific monitored prompt of a brand, optionally filtered by provider. This endpoint is not paginated. - [Prompt evolution](https://docs.qwairy.co/developers/endpoints/prompts/evolution.md): Track how a prompt's response-level metrics change over time with daily values, including Mention Rate and Source Rate for eligible SELF or DIRECT answers. #### Answers - [List answers](https://docs.qwairy.co/developers/endpoints/answers/list.md): Retrieve stored AI-generated answers with filters for provider, brand mentions, and sources, as a text preview with response-level SELF flags. - [Get answer](https://docs.qwairy.co/developers/endpoints/answers/get.md): Retrieve a single AI response with full text and detailed analysis, including its prompt, detected mentions, citations, query fan-outs, and SELF sentiment. #### Competitors - [List competitors](https://docs.qwairy.co/developers/endpoints/competitors/list.md): Track competitor mentions, share of voice, and positioning by listing competitor domains and mention metrics. SELF and DIRECT are included by default. - [Get competitor](https://docs.qwairy.co/developers/endpoints/competitors/get.md): Retrieve detailed competitor info with breakdowns by provider and topic, including Share of Voice against SELF and DIRECT mention occurrences. - [Competitor evolution](https://docs.qwairy.co/developers/endpoints/competitors/evolution.md): Track how a competitor's metrics change over time with daily mention occurrences, Share of Voice, average position, and average mention sentiment. #### Sources - [List source domains](https://docs.qwairy.co/developers/endpoints/source-domains/list.md): Monitor which domains AI platforms cite, with each domain's share of citation occurrences in the selected scope. See Entities for the Source object. - [Get source domain](https://docs.qwairy.co/developers/endpoints/source-domains/get.md): Retrieve detailed source info with breakdowns by provider and topic, plus date-scoped metrics and the latest public AI Source Authority score. - [Source domain evolution](https://docs.qwairy.co/developers/endpoints/source-domains/evolution.md): Track how a source domain's citation metrics change over time, with daily citation occurrences and average citation position for each day in the period. - [List source URLs](https://docs.qwairy.co/developers/endpoints/source-urls.md): Track individual page citations by listing cited URLs with occurrence counts, average position, taxonomy, and relationship flags for the selected scope. #### Signals - [List query fan-out records](https://docs.qwairy.co/developers/endpoints/search.md): List aggregated web-search queries recorded while providers generated answers, grouped by normalized query text with presence counts and a priority label. - [List follow-ups](https://docs.qwairy.co/developers/endpoints/follow-ups.md): List the next questions AI providers suggested after monitored answers, newest first, with their source prompt, answer, and monitoring status. - [List shopping results](https://docs.qwairy.co/developers/endpoints/shopping.md): List shopping observations extracted from stored answers. Product details, ratings, reviews, and purchase options can be null or empty when not captured. - [List local business insights](https://docs.qwairy.co/developers/endpoints/local.md): List local business observations extracted from stored answers. Each record is an observation, not a verified recommendation or current business listing. - [List social signals](https://docs.qwairy.co/developers/endpoints/social.md): List citations classified as social-platform sources in stored answers, filterable by reddit, youtube, twitter, facebook, linkedin, or other. - [List sponsored content](https://docs.qwairy.co/developers/endpoints/sponsored.md): List sponsored placements detected in stored answers. A record reflects the captured answer at that time and does not confirm an active campaign. ### Analyze and act - [List actions](https://docs.qwairy.co/developers/endpoints/actions/list.md): List the Action Center's prioritized recommendation queue for a brand, with deterministic scores, tiers, and quick-win flags to use as prioritization inputs. - [Get Site Readiness analysis](https://docs.qwairy.co/developers/endpoints/technical-analysis.md): Read the latest stored Site Readiness analysis for robots.txt, llms.txt, and sitemap.xml. This read-only request does not start a new crawl for the brand. #### Perception - [List perception snapshots](https://docs.qwairy.co/developers/endpoints/perception/list.md): List completed monthly perception snapshots with scores, trends, averages, and history, including sentiment, alignment, consistency, and factual alignment. - [Get perception snapshot](https://docs.qwairy.co/developers/endpoints/perception/get.md): Retrieve one completed perception snapshot with scores, attribute alignment, and SWOT observations, using the snapshotId from the perception history. #### Content - [List content](https://docs.qwairy.co/developers/endpoints/content/list.md): List Content Studio articles for syndication to an external CMS, returning article metadata and defaulting to LIVE status unless you pass another status. - [Get content](https://docs.qwairy.co/developers/endpoints/content/get.md): Retrieve a full Content Studio article including the Markdown body, with its outline, metadata, and sources, for read-only integrations such as a CMS. ### Agency and automation - [Outbound webhooks](https://docs.qwairy.co/developers/webhooks.md): Receive weekly-report and export-ready events as signed JSON POST requests to your endpoint, in place of the matching email, on an Enterprise team. #### Pitch audits - [List Pitch Audits](https://docs.qwairy.co/developers/endpoints/pitch-audits/list.md): List the read-only Pitch Audit snapshots created by the agency workspace attached to your API token. It never starts, retries, or modifies an audit. - [Get Pitch Audit](https://docs.qwairy.co/developers/endpoints/pitch-audits/get.md): Read the original prospect report for a Pitch Audit, including its profile, prompts, scores, competitors, sources, insights, and recommendations. - [Get Pitch Audit subject report](https://docs.qwairy.co/developers/endpoints/pitch-audits/get-report.md): Read a competitor or co-competitor view derived from one Pitch Audit, pivoting its evidence without creating a second audit or regenerating data. ### Implementation guides - [Custom dashboard](https://docs.qwairy.co/developers/guides/custom-dashboard.md): Build a dashboard from performance, competitor, source, answer, and query fan-out data while keeping the metric scope of each API surface visible. - [Weekly reports](https://docs.qwairy.co/developers/guides/weekly-reports.md): Compare two complete, non-overlapping seven-day API windows with explicit methodology, defined in UTC for a repeatable week-over-week report. - [Competitive analysis](https://docs.qwairy.co/developers/guides/competitive-analysis.md): Compare SELF and DIRECT observations, then measure one competitor across a consistent API scope with mentions and Share of Voice within one answer set. - [Data export](https://docs.qwairy.co/developers/guides/data-export.md): Export GEO data to CSV, JSON, and BI tools like BigQuery or Snowflake for analysis in spreadsheets, databases, or BI platforms with the shared API client. ## MCP ### Get started - [Qwairy MCP server](https://docs.qwairy.co/mcp/introduction.md): Connect an MCP-compatible assistant to read authorized Qwairy monitoring data and documentation, and inspect brands, answers, competitors, and sources. - [Connect an MCP client](https://docs.qwairy.co/mcp/getting-started.md): Connect Claude, ChatGPT, GitHub Copilot, Cursor, Windsurf, or another MCP client to Qwairy with OAuth or a Personal Access Token at https://mcp.qwairy.co. - [OAuth Authentication](https://docs.qwairy.co/mcp/oauth.md): How the Qwairy MCP server authenticates connections using OAuth 2.1 with PKCE, so AI clients receive a scoped access token and never your credentials. - [Cross-tool MCP workflows](https://docs.qwairy.co/mcp/workflows.md): Combine read-only Qwairy evidence with authorized analytics, content, reporting, and task-management tools in MCP clients that connect to several servers. ### Clients - [Connect Qwairy to Claude](https://docs.qwairy.co/mcp/clients/claude.md): Yes. Add Qwairy to claude.ai or Claude Desktop as a custom connector with OAuth, using the server URL https://mcp.qwairy.co. No terminal or API key needed. - [Connect Qwairy to Claude Code](https://docs.qwairy.co/mcp/clients/claude-code.md): Yes. Add Qwairy to Claude Code as a remote HTTP server with one command, then sign in with OAuth. Use https://mcp.qwairy.co as the server URL. - [Connect Qwairy to ChatGPT](https://docs.qwairy.co/mcp/clients/chatgpt.md): Yes, on ChatGPT Business, Enterprise, and Edu. Add Qwairy as a custom MCP server with OAuth in ChatGPT on the web, using https://mcp.qwairy.co. - [Connect Qwairy to GitHub Copilot in VS Code](https://docs.qwairy.co/mcp/clients/github-copilot.md): Yes. Add Qwairy to GitHub Copilot in VS Code as an HTTP MCP server and sign in with OAuth, using https://mcp.qwairy.co. Organization policy may apply. - [Connect Qwairy to Cursor](https://docs.qwairy.co/mcp/clients/cursor.md): Yes. Add Qwairy to Cursor with a remote MCP server entry in mcp.json, then sign in with OAuth, using the server URL https://mcp.qwairy.co in the editor. - [Connect Qwairy to Windsurf and Devin Local](https://docs.qwairy.co/mcp/clients/windsurf.md): Yes. Add Qwairy to Windsurf with Devin Local by running one devin command and signing in with OAuth, using the server URL https://mcp.qwairy.co. - [Connect Qwairy to other MCP clients](https://docs.qwairy.co/mcp/clients/other-clients.md): Qwairy works with any MCP client that supports remote Streamable HTTP servers. Use OAuth, or a Personal Access Token for headless clients: https://mcp.qwairy.co ### Tool reference - [Discovery tools](https://docs.qwairy.co/mcp/tools/discovery.md): Tools to discover monitored brands and their configured topics and tags in Qwairy, starting with list_brands to get the brand IDs other tools need. - [Filter compatibility](https://docs.qwairy.co/mcp/tools/filters.md): Canonical filter contract and tool-by-tool compatibility for all Qwairy MCP tools, with live tool discovery as the reference for input schemas. - [Performance tools](https://docs.qwairy.co/mcp/tools/performance.md): Tools to analyze your brand's GEO performance and topic-level metrics, such as mention rate, source rate, and share of voice, with shared evidence filters. - [Competitor tools](https://docs.qwairy.co/mcp/tools/competitors.md): Tools to analyze the competitors mentioned in AI responses, rank them by mentions within an evidence scope, and track how they evolve over time. - [Prompt and response tools](https://docs.qwairy.co/mcp/tools/responses.md): Tools to browse monitored prompts and analyze AI responses in detail, filtered by period, custom dates, providers, topics, tags, and funnel stages. - [Source tools](https://docs.qwairy.co/mcp/tools/sources.md): Tools to analyze which domains and URLs AI providers cite as sources, including cited domains ranked by mention frequency for a brand's answers. - [Strategic tools](https://docs.qwairy.co/mcp/tools/strategic.md): Tools for brand perception, technical status, prompt signals, Action Center recommendations, and content gaps where competitors appear without the brand. - [Insight tools](https://docs.qwairy.co/mcp/tools/insights.md): Tools for vertical insights, including shopping, social, local businesses, web search queries, and the follow-up questions AI providers suggest. - [Measure tools](https://docs.qwairy.co/mcp/tools/measure.md): Off-AI web analytics from connected integrations, including Google Search Console, Bing, analytics revenue and referrers, and AI crawler activity. - [Deep-dive tools](https://docs.qwairy.co/mcp/tools/deep-dive.md): Tools for detailed analysis, including on-page presence, source profiles, competitor positioning, and the GEO visibility matrix for your brand. - [Pitch Audit tools](https://docs.qwairy.co/mcp/tools/pitch-audits.md): Read agency Pitch Audits and co-competitor reports through MCP. These read-only tools expose pre-sales reports and never create, retry, or change an audit. - [Documentation tool](https://docs.qwairy.co/mcp/tools/documentation.md): Search Qwairy product documentation, guides, best practices, and GEO strategies directly from the MCP without leaving your assistant conversation. ### Examples - [First MCP conversation](https://docs.qwairy.co/mcp/examples/getting-started.md): Discover accessible brands, inspect one performance scope, and identify evidence to review next with your first three questions in an MCP conversation. - [MCP performance review](https://docs.qwairy.co/mcp/examples/performance.md): Inspect visibility trends, provider differences, topic breakdowns, and matrix evidence through MCP, using a weekly performance review workflow as a guide. - [MCP competitor review](https://docs.qwairy.co/mcp/examples/competitors.md): Compare configured competitors, trends, positions, and answer evidence through MCP, following example conversations on your competitive landscape. - [MCP answer review](https://docs.qwairy.co/mcp/examples/responses.md): Browse stored answers and inspect brand mentions, citations, competitors, and context through MCP, starting from the most recent AI responses. - [MCP source review](https://docs.qwairy.co/mcp/examples/sources.md): Inspect observed source domains, cited URLs, page presence, and social citations through MCP to review the citation landscape of selected answers. ### Workflows - [Cross-surface audit workflow](https://docs.qwairy.co/mcp/examples/full-geo-audit.md): Combine overview, matrix, page-presence, technical, and action evidence in one MCP conversation to document a cross-surface audit of your brand. - [Content opportunity workflow](https://docs.qwairy.co/mcp/examples/content-strategy.md): Use observed content, query, shopping, and local gaps to form testable content hypotheses, investigating where competitors appear with Qwairy MCP. - [Competitor deep dive](https://docs.qwairy.co/mcp/examples/competitive-deep-dive.md): Inspect where and how a selected competitor appears in the authorized monitoring scope, comparing its observed mentions with your brand through MCP. ## Looker Studio ### Get started - [Connect Looker Studio](https://docs.qwairy.co/looker-studio/getting-started.md): Connect Qwairy to Google Looker Studio and build reports from purpose-specific monitoring data sources, and combine them with other data sources. - [Troubleshoot Looker Studio](https://docs.qwairy.co/looker-studio/troubleshooting.md): Resolve connection, schema, date-range, and metric-alignment issues in the Qwairy Looker Studio connector, including the 90-day default date range. ### Data sources - [Prompt Performance](https://docs.qwairy.co/looker-studio/sources/prompt-performance.md): Analyze individual monitored prompts and period-level mention state in Looker Studio with prompt-level metrics by date, provider, and funnel stage. - [Performance Overview](https://docs.qwairy.co/looker-studio/sources/performance-overview.md): High-level daily performance metrics aggregated by provider in Looker Studio, with optional topic and tag dimensions and date-range filtering. - [Competitor Metrics](https://docs.qwairy.co/looker-studio/sources/competitor-metrics.md): Detailed competitor-level metrics for benchmarking analysis in Looker Studio, keyed by the stable competitor domain identifier and the analysis date. - [Source Domains](https://docs.qwairy.co/looker-studio/sources/source-domains.md): Domain-level metrics for tracking which domains are cited in Looker Studio, as an aggregated view with source domain, source type, provider, and date. - [Source URLs](https://docs.qwairy.co/looker-studio/sources/source-urls.md): Analyze cited pages at URL, topic, or tag grain in Looker Studio by choosing the one of the three Source URLs data sources that fits your report. - [Tag Performance](https://docs.qwairy.co/looker-studio/sources/tag-performance.md): Aggregated metrics by tag for grouped analysis in Looker Studio, with the tag ID and name alongside the provider, the analysis date, and total prompts. - [Keyword Performance](https://docs.qwairy.co/looker-studio/sources/keyword-performance.md): Analyze topic-level metrics through the Looker Studio connector's Keyword Performance source, where the fields call a topic a keyword, by date and provider. - [Answer Details](https://docs.qwairy.co/looker-studio/sources/answer-details.md): Per-answer metadata (prompt, funnel, topic) for granular analysis in Looker Studio, with mention metrics for each AI response and without the response text. - [Shopping Insights](https://docs.qwairy.co/looker-studio/sources/shopping-insights.md): Product recommendations extracted from structured results of compatible AI models in Looker Studio. Availability varies by provider and model. - [Local Insights](https://docs.qwairy.co/looker-studio/sources/local-insights.md): Local business recommendations extracted from structured results of compatible AI models in Looker Studio. Availability varies by provider and model. - [Search Insights](https://docs.qwairy.co/looker-studio/sources/search-insights.md): Web search queries generated by AI providers during response generation in Looker Studio, with the original prompt, provider, and query fields. - [Social Insights](https://docs.qwairy.co/looker-studio/sources/social-insights.md): Citations from social platforms (Reddit, YouTube, Twitter, forums) in Looker Studio, with the platform, community, provider, and date of each citation. ## Agencies ### Overview - [Agency white label](https://docs.qwairy.co/agencies/introduction.md): Configure a custom logo, dashboard domain, login branding, and removal of Qwairy attribution to apply your organization's branding to supported surfaces. - [Manage agency clients](https://docs.qwairy.co/agencies/agency-guide.md): Choose a client isolation, access, branding, and reporting model for agencies running GEO monitoring for several client brands in multiple Qwairy workspaces. - [Pitch Audits](https://docs.qwairy.co/agencies/pitch-audits.md): Create pre-sales AI visibility audits for prospects before onboarding them into a full workspace, to qualify them and prepare sales conversations. ### Branding - [Custom Logo](https://docs.qwairy.co/agencies/logo.md): Upload your own logo to replace Qwairy branding across the dashboard, shared reports, and your branded login, from Team Management White Label. - [Remove Branding](https://docs.qwairy.co/agencies/remove-branding.md): Hide the Powered by Qwairy attribution on shared pages and reports with a single toggle in Team Management White Label, so clients see your brand. ### Custom domain - [Custom domain](https://docs.qwairy.co/agencies/custom-domain/overview.md): Serve the Qwairy dashboard and login from a branded subdomain such as analytics.example.com so your team and clients sign in under your brand. - [DNS Setup](https://docs.qwairy.co/agencies/custom-domain/dns-setup.md): Set up your custom domain in two parts, adding the subdomain in White Label settings, then pointing it to Qwairy with a CNAME record at your DNS provider. - [Verification](https://docs.qwairy.co/agencies/custom-domain/verification.md): Verify your DNS configuration to activate your custom domain, with provisioning and the HTTPS certificate handled automatically for your team. ### Notifications and delivery - [Agency notifications](https://docs.qwairy.co/agencies/notifications.md): Control which email notifications Qwairy sends for each workspace, including the weekly report that keeps your team informed about AI visibility changes. ## Changelog ### Release notes - [Changelog](https://docs.qwairy.co/updates/changelog.md): Review the features, improvements, and fixes introduced in each Qwairy release, with historical notes that may differ from the current product. - [Version 1.19](https://docs.qwairy.co/updates/version-1-19.md): Version 1.19 release notes on Source Authority, additional analytics providers, Crawler Analytics updates, and read-only MCP and AI Assistant workflows. - [Version 1.18](https://docs.qwairy.co/updates/version-1-18.md): AI Revenue and Action Center availability, Starter-plan MCP access, Measure tools, AI Crawler Readiness, and updated premium models in version 1.18. - [Version 1.17](https://docs.qwairy.co/updates/version-1-17.md): Agency plans, pitch audits, GEO Matrix v2, per-prompt monitoring frequency, Social Insights updates, and broader AI Assistant access in version 1.17. - [Version 1.16](https://docs.qwairy.co/updates/version-1-16.md): Version 1.16 reorganized the Cockpit into three summary and comparison views, plus navigation, influence analysis, and filters on Act pages. - [Version 1.15](https://docs.qwairy.co/updates/version-1-15.md): Version 1.15 introduced competitor comparison for 2 to 10 competitors, saved filters, GEO Matrix, the MCP Server, and asynchronous data exports. - [Version 1.14](https://docs.qwairy.co/updates/version-1-14.md): Version 1.14 adds Weekly Reports emailed each Monday, Shared Links, Looker Studio v2, and additional REST API endpoints that expand reporting options. - [Version 1.13](https://docs.qwairy.co/updates/version-1-13.md): Version 1.13 adds Brand Perception to compare how providers describe your brand, plus Local Intelligence and REST API v1 for location analysis and access. - [Version 1.12](https://docs.qwairy.co/updates/version-1-12.md): Version 1.12 adds Crawler Analytics, Referrer Analytics, and Site Diagnostics, bringing website-level evidence into your AI visibility monitoring. - [Version 1.11](https://docs.qwairy.co/updates/version-1-11.md): Version 1.11 adds ways to analyze observed social and shopping citations, backlink opportunities, and brand perception from monitored answers. - [Version 1.10](https://docs.qwairy.co/updates/version-1-10.md): Version 1.10 of Qwairy adds automatic competitor extraction from monitored answers, Looker Studio integration, sentiment analysis, and dark mode. - [Version 1.9](https://docs.qwairy.co/updates/version-1-9.md): Version 1.9 adds the Insights platform, Content Opportunities, and Content Studio, connecting monitoring data from shopping and search to content workflows. - [Version 1.8](https://docs.qwairy.co/updates/version-1-8.md): Version 1.8 brings more AI models at lower costs, detailed competitor page analysis, expanded language support, and week-over-week tracking in Qwairy. - [Version 1.5](https://docs.qwairy.co/updates/version-1-5.md): Version 1.5 adds insight, automation, and performance capabilities for monitored AI presence, including domain-level views and dedicated analysis pages. - [Version 1.4](https://docs.qwairy.co/updates/version-1-4.md): Version 1.4 introduced a broad interface redesign, with a revised presentation of AI responses, plus competitor intelligence and performance improvements. - [Version 1.3](https://docs.qwairy.co/updates/version-1-3.md): Version 1.3 adds new AI-powered strategic recommendations derived from monitored data, technical optimization tools, and analytics integrations. - [Version 1.2](https://docs.qwairy.co/updates/version-1-2.md): Version 1.2 brings a redesigned performance dashboard with new visualizations and metrics, flexible pricing, and the launch of the Qwairy GEO Guide. - [Version 1.1](https://docs.qwairy.co/updates/version-1-1.md): Version 1.1 of Qwairy adds German and Spanish response generation, AI Overview integration, self-service administration, and brand analysis updates. - [Version 1.0](https://docs.qwairy.co/updates/version-1-0.md): Version 1.0 launched Qwairy's custom LLM monitoring with model selection and flexible scheduling for each prompt, plus simplified credit management. ## Optional - [Blog](https://www.qwairy.co/blog) - [GEO Guide](https://www.qwairy.co/guides/complete-guide-to-generative-engine-optimization) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [English / Use cases (71 pages)](https://docs.qwairy.co/_llms/en/use-cases.txt): Documentation for English / Use cases. - [French (267 pages)](https://docs.qwairy.co/_llms/fr.txt): Documentation for French. - [French / Cas d’usage (71 pages)](https://docs.qwairy.co/_llms/fr/cas-d-usage.txt): Documentation for French / Cas d’usage. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.