# Perquery

## Guides

### Get started

- [Introduction](https://docs.perquery.ai/en/introduction.md): What Perquery is and which areas of the product you use to measure and improve your brand in AI answers.
- [Quickstart](https://docs.perquery.ai/en/quickstart.md): Create a Perquery account, answer the onboarding questions, select a plan, set up your first site and read the first results.
- [Concepts](https://docs.perquery.ai/en/concepts.md): The main objects of Perquery (sites, prompts, personas, competitors, scans) and how Perquery calculates its metrics.
- [AI engines](https://docs.perquery.ai/en/ai-engines.md): Which AI engines Perquery measures, how you select them for a site and how you filter the results by engine.
- [Glossary](https://docs.perquery.ai/en/glossary.md): The terms that the Perquery documentation uses, with the exact product label in English and Turkish.

### Set up a site

- [Add a site](https://docs.perquery.ai/en/sites/add-a-site.md): Add a brand and its website to Perquery and complete the site setup.
- [Site settings](https://docs.perquery.ai/en/sites/site-settings.md): Open, configure, archive, restore and delete the sites of your organization.
- [Scans and schedule](https://docs.perquery.ai/en/sites/scans-and-schedule.md): Learn when Perquery scans a site, how to set the schedule and how to read the status of a scan.

### Monitor

- [Performance Overview](https://docs.perquery.ai/en/monitor/dashboard.md): Read the headline metrics, trends, engine breakdown and persona results of your site.
- [Prompts](https://docs.perquery.ai/en/monitor/prompts.md): Add, import, edit and delete the prompts that Perquery asks AI engines, and read their results.
- [Prompt groups](https://docs.perquery.ai/en/monitor/prompt-groups.md): Sort your prompts into tracking groups and compare the performance of each group.
- [Personas](https://docs.perquery.ai/en/monitor/personas.md): Add personas to measure how AI engines answer different types of buyers, and compare the results.
- [Competitor analysis](https://docs.perquery.ai/en/monitor/competitors.md): Compare your brand with your competitors in AI answers, and add, import or remove the competitors that you track.
- [LLM Inspect](https://docs.perquery.ai/en/monitor/llm-inspect.md): See how one AI bot reads one page of your site: the screenshot it would render and the response body it receives.
- [Search Performance](https://docs.perquery.ai/en/monitor/search-performance.md): Compare your AI visibility with your Google organic rank, your AI referral traffic and your Google Ads spend.
- [Reporting](https://docs.perquery.ai/en/monitor/reporting.md): Build a custom report for a site from data blocks, ask the AI assistant about your data and download the report as a PDF.

### Analyze

- [Content analysis](https://docs.perquery.ai/en/analyze/content-analysis.md): Find the prompts that no page on your site answers, the pages that answer them weakly, and the pages that need work.
- [Technical analysis](https://docs.perquery.ai/en/analyze/technical-analysis.md): Audit how well AI crawlers can reach, render and read your site, and fix each issue from its row.
- [Domain rating](https://docs.perquery.ai/en/analyze/authority.md): See the sources that AI engines cite next to your brand, their domain rating, and the sources that cite a competitor instead.
- [LLM bot logs](https://docs.perquery.ai/en/analyze/bot-logs.md): Upload the access log of your web server to see which AI crawlers visit your site, what they fetch and what your server answers.

### Act

- [Growth opportunities](https://docs.perquery.ai/en/act/opportunities.md): See every open opportunity of your site ranked by its score, open it in the tool that fixes it, and record the fix.
- [Impact tracking](https://docs.perquery.ai/en/act/impact-tracking.md): Record the changes that you make to your site and compare your AI visibility before and after each one.

### Tools

- [Tools overview](https://docs.perquery.ai/en/tools/overview.md): The Perquery tools that turn findings into files, tags and plans that you put on your site.
- [Content Brief Generator](https://docs.perquery.ai/en/tools/content-brief.md): Plan a page before you write it: the headline, the outline, the questions, the keywords and the length.
- [Content Generator](https://docs.perquery.ai/en/tools/content-generator.md): The status of the Content Generator, which is not available yet.
- [llms.txt Checker & Generator](https://docs.perquery.ai/en/tools/llms-txt.md): Check the llms.txt file on your domain and generate a new one from the pages that Perquery crawled.
- [Meta Tag Generator](https://docs.perquery.ai/en/tools/meta-tags.md): Generate title tags and meta descriptions for the pages that you select.
- [robots.txt Checker & Generator](https://docs.perquery.ai/en/tools/robots-txt.md): See which AI bots your robots.txt lets in, and generate a corrected robots.txt file.
- [Schema Generator](https://docs.perquery.ai/en/tools/schema.md): Generate JSON-LD structured data for the pages that you select, from the content of each page.

### Integrations

- [Integrations overview](https://docs.perquery.ai/en/integrations/overview.md): Connect Google Search Console, Google Analytics 4 and Google Ads to a site and manage the connections.
- [Google Search Console](https://docs.perquery.ai/en/integrations/google-search-console.md): Connect Google Search Console to compare your AI visibility with the search queries that your website ranks for.
- [Google Analytics 4](https://docs.perquery.ai/en/integrations/google-analytics.md): Connect Google Analytics 4 to see the traffic that AI assistants send to your website and how it converts.
- [Google Ads](https://docs.perquery.ai/en/integrations/google-ads.md): Connect Google Ads to compare what you pay for search keywords with your AI visibility for the same topics.

### Account and team

- [Profile and security](https://docs.perquery.ai/en/account/profile-and-security.md): Sign in, change your name and password, end sessions and set up two-step sign-in.
- [Organization and team](https://docs.perquery.ai/en/account/organization-and-team.md): Invite people to your organization, manage their roles, and suspend or remove members.
- [Roles and permissions](https://docs.perquery.ai/en/account/roles-and-permissions.md): How roles control what each member can do, and how to create, edit and delete roles.
- [Billing and plans](https://docs.perquery.ai/en/account/billing-and-plans.md): Subscribe to a plan, switch or cancel it, keep your billing profile and download invoices.
- [Add-ons](https://docs.perquery.ai/en/account/add-ons.md): What add-ons are, which add-on unlocks API keys, and how to get or drop an add-on.
- [API keys](https://docs.perquery.ai/en/account/api-keys.md): Create, copy, rename and revoke the read-only API keys of your organization.

## AI assistants

### AI assistants

- [Connect the docs to your AI assistant](https://docs.perquery.ai/en/ai/mcp.md): Add the read-only MCP server of the Perquery documentation to Claude, Cursor, VS Code and other MCP clients.
- [llms.txt and Markdown pages](https://docs.perquery.ai/en/ai/llms-txt-and-markdown.md): Give the Perquery documentation to an AI tool as llms.txt, as one full text file or as the Markdown version of a page.

## API reference

### API

- [API introduction](https://docs.perquery.ai/en/api/introduction.md): Read the data of your Perquery organization from your own code with the read-only Perquery API.
- [Authentication](https://docs.perquery.ai/en/api/authentication.md): Send your Perquery API key in the Authorization header of each request.
- [Errors and limits](https://docs.perquery.ai/en/api/errors-and-limits.md): Read the error responses, the rate limit and the pagination of the Perquery API.

### Endpoints

#### Sites

- [List sites](https://docs.perquery.ai/api-reference/sites/list-sites.md): Returns the sites of the organization.
- [Get a site](https://docs.perquery.ai/api-reference/sites/get-a-site.md): Returns one site: its name, domain, category, country, language, tracked AI assistants and run schedule.

#### Authority

- [Get the authority summary](https://docs.perquery.ai/api-reference/authority/get-the-authority-summary.md): Returns the authority score of the site, its change and trend, and the counts of citations and sources. Use `at` (a date and time) to read the summary of an earlier moment.
- [List backlink gaps](https://docs.perquery.ai/api-reference/authority/list-backlink-gaps.md): Returns the sites that link to a competitor and not to the brand. The list is paged with `page` and `page_size`.
- [List citation gaps](https://docs.perquery.ai/api-reference/authority/list-citation-gaps.md): Returns the sources that AI assistants cite for a competitor and not for the brand. Use `at` to read an earlier moment. The list is paged with `page` and `page_size`.
- [List citation sources](https://docs.perquery.ai/api-reference/authority/list-citation-sources.md): Returns the sources that AI assistants cite for the brand. Use `order` (`citations` or `rating`) to sort the list and `at` to read an earlier moment. The list is paged with `page` and `page_size`.

#### Bot logs

- [Get the bot log report](https://docs.perquery.ai/api-reference/bot-logs/get-the-bot-log-report.md): Returns the AI bot traffic of the site from the uploaded server logs: an overview, a trend, the visit purposes and the response statuses. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `compare` to select the comparison period (`previou…
- [List bot log pages](https://docs.perquery.ai/api-reference/bot-logs/list-bot-log-pages.md): Returns the paths of the site that AI bots requested in the period, with the request counts and status codes. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). The list is paged with `page` and `page_size`.
- [List log uploads](https://docs.perquery.ai/api-reference/bot-logs/list-log-uploads.md): Returns the server log files that were uploaded for the site, with the state of each upload.

#### Competitors

- [List competitors](https://docs.perquery.ai/api-reference/competitors/list-competitors.md): Returns the competitors that the site tracks.
- [Get the competitor analysis](https://docs.perquery.ai/api-reference/competitors/get-the-competitor-analysis.md): Returns the share of voice of the brand and its competitors, the trends, and the prompts where a competitor is ahead. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `compare` to select the comparison period (`previous`, `previous_year`…
- [List competitor domain ratings](https://docs.perquery.ai/api-reference/competitors/list-competitor-domain-ratings.md): Returns the domain rating of each tracked competitor. A rating can still be pending.

#### Content analysis

- [Get the latest crawl](https://docs.perquery.ai/api-reference/content-analysis/get-the-latest-crawl.md): Returns the latest content crawl of the site and its state.
- [Get the format distribution](https://docs.perquery.ai/api-reference/content-analysis/get-the-format-distribution.md): Returns the content formats of the crawled pages and their shares. The response shows if the share of the preferred formats is below the recommended minimum.
- [List prompt matches](https://docs.perquery.ai/api-reference/content-analysis/list-prompt-matches.md): Returns the best page of the site for each tracked prompt, with the match quality. The list is paged with `page` and `page_size`.
- [List page readiness](https://docs.perquery.ai/api-reference/content-analysis/list-page-readiness.md): Returns the crawled pages with their readiness for citation by AI assistants, least ready first. The list is paged with `page` and `page_size`.
- [List crawled pages](https://docs.perquery.ai/api-reference/content-analysis/list-crawled-pages.md): Returns the pages that the content crawl found. Use `search` to filter by URL or title. The list is paged with `page` and `page_size`.
- [Get the content summary](https://docs.perquery.ai/api-reference/content-analysis/get-the-content-summary.md): Returns the content analysis summary: crawled pages, tracked and analysed prompts, content gaps, weak matches and the last run dates.

#### Impact

- [List impact results](https://docs.perquery.ai/api-reference/impact/list-impact-results.md): Returns the fixes that were recorded for the site, with the measured outcome of each and a summary. Use `status` and `type` to filter the list. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `persona` and `llm` to limit the data to one…

#### Integrations

- [List integrations](https://docs.perquery.ai/api-reference/integrations/list-integrations.md): Returns the integrations of the site and the state of each connection.
- [List integration properties](https://docs.perquery.ai/api-reference/integrations/list-integration-properties.md): Returns the properties (for example Search Console sites or Analytics properties) that the connected account of one integration can access.
- [List sync history](https://docs.perquery.ai/api-reference/integrations/list-sync-history.md): Returns the recent data syncs of one integration, with the state of each.

#### Opportunities

- [List opportunities](https://docs.perquery.ai/api-reference/opportunities/list-opportunities.md): Returns the opportunities of the site with their score, effort and priority tier. Use `type`, `tier`, `subject_kind`, `subject_ref` and `q` to filter, and `sort` and `direction` to order. Set `include_dismissed` to also get dismissed opportunities. Use `date_range` to select the period (`7g`, `1a`,…
- [Get the opportunity matrix](https://docs.perquery.ai/api-reference/opportunities/get-the-opportunity-matrix.md): Returns the top opportunities for the priority matrix and the count of opportunities that the matrix does not show. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `llm` to limit the data to some AI assistants.
- [List top opportunities](https://docs.perquery.ai/api-reference/opportunities/list-top-opportunities.md): Returns the opportunities with the highest score. Use `limit` to set the number of rows. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `llm` to limit the data to some AI assistants.

#### Visibility

- [Get the site overview](https://docs.perquery.ai/api-reference/visibility/get-the-site-overview.md): Returns the main visibility metrics of the site: visibility, share of voice, rank, sentiment and authority, with a trend and the result of each AI assistant. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `compare` to select the compari…
- [Get the metrics version](https://docs.perquery.ai/api-reference/visibility/get-the-metrics-version.md): Returns a version tag that changes when a finished run changes the metrics of the site. Use it to know when to read the metrics again.
- [List runs](https://docs.perquery.ai/api-reference/visibility/list-runs.md): Returns the recent measurement runs of the site, newest first. Use `limit` to set the number of runs.
- [Estimate a run](https://docs.perquery.ai/api-reference/visibility/estimate-a-run.md): Returns the size of a new measurement run of the site: the prompts, personas and AI assistants that it would include.
- [Get a run](https://docs.perquery.ai/api-reference/visibility/get-a-run.md): Returns one measurement run: its state, counts and failures.
- [List run answers](https://docs.perquery.ai/api-reference/visibility/list-run-answers.md): Returns the answer of each AI assistant in one measurement run, with the prompt, the persona and the result.

#### Personas

- [List personas](https://docs.perquery.ai/api-reference/personas/list-personas.md): Returns the personas of the site.
- [Get the persona board](https://docs.perquery.ai/api-reference/personas/get-the-persona-board.md): Returns the visibility of the brand for each persona and AI assistant. Use `kind` to filter the personas and set `include_raw` to also get the results without a persona. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `llm` to limit the…
- [List persona signals](https://docs.perquery.ai/api-reference/personas/list-persona-signals.md): Returns the notable differences in visibility between the personas of the site. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `llm` to limit the data to some AI assistants.

#### Prompts

- [Get prompt group performance](https://docs.perquery.ai/api-reference/prompts/get-prompt-group-performance.md): Returns the average visibility, rank, sentiment, opportunity and search volume of each prompt group. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `persona` and `llm` to limit the data to one persona and to some AI assistants.
- [List prompts](https://docs.perquery.ai/api-reference/prompts/list-prompts.md): Returns the tracked prompts of the site with their metrics. Use `q`, `tracking_group`, `ungrouped`, `sentiment`, `target` and `opportunity` to filter, and `sort` and `direction` to order. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `…
- [Get a prompt](https://docs.perquery.ai/api-reference/prompts/get-a-prompt.md): Returns one prompt with its labels, metrics, the result of each persona and AI assistant, and the page that answers it best. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `persona` and `llm` to limit the data to one persona and to some…
- [List prompt groups](https://docs.perquery.ai/api-reference/prompts/list-prompt-groups.md): Returns the prompt groups of the site.

#### Search performance

- [List ad terms](https://docs.perquery.ai/api-reference/search-performance/list-ad-terms.md): Returns the paid search terms of the site with their spend, clicks and visibility in AI answers. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). The list is paged with `page` and `page_size`.
- [List search queries](https://docs.perquery.ai/api-reference/search-performance/list-search-queries.md): Returns the organic search queries of the site and the tracked prompts that match them. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). The list is paged with `page` and `page_size`.
- [Get the referral report](https://docs.perquery.ai/api-reference/search-performance/get-the-referral-report.md): Returns the sessions of the site by source (AI assistants, organic search and paid search) and the conversions. Use `date_range` to select the period (`7g`, `1a`, `3a`, `6a`, `1y` or `custom` with `since` and `until`). Use `compare` to select the comparison period (`previous`, `previous_year` or `cu…

#### Technical analysis

- [Get the latest audit](https://docs.perquery.ai/api-reference/technical-analysis/get-the-latest-audit.md): Returns the latest technical audit of the site, with its score and state.
- [List bot access](https://docs.perquery.ai/api-reference/technical-analysis/list-bot-access.md): Returns each AI bot and whether it can access the site.
- [Get the crawl budget](https://docs.perquery.ai/api-reference/technical-analysis/get-the-crawl-budget.md): Returns the requests, reached pages and errors of each AI bot from the uploaded server logs.
- [List audit findings](https://docs.perquery.ai/api-reference/technical-analysis/list-audit-findings.md): Returns the findings of the latest technical audit. The list is paged with `page` and `page_size`.
- [Get the score history](https://docs.perquery.ai/api-reference/technical-analysis/get-the-score-history.md): Returns the score of each finished technical audit of the site.
- [List page inspections](https://docs.perquery.ai/api-reference/technical-analysis/list-page-inspections.md): Returns the page inspections of the site. Use `url` and `bot` to filter the list. The list is paged with `page` and `page_size`.
- [Get a page inspection](https://docs.perquery.ai/api-reference/technical-analysis/get-a-page-inspection.md): Returns one page inspection: what an AI bot gets when it requests the page.
- [Get an inspection screenshot](https://docs.perquery.ai/api-reference/technical-analysis/get-an-inspection-screenshot.md): Returns the screenshot of one page inspection as a PNG image.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Turkish (93 pages)](https://docs.perquery.ai/_llms/tr.txt): Documentation for Turkish.


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