Use Ahrefs in Studio to retrieve domain and backlink metrics, organic keywords, top pages, and ranking data for SEO research and reports. The integration requires an Ahrefs Enterprise subscription with API access.
Integrate Ahrefs SEO tools into your workflow. Analyze domain ratings, backlinks, organic keywords, top pages, and more. Requires an Ahrefs Enterprise plan with API access.
Get the Domain Rating (DR) and Ahrefs Rank for a target domain. Domain Rating shows the strength of a website's backlink profile on a scale from 0 to 100.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain to analyze (e.g., example.com) |
date | string | No | Date for historical data in YYYY-MM-DD format (defaults to today) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
domainRating | number | Domain Rating score (0-100) |
ahrefsRank | number | Ahrefs Rank - global ranking based on backlink profile strength |
Get a one-call organic and paid search overview for a target domain or URL: organic traffic, organic keywords, paid traffic, paid keywords, and estimated traffic cost.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" |
country | string | No | Country code for traffic data. Example: "us", "gb", "de" |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match). Example: "domain" |
date | string | No | Date to report metrics on, in YYYY-MM-DD format (defaults to today) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
metrics | object | Organic and paid search overview |
↳ organicTraffic | number | Estimated monthly organic traffic |
↳ organicKeywords | number | Number of organic keywords ranked |
↳ organicKeywordsTop3 | number | Number of organic keywords ranking in positions 1-3 |
↳ organicCost | number | Estimated monthly cost to replicate organic traffic via ads (USD) |
↳ paidTraffic | number | Estimated monthly paid search traffic |
↳ paidKeywords | number | Number of paid keywords targeted |
↳ paidPages | number | Number of pages receiving paid traffic |
↳ paidCost | number | Estimated monthly paid search spend (USD) |
Get a list of backlinks pointing to a target domain or URL. Returns details about each backlink including source URL, anchor text, and domain rating.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match). Example: "domain" |
history | string | No | Historical scope: "live" (currently live backlinks), "all_time" (default, includes lost backlinks), or "since:YYYY-MM-DD" (backlinks found since a date). |
limit | number | No | Maximum number of results to return. Example: 50 (default: 1000) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
backlinks | array | List of backlinks pointing to the target |
↳ urlFrom | string | The URL of the page containing the backlink |
↳ urlTo | string | The URL being linked to |
↳ anchor | string | The anchor text of the link |
↳ domainRatingSource | number | Domain Rating of the linking domain |
↳ isDofollow | boolean | Whether the link is dofollow |
↳ firstSeen | string | When the backlink was first discovered |
↳ lastVisited | string | When the backlink was last checked |
Get backlink and referring domain totals for a target domain or URL, both currently live and across all time.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match). Example: "domain" |
date | string | No | Date to report metrics on, in YYYY-MM-DD format (defaults to today) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
stats | object | Backlink and referring domain totals |
↳ liveBacklinks | number | Number of currently live backlinks |
↳ liveReferringDomains | number | Number of currently live referring domains |
↳ allTimeBacklinks | number | Total backlinks ever discovered, including lost ones |
↳ allTimeReferringDomains | number | Total referring domains ever discovered, including lost ones |
Get a list of domains that link to a target domain or URL. Returns unique referring domains with their domain rating, backlink counts, and discovery dates.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match). Example: "domain" |
history | string | No | Historical scope: "live" (currently live), "all_time" (default, includes lost domains), or "since:YYYY-MM-DD" (domains found since a date). |
limit | number | No | Maximum number of results to return. Example: 50 (default: 1000) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
referringDomains | array | List of domains linking to the target |
↳ domain | string | The referring domain |
↳ domainRating | number | Domain Rating of the referring domain |
↳ backlinks | number | Total number of backlinks from this domain to the target |
↳ dofollowBacklinks | number | Number of dofollow backlinks from this domain |
↳ firstSeen | string | When the domain was first seen linking |
↳ lastVisited | string | When the domain was last seen linking (null if never re-crawled) |
Get a list of broken backlinks pointing to a target domain or URL. Useful for identifying link reclamation opportunities.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match). Example: "domain" |
limit | number | No | Maximum number of results to return. Example: 50 (default: 1000) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
brokenBacklinks | array | List of broken backlinks |
↳ urlFrom | string | The URL of the page containing the broken link |
↳ urlTo | string | The broken URL being linked to |
↳ httpCode | number | HTTP status code of the broken target URL (e.g., 404, 410) |
↳ anchor | string | The anchor text of the link |
↳ domainRatingSource | number | Domain Rating of the linking domain |
Get organic keywords that a target domain or URL ranks for in Google search results. Returns keyword details including search volume, ranking position, and estimated traffic.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
country | string | No | Country code for search results. Example: "us", "gb", "de" (default: "us") |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match). Example: "domain" |
date | string | No | Date to report metrics on, in YYYY-MM-DD format (defaults to today) |
limit | number | No | Maximum number of results to return. Example: 50 (default: 1000) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
keywords | array | List of organic keywords the target ranks for |
↳ keyword | string | The keyword |
↳ volume | number | Monthly search volume |
↳ position | number | Best ranking position for this keyword |
↳ url | string | The URL that ranks at the best position for this keyword |
↳ traffic | number | Estimated monthly organic traffic |
↳ keywordDifficulty | number | Keyword difficulty score (0-100) |
Get domains that compete with a target domain or URL for the same organic keywords, ranked by keyword overlap.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" |
country | string | No | Country code for search results. Example: "us", "gb", "de" (default: "us") |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match). Example: "domain" |
date | string | No | Date to report metrics on, in YYYY-MM-DD format (defaults to today) |
limit | number | No | Maximum number of results to return. Example: 50 (default: 1000) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
competitors | array | List of organic search competitors ranked by keyword overlap |
↳ domain | string | The competitor domain |
↳ domainRating | number | Domain Rating of the competitor |
↳ commonKeywords | number | Number of keywords the competitor and target both rank for |
↳ targetKeywords | number | Number of keywords the target ranks for |
↳ competitorKeywords | number | Number of keywords the competitor ranks for |
↳ traffic | number | Estimated monthly organic traffic for the competitor |
Get the top pages of a target domain sorted by organic traffic. Returns page URLs with their traffic, keyword counts, and estimated traffic value.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain to analyze. Example: "example.com" |
country | string | No | Country code for traffic data. Example: "us", "gb", "de" (default: "us") |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match). Example: "domain" |
date | string | No | Date to report metrics on, in YYYY-MM-DD format (defaults to today) |
limit | number | No | Maximum number of results to return. Example: 50 (default: 1000) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
pages | array | List of top pages by organic traffic |
↳ url | string | The page URL |
↳ traffic | number | Estimated monthly organic traffic |
↳ keywords | number | Number of keywords the page ranks for |
↳ topKeyword | string | The top keyword driving traffic to this page |
↳ value | number | Estimated traffic value in USD |
Get detailed metrics for a keyword including search volume, keyword difficulty, CPC, clicks, and traffic potential.
| Parameter | Type | Required | Description |
|---|
keyword | string | Yes | The keyword to analyze |
country | string | No | Country code for keyword data. Example: "us", "gb", "de" (default: "us") |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
overview | object | Keyword metrics overview |
↳ keyword | string | The analyzed keyword |
↳ searchVolume | number | Monthly search volume |
↳ keywordDifficulty | number | Keyword difficulty score (0-100) |
↳ cpc | number | Cost per click in USD |
↳ clicks | number | Estimated clicks per month |
↳ clicksPercentage | number | Percentage of searches that result in an organic click |
↳ parentTopic | string | The parent topic for this keyword |
↳ trafficPotential | number | Estimated traffic potential if ranking #1 |
↳ intents | object | Search intent flags (informational, navigational, commercial, transactional, branded, local) |
↳ informational | boolean | Query seeks information |
↳ navigational | boolean | Query seeks a specific site or page |
↳ commercial | boolean | Query researches a purchase decision |
↳ transactional | boolean | Query intends to complete a purchase |
↳ branded | boolean | Query references a specific brand |
↳ local | boolean | Query seeks local results |
Get a target domain's pages that receive paid search traffic, sorted by estimated paid traffic. Returns page URLs with their paid traffic, keyword counts, and estimated spend.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" |
country | string | No | Country code for traffic data. Example: "us", "gb", "de" (default: "us") |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match) |
date | string | No | Date to report metrics on, in YYYY-MM-DD format (defaults to today) |
limit | number | No | Maximum number of results to return. Example: 50 (default: 1000) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
paidPages | array | List of pages receiving paid search traffic |
↳ url | string | The page URL |
↳ traffic | number | Estimated monthly paid search traffic |
↳ keywords | number | Number of paid keywords the page ranks for |
↳ topKeyword | string | The top keyword driving paid traffic to this page |
↳ value | number | Estimated monthly paid traffic cost in USD |
↳ adsCount | number | Number of unique ads shown for this page |
Get the anchor text distribution for a target domain or URL's backlinks, showing how many links and referring domains use each anchor text.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match) |
history | string | No | Historical scope: "live" (currently live), "all_time" (default, includes lost backlinks), or "since:YYYY-MM-DD" (backlinks found since a date) |
limit | number | No | Maximum number of results to return. Example: 50 (default: 1000) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
anchors | array | Anchor text distribution for the backlink profile |
↳ anchor | string | The anchor text |
↳ backlinks | number | Total backlinks using this anchor text |
↳ dofollowBacklinks | number | Number of dofollow backlinks using this anchor text |
↳ referringDomains | number | Number of unique referring domains using this anchor text |
↳ firstSeen | string | When a link with this anchor was first found |
↳ lastSeen | string | When a backlink with this anchor was last seen (null if still live) |
Get keyword ideas related to a seed keyword: terms the same top-ranking pages also rank for ("also rank for") or also discuss ("also talk about"), with volume, difficulty, and CPC.
| Parameter | Type | Required | Description |
|---|
keyword | string | Yes | The seed keyword to find related terms for |
country | string | No | Country code for keyword data. Example: "us", "gb", "de" (default: "us") |
terms | string | No | Type of related keywords to return: "also_rank_for", "also_talk_about", or "all" (default: "all") |
viewFor | string | No | Whether to derive related terms from the top 10 or top 100 ranking pages (default: "top_10") |
limit | number | No | Maximum number of results to return. Example: 50 (default: 1000) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
relatedTerms | array | Related keyword ideas for the seed keyword |
↳ keyword | string | The related keyword |
↳ volume | number | Average monthly search volume |
↳ keywordDifficulty | number | Keyword difficulty score (0-100) |
↳ cpc | number | Cost per click in USD |
↳ parentTopic | string | The parent topic for this keyword |
↳ trafficPotential | number | Estimated traffic potential if ranking #1 |
↳ intents | object | Search intent flags (informational, navigational, commercial, transactional, branded, local) |
↳ serpFeatures | array | SERP features present in the results |
Get the historical Domain Rating (DR) trend for a target domain or URL over a date range, grouped daily, weekly, or monthly.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" |
dateFrom | string | Yes | Start date of the historical period, in YYYY-MM-DD format |
dateTo | string | No | End date of the historical period, in YYYY-MM-DD format (defaults to today) |
historyGrouping | string | No | Time interval for grouping data points: "daily", "weekly", or "monthly" (default: "monthly") |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
domainRatings | array | Historical Domain Rating data points |
↳ date | string | The date of the measurement |
↳ domainRating | number | Domain Rating score (0-100) on this date |
Get the historical organic and paid traffic trend for a target domain or URL over a date range: organic traffic/cost and paid traffic/cost at each point in time.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" |
dateFrom | string | Yes | Start date of the historical period, in YYYY-MM-DD format |
dateTo | string | No | End date of the historical period, in YYYY-MM-DD format (defaults to today) |
volumeMode | string | No | Search volume calculation: "monthly" or "average" (default: "monthly") |
historyGrouping | string | No | Time interval for grouping data points: "daily", "weekly", or "monthly" (default: "monthly") |
country | string | No | Country code for traffic data. Example: "us", "gb", "de" (default: "us") |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
metricsHistory | array | Historical organic and paid traffic data points |
↳ date | string | Date of the metric entry |
↳ organicTraffic | number | Estimated monthly organic visits |
↳ organicCost | number | Estimated monthly cost to replicate organic traffic via ads (USD) |
↳ paidTraffic | number | Estimated monthly paid search visits |
↳ paidCost | number | Estimated monthly paid search spend (USD) |
Get the historical referring domains trend for a target domain or URL over a date range, grouped daily, weekly, or monthly.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" |
dateFrom | string | Yes | Start date of the historical period, in YYYY-MM-DD format |
dateTo | string | No | End date of the historical period, in YYYY-MM-DD format (defaults to today) |
historyGrouping | string | No | Time interval for grouping data points: "daily", "weekly", or "monthly" (default: "monthly") |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
referringDomainsHistory | array | Historical referring domains count data points |
↳ date | string | The date of the data point |
↳ referringDomains | number | Total number of unique domains linking to the target on this date |
Get the historical organic keyword ranking distribution for a target domain or URL over a date range: how many keywords rank in each position bucket at each point in time.
| Parameter | Type | Required | Description |
|---|
target | string | Yes | The target domain or URL to analyze. Example: "example.com" |
dateFrom | string | Yes | Start date of the historical period, in YYYY-MM-DD format |
dateTo | string | No | End date of the historical period, in YYYY-MM-DD format (defaults to today) |
historyGrouping | string | No | Time interval for grouping data points: "daily", "weekly", or "monthly" (default: "monthly") |
country | string | No | Country code for search results. Example: "us", "gb", "de" (default: "us") |
mode | string | No | Analysis mode: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
keywordsHistory | array | Historical organic keyword ranking distribution |
↳ date | string | Date of the record |
↳ top3 | number | Keywords ranking in top 3 organic results |
↳ top4To10 | number | Keywords ranking in positions 4-10 |
↳ top11To20 | number | Keywords ranking in positions 11-20 |
↳ top21To50 | number | Keywords ranking in positions 21-50 |
↳ top51Plus | number | Keywords ranking in position 51 and beyond |
Get bulk SEO metrics (Domain Rating, backlinks, referring domains, organic traffic, and more) for multiple domains or URLs in a single request. Useful for comparing many competitors at once.
| Parameter | Type | Required | Description |
|---|
targets | string | Yes | Comma-separated list of domains or URLs to analyze. Example: "example.com,competitor.com" |
mode | string | No | Analysis mode applied to every target: domain (entire domain), prefix (URL prefix), subdomains (include all subdomains, default), exact (exact URL match) |
protocol | string | No | Protocol applied to every target: "both" (default), "http", or "https" |
country | string | No | Country code for traffic data. Example: "us", "gb", "de" (default: "us") |
volumeMode | string | No | Search volume calculation: "monthly" or "average" (default: "monthly") |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
results | array | Bulk metrics for each analyzed target, in submission order |
↳ url | string | The analyzed target URL or domain |
↳ index | number | Index of the target in the submitted list |
↳ domainRating | number | Domain Rating score (0-100) |
↳ ahrefsRank | number | Ahrefs Rank (global ranking) |
↳ backlinks | number | Total backlinks to the target |
↳ referringDomains | number | Unique domains linking to the target |
↳ organicTraffic | number | Estimated monthly organic traffic |
↳ organicKeywords | number | Number of organic keywords ranked (top 100) |
↳ paidTraffic | number | Estimated monthly paid search traffic |
↳ error | string | Error message if this target could not be analyzed |
Get crawled pages from an Ahrefs Site Audit project with health and SEO metrics: HTTP status, title, link counts, backlinks, indexability, and traffic. Optionally filter to pages affected by a specific issue.
| Parameter | Type | Required | Description |
|---|
projectId | number | Yes | The Site Audit project ID (found in the project URL in Ahrefs) |
date | string | No | Crawl date in YYYY-MM-DDThh:mm:ss format (defaults to the most recent crawl) |
limit | number | No | Maximum number of results to return. Example: 50 (default: 1000) |
offset | number | No | Number of results to skip, for pagination |
issueId | string | No | Only return pages affected by this issue ID |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
auditPages | array | List of crawled pages with health and SEO metrics |
↳ url | string | The crawled page URL |
↳ httpCode | number | HTTP status code returned by the URL |
↳ title | array | Page title tag(s) |
↳ internalLinks | number | Number of internal outgoing links |
↳ externalLinks | number | Number of external outgoing links |
↳ backlinks | number | Number of incoming external links to the page |
↳ compliant | boolean | Whether the page is indexable (200 status, no canonical/noindex) |
↳ traffic | number | Estimated monthly organic traffic to the page |
Get ranking overview metrics for the keywords tracked in an Ahrefs Rank Tracker project: position, search volume, keyword difficulty, and estimated traffic. This endpoint is free and does not consume API units.
| Parameter | Type | Required | Description |
|---|
projectId | number | Yes | The Rank Tracker project ID (found in the project URL in Ahrefs) |
date | string | Yes | Date to report rankings for, in YYYY-MM-DD format |
device | string | Yes | Rankings device type: "desktop" or "mobile" |
dateCompared | string | No | Comparison date in YYYY-MM-DD format, to compute position/traffic deltas |
volumeMode | string | No | Search volume calculation: "monthly" or "average" (default: "monthly") |
limit | number | No | Maximum number of results to return. Example: 50 (default: 1000) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
overviews | array | Ranking overview for each tracked keyword |
↳ keyword | string | The tracked keyword |
↳ position | number | Top organic search position |
↳ volume | number | Average monthly search volume |
↳ keywordDifficulty | number | Keyword difficulty score (0-100) |
↳ url | string | Top-ranking URL |
↳ traffic | number | Estimated monthly organic visits |
↳ serpFeatures | array | SERP features present in the results |
↳ bestPositionKind | string | Type of the top position (organic, paid, or SERP feature) |
Get the full SERP (search engine results page) for a keyword tracked in an Ahrefs Rank Tracker project, including every ranking URL with its position, title, and authority metrics. This endpoint is free and does not consume API units.
| Parameter | Type | Required | Description |
|---|
projectId | number | Yes | The Rank Tracker project ID (found in the project URL in Ahrefs) |
keyword | string | Yes | The tracked keyword to retrieve SERP data for |
country | string | Yes | Country code for the tracked keyword. Example: "us", "gb", "de" |
device | string | Yes | Rankings device type: "desktop" or "mobile" |
topPositions | number | No | Number of top organic positions to return (defaults to all available) |
date | string | No | Timestamp to return the last available SERP Overview at, in YYYY-MM-DDThh:mm:ss format |
locationId | number | No | Location ID of the tracked keyword, if tracked at a specific location |
languageCode | string | No | Language code of the tracked keyword |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
positions | array | Every ranking result on the SERP for the tracked keyword |
↳ position | number | Position of the result in the SERP |
↳ url | string | URL of the ranking page |
↳ title | string | Page title |
↳ type | array | The kind of the position: organic, paid, or a SERP feature |
↳ domainRating | number | Domain Rating of the ranking domain |
↳ urlRating | number | URL Rating of the ranking page |
↳ backlinks | number | Total backlinks to the ranking domain |
↳ refdomains | number | Unique referring domains |
↳ traffic | number | Estimated monthly organic search traffic |
↳ value | number | Estimated monthly traffic value (USD) |
↳ topKeyword | string | Highest-traffic keyword ranking for this page |
↳ topKeywordVolume | number | Monthly search volume for the top keyword |
↳ updateDate | string | Date the SERP was last checked |
Get competitor rankings for the keywords tracked in an Ahrefs Rank Tracker project: each tracked keyword's volume and difficulty alongside every competitor's position, traffic, and traffic value. This endpoint is free and does not consume API units.
| Parameter | Type | Required | Description |
|---|
projectId | number | Yes | The Rank Tracker project ID (found in the project URL in Ahrefs) |
date | string | Yes | Date to report rankings for, in YYYY-MM-DD format |
device | string | Yes | Rankings device type: "desktop" or "mobile" |
dateCompared | string | No | Comparison date in YYYY-MM-DD format, to compute position/traffic deltas |
volumeMode | string | No | Search volume calculation: "monthly" or "average" (default: "monthly") |
limit | number | No | Maximum number of results to return. Example: 50 (default: 1000) |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
competitorKeywords | array | Tracked keywords with competitor ranking data |
↳ keyword | string | The tracked keyword |
↳ volume | number | Average monthly search volume |
↳ keywordDifficulty | number | Keyword difficulty score (0-100) |
↳ serpFeatures | array | SERP features present in the results |
↳ competitorsList | array | Ranking data for each tracked competitor on this keyword |
↳ url | string | The competitor's ranking URL |
↳ position | number | Current ranking position |
↳ bestPositionKind | string | Type of the best position achieved |
↳ traffic | number | Estimated traffic to the competitor |
↳ value | number | Estimated traffic value (USD) |
Get aggregate competitor stats for an Ahrefs Rank Tracker project: each competitor's traffic, traffic value, average position, and share of voice across all tracked keywords. This endpoint is free and does not consume API units.
| Parameter | Type | Required | Description |
|---|
projectId | number | Yes | The Rank Tracker project ID (found in the project URL in Ahrefs) |
date | string | Yes | Date to report metrics for, in YYYY-MM-DD format |
device | string | Yes | Rankings device type: "desktop" or "mobile" |
volumeMode | string | No | Search volume calculation: "monthly" or "average" (default: "monthly") |
apiKey | string | Yes | Ahrefs API Key |
| Parameter | Type | Description |
|---|
competitorsStats | array | Aggregate stats for each tracked competitor |
↳ competitor | string | The competitor's URL |
↳ traffic | number | Estimated monthly organic visits |
↳ trafficValue | number | Estimated monthly organic traffic value (USD) |
↳ averagePosition | number | Average top organic position across tracked keywords |
↳ pos1To3 | number | Keywords ranking in top 3 positions |
↳ pos4To10 | number | Keywords ranking in positions 4-10 |
↳ shareOfVoice | number | Organic traffic share percentage |
↳ shareOfTrafficValue | number | Organic traffic value share percentage |