# RankDebug Documentation

> RankDebug publishes, schedules, and manages content across social networks from one place. Use the dashboard as a creator or a team; use the REST API, an SDK, or the MCP server if you are building something.

Append `.md` to any page URL for its Markdown source. The whole site as one file: https://rankdebug.com/docs/llms-full.txt

## Introduction

- [Getting Started](https://rankdebug.com/docs/getting-started.md): Add your website, connect Search Console, and see what RankDebug shows and when.
- [Findings Reference](https://rankdebug.com/docs/findings.md): Every finding the site check and the site crawl report, with its severity, what it means, why it matters and how to fix it.
- [RankDebug Documentation](https://rankdebug.com/docs/index.md): RankDebug finds why a website's search traffic changed and what to fix first, ranked by clicks at stake.
- [Security](https://rankdebug.com/docs/security.md): Read-only access to every source, encryption, workspace isolation, what is kept and for how long, and how to delete a workspace or an account.
- [RankDebugBot](https://rankdebug.com/docs/crawler.md): The crawler RankDebug uses to audit websites for their owners. How to recognise it, how it behaves, and how to allow or block it.
- [Events](https://rankdebug.com/docs/webhooks/events.md): The events a webhook can subscribe to, when they fire, and what their data contains.
- [Webhooks](https://rankdebug.com/docs/webhooks.md): Receive RankDebug events at your own HTTPS endpoint, signed so you can trust them.
- [Retries and Deliveries](https://rankdebug.com/docs/webhooks/retries.md): How failed deliveries are retried, when a webhook is paused, and how to inspect and replay deliveries.
- [Verification](https://rankdebug.com/docs/webhooks/verification.md): Check that a webhook delivery came from RankDebug and has not been replayed.

## API reference

- [API Keys and Scopes](https://rankdebug.com/docs/api/api-keys.md): Create API keys, limit them with scopes and a workspace binding, and keep them safe.
- [Deploys](https://rankdebug.com/docs/api/deploys.md): Record deploys from CI, list them, and read one deploy with its site check, crawl and search impact.
- [Digests](https://rankdebug.com/docs/api/digests.md): Read what the latest scheduled digest email for a workspace contained.
- [Overview](https://rankdebug.com/docs/api/overview.md): Base URL, authentication, scopes, errors and rate limits for the RankDebug API.
- [Reports](https://rankdebug.com/docs/api/reports.md): Read the reports shared with a workspace, their comment threads, and their PDF.
- [Search](https://rankdebug.com/docs/api/search.md): Search Console performance, top rows, opportunities and sitemaps for a workspace.
- [Site Crawls](https://rankdebug.com/docs/api/site-crawls.md): Read crawls of the workspace website, their findings, and every page of one finding.
- [Traffic](https://rankdebug.com/docs/api/traffic.md): Google Analytics landing pages, acquisition and measurement health, and CDN crawler traffic, error paths and firewall rules.
- [Webhooks](https://rankdebug.com/docs/api/webhooks.md): Create and manage webhook endpoints, send test events, and read and replay deliveries.
- [Workspaces](https://rankdebug.com/docs/api/workspaces.md): List, create, update and delete workspaces, and read a workspace's request logs and activity.

## Guide

- [Agent](https://rankdebug.com/docs/guide/agent.md): Ask questions about your site in plain language. What the agent can read, what it can do, and how it handles text from the web.
- [AI Readiness](https://rankdebug.com/docs/guide/ai-readiness.md): Whether AI crawlers can reach your site and read its content without running JavaScript.
- [Bing Webmaster Tools](https://rankdebug.com/docs/guide/bing.md): Connect Bing Webmaster Tools with an API key to add Bing search data and crawl statistics.
- [Cloudflare](https://rankdebug.com/docs/guide/cloudflare.md): Connect Cloudflare with a read-only API token to see which crawlers reach your site and what the edge did to them.
- [Connections](https://rankdebug.com/docs/guide/connections.md): How data sources connect to a workspace, how often they sync, and what happens when you disconnect one.
- [Deploys](https://rankdebug.com/docs/guide/deploys.md): Record each release from CI or a connected repository, and see what it changed on the site and in search.
- [GitHub](https://rankdebug.com/docs/guide/github.md): Connect a GitHub repository so production deploys are recorded on their own, with the SEO-relevant files each one changed.
- [GitLab](https://rankdebug.com/docs/guide/gitlab.md): Connect a GitLab project with a read-only token so production deploys are recorded on their own.
- [Google Analytics](https://rankdebug.com/docs/guide/google-analytics.md): Connect Google Analytics with read-only access to see what search visitors did after they landed.
- [Guide](https://rankdebug.com/docs/guide.md): How the parts of RankDebug fit together, and where to find each one in the dashboard.
- [Notifications and Webhooks](https://rankdebug.com/docs/guide/notifications.md): Choose what you hear about in the dashboard and by email, set your digest, and send events to your own systems.
- [Opportunities](https://rankdebug.com/docs/guide/opportunities.md): Where Search Console data says more clicks are available, ranked by clicks at stake.
- [Reports](https://rankdebug.com/docs/guide/reports.md): Read the reports our team writes for your site, comment on them, request new ones, and share them outside the workspace.
- [Search Console](https://rankdebug.com/docs/guide/search-console.md): Connect Google Search Console with read-only access. What RankDebug pulls and what it is used for.
- [Site Check](https://rankdebug.com/docs/guide/site-check.md): The daily check of robots.txt, sitemaps, hosts and your most important pages, and how it reports issues and regressions.
- [Site Crawl](https://rankdebug.com/docs/guide/site-crawl.md): The full crawl of your site, how it budgets and samples pages, how it reports a block, and how to give it access to staging.
- [Team, Roles and Workspaces](https://rankdebug.com/docs/guide/team.md): Invite your team, choose what each person can do, and decide which workspaces they see.
- [Web Vitals](https://rankdebug.com/docs/guide/web-vitals.md): Real-visitor loading, interaction and layout stability for your site, by device and by page type.