Skip to main content

Read tools

ranked_get_project_overview

List all your projects, or get detailed metrics for one project. Call this first — every other tool needs a project_id from it.

Parameters

Response includes

  • Without project_id: every accessible project with keyword, AI prompt, and audit issue counts
  • With project_id: average position, AI visibility, audit issue counts by severity, backlink totals, and content calendar counts

ranked_get_keyword_rankings

Get keyword positions across all search channels with position changes.

Parameters

Response fields

Each keyword includes:

Net change

A positive netChange means the keyword improved. It is the sum of position changes across all four channels for the selected date range.

ranked_get_ai_visibility

Get brand visibility across 6 AI models.

Parameters

Response includes

  • Overall visibility percentage and average position
  • Per-prompt breakdown with visibility change indicators
  • Per-model mention rates and average positions
  • AI search volume estimates per prompt
  • Per-model status (mentioned, position, citation count) from latest analysis

ranked_get_audit_summary

Get the latest audit results scoped to the most recent audit task.

Parameters


ranked_get_audit_details

Get the affected URLs for a specific audit issue. Use ranked_get_audit_summary first to get issue IDs.

Parameters


Get backlink profile overview.

Parameters

Response includes

  • Total backlinks and referring domains
  • DoFollow/NoFollow breakdown
  • New and lost backlinks in last 30 days
  • Top referring domains

ranked_get_content_calendar

Get content calendar items.

Parameters


ranked_get_heatmaps

Get local SEO heatmaps showing how the business ranks across a geographic grid in Google Maps.

Parameters


ranked_get_sitemap_indexing

Get sitemap URLs and their Google indexing status.

Parameters


ranked_get_search_console_metrics

Get Google Search Console traffic data. Requires the project to have Google Search Console connected. GSC keeps around 16 months of history, and the most recent 2-3 days can be partial while Google finalizes them.

Parameters

Response includes

  • Total impressions and clicks for the window (computed from daily property totals)
  • Average CTR and average position
  • Top queries with per-query impressions, clicks, CTR, and position
  • Daily impressions/clicks breakdown
For period comparisons (“this month vs last month”), call the tool twice with two exact windows and compare the results.

ranked_get_analytics_metrics

Get Google Analytics traffic data. Requires the project to have Google Analytics connected. GA aggregates in the property’s timezone, so today and yesterday can be partial.

Parameters

Response includes

  • Sessions, users, page views, and bounce rate for the window
  • Daily sessions/users breakdown
  • Channel breakdown (organic, direct, referral, …) with sessions, users, and new users

Write tools

ranked_add_keywords

Add keywords to track in Google search results. Duplicates are automatically skipped.

Parameters


ranked_remove_keywords

Remove tracked keywords by ID. Use ranked_get_keyword_rankings first to get keyword IDs.
This permanently deletes the keywords and their position history.

Parameters


ranked_add_prompts

Add prompts to track brand visibility across 6 AI models. Prompts should be natural questions someone would ask an AI assistant, without mentioning the brand name.

Parameters


ranked_request_topic

Submit a topic request for content generation. The topic is queued for article creation.

Parameters


ranked_approve_content

Approve a content item for publishing. Sets the status to Approved and adds it to the publishing queue. Use ranked_get_content_calendar first to get content IDs.

Parameters


ranked_request_revision

Request a revision on a content item. Sets the status to Revising and attaches the revision notes.

Parameters


ranked_generate_report

Generate a shareable SEO report link covering keywords, AI visibility, audits, backlinks, and analytics.

Parameters


ranked_run_audit

Start a technical SEO audit that crawls the project website for issues. Results are available via ranked_get_audit_summary once the crawl completes.

Parameters


ranked_update_content_preferences

Update the project’s content preferences (tone, style, topics, guidelines). This overwrites the existing content preferences text.

Parameters


ranked_update_publishing_preferences

Update the project’s publishing preferences (schedule, formatting, SEO guidelines). This overwrites the existing publishing preferences text.

Parameters