Documentation
Ranksify docs
Setup, integrations, the product surfaces, and the API. Every page here describes behaviour that is shipped — if something is not documented, it is not built yet.
Getting started
- QuickstartThe six-step onboarding wizard, and what each step actually writes into your workspace.
- Add your siteCreate a brand, set its domain, aliases and geography, and understand what Ranksify matches on.
- Tracking promptsPrompt states, sampling policies, topics, and how activation consumes your plan quota.
Integrations
- Google Search ConsoleConnect Search Console over OAuth, pick a property, and read the numbers honestly.
- Google Analytics 4Connect GA4, pick a property, and read the GA4-specific metric labels Ranksify uses.
- Bing Webmaster ToolsConnect Bing by Microsoft sign-in or by API key, and pick a verified site.
- Visitor tag and crawler trackingInstall the visitor tag for AI-referred people, and connect server or edge logs for crawler bots.
Product
- AI AgentAsk questions about your own data. What the agent can read, what it can propose, and the tool ledger.
- Insights and filtersThe shared filter bar, the eight insight views, and why filter state rides the URL.
- AlertsThe alert feed, the change events behind it, and where those events go next.
- Knowledge baseBrand profile, aliases, tone, entities, documents and topics — the context the models get.
API & automation
- API keysMint rk_ keys, choose scopes, and understand per-key rate limits.
- WebhooksSubscribe to change events and verify the HMAC signature on every delivery.
- MCP serverPoint Claude, Cursor or any MCP client at your workspace metrics over Streamable HTTP.
- API referenceEndpoint-by-endpoint reference for the public REST API.
- TypeScript SDKThe typed, zero-dependency client for the REST API — one method per endpoint, typed errors, bounded retries.
- Bot registryThe public, versioned list of AI crawlers we classify against, served as JSON.
- Events & ingest referenceWire contracts for the beacon snippet, the beacon endpoint, and token-authed log ingest.
- Middleware packageInstall the zero-dependency package that reports AI crawler hits from your own server.