Documentation

Everything RankPulse can do, and how to build on it

A tour of the features you get in the app, followed by implementation guides for the REST API and the MCP server that connects AI assistants like Claude and ChatGPT.

Features

RankPulse tracks where your pages rank on Google, watches your competitors on the same searches, and turns that history into traffic and visibility trends.

Rank tracking

  • Create a project per website (name + root domain), then add keywords one at a time, in bulk, or by CSV import.
  • Each keyword tracks a country, device (desktop/mobile), and optional city-level location, plus tags for grouping.
  • The table shows current rank, change since the last check, best-ever position, a 30-day trend sparkline, and search-intent badges.
  • Check keywords on demand or let the daily schedule run automatically — checks queue in the background and results stream in.
  • Add competitor domains once and their positions are captured from the same search results at no extra cost.

Local (Google Maps) tracking

  • Add your business as a target by searching Google Places or entering its Place ID manually.
  • Track how your business ranks in the local map pack for your keywords around that location.
  • Duplicate business names or Place IDs are blocked so you never track the same listing twice.

AI Overview & prompts

  • See when Google's AI Overview appears for your keywords and whether your site is cited in it.
  • Track the 30-day AI Overview trend and which competitors are being cited instead.
  • Harvest Google's People Also Ask questions into a prompt bank; star, archive, or promote them to tracked keywords.
  • Group keywords into semantic clusters, with AI-suggested clusters you review before applying.

Search Console analytics

  • Connect your own Google account per project and pick the verified Search Console property.
  • See clicks, impressions, CTR and average position for the last 28 days, with trend charts.
  • Top pages and top queries reveal search terms you may not be tracking yet — import them in one click.

Share & reports

  • Turn on a public share link to give clients a read-only dashboard — no login needed.
  • Add weekly email recipients; each gets a branded report with a keyword CSV attached.
  • Export keywords or full rank history as CSV at any time.
  • Table Settings lets you choose which columns appear on screen and in reports.

Team members

  • Invite people by email as Viewers (read-only) or Editors from Account settings → Team.
  • Share every project or only the ones you pick.
  • Invitees receive an emailed join link and set their own password.
  • All rank checks spend the project owner's credits, so billing stays in one place.

REST API

The REST API lets your own scripts and dashboards read your projects, keywords, rank history and competitors — and add keywords — over plain HTTPS. It only ever returns data your account can already see in the app.

1. Create an API key

  1. Open Account settings → API.
  2. Give the key a name you'll recognise later, such as “Reporting script”.
  3. Press Create key and copy it straight away — it is only shown once.

Keys start with rp_live_. You can hold up to 10 keys at a time, and revoking one stops it working immediately. Treat a key like a password: never put it in browser code, a public website or a shared document.

2. Call the API

Send your key on every request as a bearer token (the x-api-key header works too):

curl https://rank-pulse.com/api/public/v1/projects \
  -H "Authorization: Bearer rp_live_…"
MethodPathWhat it returns
GET/api/public/v1/meThe account the key belongs to.
GET/api/public/v1/projectsEvery project you own or that is shared with you.
GET/api/public/v1/projects/{projectId}Keyword count, how many rank, top-10 count, average position.
GET/api/public/v1/projects/{projectId}/keywordsKeywords with latest position and last-check time.
POST/api/public/v1/projects/{projectId}/keywordsAdd a keyword. Body: { keyword, country?, device?, location? }
GET/api/public/v1/projects/{projectId}/competitorsCompetitor domains tracked on the project.
GET/api/public/v1/keywords/{keywordId}/ranks?limit=50Rank history for one keyword, newest first (limit 1–200).

Adding a keyword

curl -X POST https://rank-pulse.com/api/public/v1/projects/{projectId}/keywords \
  -H "Authorization: Bearer rp_live_…" \
  -H "Content-Type: application/json" \
  -d '{"keyword":"moving company kelowna","country":"ca","device":"desktop"}'

3. Errors

Errors come back as { "error": "…" } with one of these codes:

  • 400 — something in your request was missing or invalid.
  • 401 — the key is missing, mistyped or revoked.
  • 403 — the key is valid but that project isn't yours.
  • 404 — no such project or keyword.

Team access applies exactly as in the app: shared projects are included, and viewers can read but not add keywords. Rank checks triggered through the API use the same credits as the app.

MCP (AI assistants)

MCP is the open standard AI assistants use to connect to tools. RankPulse ships a built-in MCP server that works with Claude, ChatGPT, Cursor and similar assistants. There's no API key: you sign in to RankPulse and approve the assistant once, and it then works as you.

1. Connect your assistant

MCP server address

https://rank-pulse.com/mcp
  1. In your assistant, add a new connector / custom integration.
  2. Paste the address above.
  3. A RankPulse page opens — sign in if you aren't already.
  4. Review what the assistant is asking for and press Approve.

2. Available tools

  • list_projects

    Every project you can see.

  • get_project

    Summary stats for one project.

  • list_keywords

    Keywords and their latest positions.

  • get_keyword_ranks

    Position history for one keyword.

  • list_competitors

    Competitor domains on a project.

  • add_keyword

    Add a keyword to a project.

Try asking your assistant: “Which keywords in my example.com project dropped this month?” or “Add ‘emergency plumber kelowna’ to my plumbing project.” Removing the connection cuts the assistant's access instantly.