Documentation
Last updated
Everything RankVitals exposes to your own code and to your AI assistant. Four integrations, one credential.
API keys
Create a key under Dashboard → API & MCP. The same key authenticates the REST API and the MCP server, and every request it makes is scoped to the team the key belongs to. Keys can be read-only or have read and write access, and may have an optional expiry. Read-only keys can fetch results but cannot start tests or use mutating MCP tools. Revoking or expiring a key takes effect immediately.
What is documented here
- REST APIStart tests, poll results, list history and check credits over HTTP, with pagination, idempotency and the OpenAPI spec.
- MCP serverConnect Claude or any MCP client to your performance data, with the full tool list and what each one can touch.
- Command lineThe zero-dependency rankvitals CLI: run tests from a terminal, print JSON, and gate a build on a performance budget.
- WebhooksGet a POST when a test finishes instead of polling — payload shape, retry behaviour and how to verify it.
- CI integrationFail a build when performance regresses: a copy-pasteable GitHub Actions performance budget.
Credits and limits
Every test — started from the dashboard, the REST API or an MCP tool — spends one credit from your plan. Reads never cost a credit. Rate limits and the retry contract are on the REST API page; see pricing for the monthly allowance on each plan.