Documentation Index
Fetch the complete documentation index at: https://dev.ranked.ai/llms.txt
Use this file to discover all available pages before exploring further.
ranked_get_keyword_rankings
Get keyword positions across all search channels with position changes.
Parameters
| Parameter | Type | Required | Description |
|---|
project_id | string | Yes | Project UUID |
limit | number | No | Max keywords to return (default: 50, max: 1000) |
date_range | string | No | Comparison period: 7d, 30d, 60d, 90d, 180d, 365d, all (default: 30d) |
Response fields
Each keyword includes:
| Field | Description |
|---|
desktopPosition | Current Google Desktop rank |
mobilePosition | Current Google Mobile rank |
aiModePosition | Current Google AI Mode rank |
mapsPosition | Current Google Maps rank |
desktopChange | Position change for the date range |
mobileChange | Position change for the date range |
aiModeChange | Position change for the date range |
mapsChange | Position change for the date range |
netChange | Sum of all channel changes (positive = improved) |
location | Target location name |
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
| Parameter | Type | Required | Description |
|---|
project_id | string | Yes | Project UUID |
limit | number | No | Max prompts to return (default: 20, max: 200) |
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
| Parameter | Type | Required | Description |
|---|
project_id | string | Yes | Project UUID |
limit | number | No | Max issues to return (default: 20, max: 50) |
severity | string | No | Filter: critical, warning, or notice |
ranked_get_backlink_summary
Get backlink profile overview.
Parameters
| Parameter | Type | Required | Description |
|---|
project_id | string | Yes | Project UUID |
limit | number | No | Max referring domains (default: 20, max: 50) |
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
| Parameter | Type | Required | Description |
|---|
project_id | string | Yes | Project UUID |
limit | number | No | Max items (default: 30, max: 50) |
status | string | No | Filter by status name (e.g., Approved, Published) |
