Semrush API v3 and v4 comparison reference

This reference maps Semrush API Version 3 (v3) endpoints to Version 4 (v4) endpoints.

Most Version 3 reports share endpoints and use the type query parameter to select a report. Their entries include the endpoint and type value. In Version 4, the endpoint URL identifies the operation.

Jump to Method mappingMethod mapping

  • Coming soon in v4: A v4 equivalent is planned. Descriptions for these rows refer to planned functionality.
  • Not covered by v4: No v4 equivalent is planned. Contact Support to discuss alternatives.

Jump to BacklinksBacklinks

v3 endpoint
v4 endpoint
What v4 provides
Summary of a target’s link profile: backlinks, referring domains and IPs, follow/nofollow split, new and lost links, Authority Score
Backlinks pointing to a target, with source page, anchor, link attributes and first/last seen dates
Domains linking to a target, with backlink counts, Authority Score and country
IP addresses hosting linking pages, with backlink and domain counts
Referring domains and backlink counts. TLD distributions aren’t pre-aggregated
Referring domains, country codes and backlink counts. Country distributions aren’t pre-aggregated
Anchor texts used in links to a target, with backlink and domain counts
A target’s pages that receive backlinks, with backlink and referring domain counts per page
Domains with similar backlink profiles, based on shared referring domains
Referring domains and backlink counts across up to six targets, showing shared links and backlink gaps
Side-by-side link profile metrics for up to 10 targets
Distribution of referring domains by Authority Score (0–100)
Coming soon in v4.
—
Coming soon in v4.
—
Monthly history of Authority Score, backlinks and referring domains

Jump to Keyword reportsKeyword reports

v3 endpoint
v4 endpoint
What v4 provides
Search volume, keyword difficulty, search intent, CPC, competitive density, number of results, 12-month trend and SERP features for a keyword in a country
Search volume, keyword difficulty, search intent, CPC, competitive density, number of results, 12-month trend and SERP features for a keyword in a country
Search volume, keyword difficulty, search intent, CPC, competitive density, number of results, 12-month trend and SERP features for a keyword in a country
Organic search results for a keyword, with ranking domains, URLs, positions, SERP features and estimated traffic
Search ads shown for a keyword, with advertisers, ad copy, landing URLs and ad placements
Keywords semantically related to the seed keyword, with their core metrics
Advertisers and their best ad positions and copy for a keyword in one month per request
Keyword variations that contain the seed keyword, with their core metrics
Question keywords and their core metrics. Set is_question=true
Search volume, keyword difficulty, search intent, CPC, competitive density, number of results, 12-month trend and SERP features for a keyword in a country

Jump to Overview reportsOverview reports

v3 endpoint
v4 endpoint
What v4 provides
Organic and paid search metrics for a target in one country and device database per request
Organic and paid search metrics for a target in one country and device database per request
Monthly history of organic and paid search keywords, traffic and traffic cost
Changes in organic and paid keywords, traffic and traffic cost for domains in the selected database
Domains ranked by organic search traffic, with organic and paid search metrics for the selected month

Jump to Domain reportsDomain reports

v3 endpoint
v4 endpoint
What v4 provides
Keywords a target ranks for, with positions, search volume, ranking URLs and estimated traffic
Keywords a target advertises on, with ad positions, copy, search volume and estimated traffic
Search ads shown for a target, with ad copy, landing URLs and keyword-position counts
Organic search competitors, with shared keyword counts, competition level and estimated traffic
Paid search competitors, with shared keyword counts, competition level and estimated traffic
Keywords advertised over 12 months, with monthly best positions. Monthly keyword requests provide the ad copy for each month
Shared, missing and unique keywords for two targets, with keyword metrics and positions
Keywords that trigger a target’s Shopping ads, with positions, product titles, prices and shop names
Shopping ads shown for a target, with product titles, prices, landing URLs and keyword-position counts
Shopping ad competitors, with shared keyword counts and competition level
A target’s ranking pages, with keyword counts, estimated traffic and search-intent breakdowns
A domain’s subdomains in organic search, with keyword counts and estimated traffic

Jump to Subdomain reportsSubdomain reports

v3 endpoint
v4 endpoint
What v4 provides
Organic and paid search metrics for a target in one country and device database per request
Organic and paid search metrics for a target in one country and device database per request
Monthly history of organic and paid search keywords, traffic and traffic cost
Keywords a target ranks for, with positions, search volume, ranking URLs and estimated traffic
Keywords a target advertises on, with ad positions, copy, search volume and estimated traffic
A target’s ranking pages, with keyword counts, estimated traffic and search-intent breakdowns
Search ads shown for a target, with ad copy, landing URLs and keyword-position counts

Jump to Subfolder reportsSubfolder reports

v3 endpoint
v4 endpoint
What v4 provides
Organic and paid search metrics for a target in one country and device database per request
Monthly history of organic and paid search keywords, traffic and traffic cost
Organic and paid search metrics for a target in one country and device database per request
Keywords a target ranks for, with positions, search volume, ranking URLs and estimated traffic
Keywords a target advertises on, with ad positions, copy, search volume and estimated traffic
A target’s ranking pages, with keyword counts, estimated traffic and search-intent breakdowns
Search ads shown for a target, with ad copy, landing URLs and keyword-position counts

Jump to URL reportsURL reports

v3 endpoint
v4 endpoint
What v4 provides
Organic and paid search metrics for a target in one country and device database per request
Monthly history of organic and paid search keywords, traffic and traffic cost
Organic and paid search metrics for a target in one country and device database per request
Keywords a target ranks for, with positions, search volume, ranking URLs and estimated traffic
Keywords a target advertises on, with ad positions, copy, search volume and estimated traffic

Jump to Project managementProject management

v3 endpoint
v4 endpoint
What v4 provides
Projects you can access, with their names, domains, owners and permissions
Project details, including its name, domain, owner, permissions and enabled tools
Creates a project and returns its details and assigned ID
Renames a project and returns its updated details
Deletes a project and its associated data, and returns the project ID

Jump to Position TrackingPosition Tracking

v3 endpoint
v4 endpoint
What v4 provides
Creates a Position Tracking campaign and returns its ID
Updates campaign settings, including weekly email notifications
Updates campaign settings, including weekly email notifications
Adds keywords to a campaign, optionally with tags, and returns the number added
Removes keywords from a campaign
Adds tags to keywords in a campaign
Removes tags from keywords in a campaign
Competitors configured for a campaign, with their IDs and tracked URLs
Adds competitors to a campaign
Removes competitors from a campaign
Position Tracking campaigns you can access, optionally filtered by project, with their targets, search engines, locations and settings
Locations and languages available for tracking with the selected search engine
Dates with available tracking data
Keyword counts in the top 3, 10, 20, 50 and 100 (depending on the search engine), plus visibility and estimated traffic over time. Partial coverage: v4 doesn’t return keyword counts for each individual position (1–100)
Keyword counts in the top 3, 10, 20, 50 and 100 (depending on the search engine), plus visibility and estimated traffic over time. Partial coverage: v4 doesn’t return keyword counts for each individual position (1–100)
Tracked keyword positions over a date range, with ranking URLs, keyword metrics and performance changes
Tracked keyword positions over a date range, with ranking URLs, keyword metrics and performance changes
Competitors ranking for your tracked keywords, with average positions, visibility and estimated traffic
Competitors ranking for your tracked keywords, with average positions, visibility and estimated traffic
Visibility, average position, share of voice and estimated traffic over time
Visibility, average position, share of voice and estimated traffic over time
Pages ranking for tracked keywords, with traffic, ranking metrics and keyword details
Pages ranking for tracked keywords, with traffic, ranking metrics and keyword details

Jump to Site AuditSite Audit

v3 endpoint
v4 endpoint
What v4 provides
Creates a Site Audit campaign and returns its ID, name, initial audit URL and crawl settings
Replaces all crawl settings (PUT) or updates only the settings named in update_mask (PATCH)
Split across endpoints: campaign metadata and audit dates, crawl settings, current audit progress, latest audit results, and crawl depth distribution
Starts an audit and returns its audit report ID
Finished audit reports, newest first, with pagination. Each report includes Site Health, thematic scores, errors, warnings, notices and crawl details
One finished audit report by ID, with Site Health, thematic scores, errors, warnings, notices and crawl details
Not covered by v4.
Not needed: v4 identifies issues by self-descriptive issue_type values, such as INTERNAL_LINK_BROKEN
Occurrences of one issue type in the latest successful audit, with pagination, sorting and filtering
Crawled pages with page IDs and summary stats. To find a page ID, filter by url
Page summary stats, incoming internal links and canonical references. Issues on the page, grouped by issue type, come from a separate endpoint

Jump to Trends APITrends API

v3 endpoint
v4 endpoint
What v4 provides
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—
Coming soon in v4.
—

Jump to Account and API unitsAccount and API units

v3 endpoint
v4 endpoint
What v4 provides
Coming soon in v4.
Meanwhile, check your balance in My Profile → Subscription info → API units. See API unit balance

Jump to Request parameter differencesRequest parameter differences

The tables summarize selected request parameter changes. Refer to the linked endpoint pages for complete request requirements.

Jump to BacklinksBacklinks

v3 endpoint
v4 endpoint
v3 input
v4 input
Change
target, target_type
url, scope
url replaces target. scope replaces target_type, and its values change: root_domain becomes ROOT_DOMAIN, domain becomes SUBDOMAIN, and url becomes PAGE. v4 adds SUBFOLDER scope.
target, target_type
url, scope
v3 accepts root domains only. v4 also accepts subdomains and pages through url and scope.
target, target_type
domain
v4 accepts a domain through domain. There’s no separate target-type parameter.
targets[], target_types[], export_columns, display_sort, display_limit, display_offset, display_filter
urls, scope, order_by, direction, limit, offset, filter
One scope applies to every URL in urls. order_by and direction replace display_sort. limit, offset, and filter replace display_limit, display_offset, and display_filter. v4 has no column-selection parameter and returns JSON only.
targets[], target_types[], export_columns
urls, scope, fields
One scope applies to every URL in urls. fields replaces export_columns for selecting response fields. The target limit drops from 200 in v3 to 10 in v4.

Jump to Keyword reportsKeyword reports

v3 endpoint
v4 endpoint
v3 input
v4 input
Change
phrase, database
keyword, country
keyword replaces phrase. country replaces database and takes a two-letter code. Each request accepts one keyword and one country.
display_date in the YYYYMM15 format
month in the YYYY-MM format
month replaces display_date. The date format changes from YYYYMM15 to YYYY-MM.
export_escape, export_decode, export_columns
format
format selects JSON or CSV output. v4 doesn’t support export_escape, export_decode, or export_columns.
phrase, database
keyword, country
Use keyword for the seed and country for the two-letter country code.
display_limit, display_offset
limit, offset
limit is the number of rows to return, without adding offset. The default is 100 and the maximum is 1,000. limit + offset can’t exceed 50,000.
display_sort, display_filter
order_by, direction, filter
Use v4 field names for sorting and filtering. For example, order_by=search_volume&direction=DESC. filter also supports words_count but doesn’t support trends. order_by=relevance works on Related only. Filter syntax and supported operators change.
export_columns, export_escape, export_decode
format
JSON is the default. Use format=csv for CSV. Column selection and the v3 export options aren’t supported.
type=phrase_questions
is_question=true
Set is_question=true on the Broad Match endpoint to return question keywords.

Jump to Project managementProject management

v3 endpoint
v4 endpoint
v3 input
v4 input
Change
filter
scope, limit, offset
scope replaces filter and uses uppercase values. limit and offset control pagination.
id
project_id path parameter
The path parameter is renamed from id to project_id.
url, optional project_name
domain, required project_name
domain replaces url. project_name becomes required.
project_id, required project_name
project_id path parameter, optional project_name body parameter
project_id moves to the URL path. project_name becomes optional. Omitting it leaves the name unchanged.

Jump to Domain AnalyticsDomain Analytics

v3 endpoint
v4 endpoint
v3 input
v4 input
Change
domain, subdomain, subfolder or url
url, required scope
Use url for the target and scope=ROOT_DOMAIN, SUBDOMAIN, SUBFOLDER or PAGE for its scope.
database
Required country and device_type
Select a country and a DESKTOP or MOBILE database. Use gb for the United Kingdom. uk is rejected.
All regional databases in one report
One country and device database per request
Get Supported Countries lists the available databases. Make separate summary requests for the databases you need.
display_date in the YYYYMM15 format
month in the YYYY-MM format
month selects a monthly snapshot. Omit it to use the latest available monthly snapshot.
History report selected by type
Required date_from, date_to in the YYYY-MM format
Specify the months to include in the trend.
display_daily
Monthly snapshots
These v4 endpoints return monthly data and don’t accept display_daily.
export_columns, display_limit, display_offset
fields, limit, offset
fields selects response fields. limit is the number of rows to return, without adding offset. The default is 100 and the maximum is 5,000. limit + offset can’t exceed 500,000.
display_sort, display_filter
order_by, direction, filter
Use named response fields for sorting and filtering. For example, order_by=volume&direction=DESC or filter=volume > 1000. Filter syntax and supported fields change.
display_positions_type or positions_type, default organic
position_type, default both types
Set position_type=ORGANIC for regular organic results or SERP_FEATURE for SERP-feature positions. Omit it to return both.
display_positions=new, lost, rise or fall
Separate changes endpoint with change_types, base_month, comparison_month
Use the changes endpoint for position changes. Values are NEW, LOST, IMPROVED, DECLINED and UNCHANGED. If you omit change_types, all types are returned. Specify the two months to compare.
display_positions=new, lost, rise or fall
Separate changes endpoint with change_types and month
Use the changes endpoint for changes since the month before month. Values are NEW, LOST, IMPROVED, DECLINED and UNCHANGED. The default is the first four.
phrase, database
keyword, required country, required device_type
keyword replaces phrase. Select the country and device database separately.
Advertising history over 12 months
One month per request
Make a separate request for each month you need. Each response includes that month’s advertisers, best ad positions and ad copy.
Encoded domains expression for up to five domains
target_url, target_scope, competitor_url, competitor_scope, channel, intersection_type
Each request compares two targets in one channel: ORGANIC, ADWORDS or PLA. Use separate pairwise requests for more targets and combine the results.
display_sort with change columns
order_by, direction, filter with difference fields
Sort or filter by a change field such as organic_traffic_difference to find winners and losers.

Jump to Position TrackingPosition Tracking

v3 endpoint
v4 endpoint
v3 input
v4 input
Change
projectID path parameter, tracking_url, tracking_url_type, location_id, campaign settings
JSON body with required project_id, title, engine, device, location_id, tracking_url, keywords
project_id moves to the JSON body. v4 uses tracking_url to define the scope, instead of tracking_url_type in v3. example.com tracks a root domain, while https://example.com tracks an exact page.
campaignID path parameter
campaign_id path parameter; weekly_notification JSON body field
One PATCH endpoint replaces the enable and disable endpoints. The JSON body field weekly_notification controls whether emails are sent.
campaignID; keywords array
campaign_id path parameter; JSON keywords array
The path parameter is renamed from campaignID to campaign_id. Adding keywords changes from PUT to POST and still uses objects with keyword and optional tags. Deleting keywords changes from keyword objects to keyword strings. Adding and deleting keywords accept up to 10,000 keywords per request.
campaignID, keywords, tags
campaign_id path parameter; JSON bindings array of tag-to-keyword objects
Each item in the bindings array associates a tag with its keywords.
campaignID; competitor domains
campaign_id path parameter; competitors objects with competitor_url when adding, competitor_ids when deleting
Adding competitors takes an array of objects containing competitor_url. Deleting competitors takes competitor_ids returned by the v4 Get Competitors endpoint.
projectID path parameter
Optional project_id query parameter
The required project ID in the URL becomes an optional project_id query parameter. Omitting it returns all campaigns available to the requester.
Optional filter_engine
Required engine
engine replaces filter_engine and becomes required. Values are GOOGLE, BING, or BAIDU.
campaignID, type=tracking_campaign_dates
campaign_id path parameter; required date_from and date_to in the YYYY-MM-DD format
A dedicated endpoint replaces type=tracking_campaign_dates. date_from and date_to are required.
type, campaignID, date_begin, date_end, display_limit, display_offset
Endpoint URL, campaign_id, channel, base_date, comparison_date, date_from, date_to, limit, offset
channel=ORGANIC or channel=PAID selects organic or Google Ads data. channel is required on every report endpoint. Get Seo Overview, Get Seo Overview Top Counters, Get Seo Competitors, and Get Seo Landing Pages require base_date and comparison_date. Get Seo Overview Trend requires date_from and date_to. Dates change from the YYYYMMDD format to the YYYY-MM-DD format. On Get Seo Overview, Get Seo Competitors, and Get Seo Landing Pages, limit and offset replace display_limit and display_offset.
url, business_name
target_url, target_business_name
Send a separate v4 Overview request for each target_url. Omit target_url to use the campaign target. URL masks use *. Business-name matching applies to local results without URLs.
use_volume
volume_type
Values become NATIONAL, REGIONAL or LOCAL. The default changes from the most local available level to the campaign setting. Applies to Google campaigns only.

Jump to Site AuditSite Audit

v3 endpoint
v4 endpoint
v3 input
v4 input
Change
id path parameter, crawl settings in the body
project_id query parameter, settings body object
project_id selects the project. Nest crawl settings in settings.
pageLimit, notify, crawlSubdomains, removedParameters
page_limit, email_notification_enabled, crawl_subdomains, removed_parameters
Setting names change as shown. v4 puts these fields in settings.
allow, disallow
allow, disallow in path_masks
Nest both arrays in path_masks, inside settings.
scheduleDay
schedule
v3 uses 1–7 for weekly audits and 0 for manual starts. v4 uses WEEKLY_MONDAY through WEEKLY_SUNDAY and adds DAILY. Omit schedule when creating a campaign for manual starts.
userAgentType
user_agent_type
7 (SiteAuditBot Desktop) becomes SITE_AUDIT_DESKTOP. 8 (SiteAuditBot Mobile) becomes SITE_AUDIT_MOBILE. 2 (GoogleBot Desktop), 3 (GoogleBot Mobile), and 9 (OpenAI-Search) aren’t supported. Include user_agent_type when creating a campaign or replacing all its settings.
respectCrawlDelay
—
Removed. v4 always follows the Crawl-delay directive in robots.txt.
POST with campaign settings
PUT or PATCH with settings
PUT replaces all settings and resets omitted fields. PATCH applies only fields named in the required update_mask query parameter.
jsRendering
js_rendering in settings
The name changes. RENDER_ALL and DISABLED values stay the same.
snapshot_id query parameter
audit_report_id path parameter
Select the audit report in the URL path.
snapshot_id, numeric issueId
issue_type path parameter
Use a named issue type, such as INTERNAL_LINK_BROKEN instead of issue ID 8. v4 returns the latest successful audit and doesn’t accept a snapshot ID.
page, limit, sort, filter
offset, limit, order_by, direction, filter
Pagination uses offset instead of page. Sorting uses separate field and direction parameters. Filters use expressions such as source_url CONTAINS "example.com".
url
filter
For a contains match, use a filter such as url CONTAINS "example.com/blog".

Jump to Response parameter differencesResponse parameter differences

The tables list changed response parameters only. Refer to the linked method pages for complete response schemas.

Jump to BacklinksBacklinks

v3 endpoint
v4 endpoint
v3 parameter
v4 parameter
Change
All Version 3 Backlinks endpoints with a Version 4 equivalent
CSV response
JSON (default)
CSV (format=csv, except Matrix)
JSON separates request metadata (meta) from results (data). CSV uses the v4 column names and values described below. Matrix supports JSON only.
ascore, total, and *_num fields
score, backlinks_count, and *_count fields
score replaces ascore, and backlinks_count replaces total. Count names change from *_num to *_count, such as domains_count and ip_class_c_count.
*_num, first_seen, last_seen, ip, and legacy Boolean field names
*_count, *_at, ip_address, and is_* Boolean fields
Examples: backlinks_num becomes backlinks_count, first_seen becomes first_seen_at, ip becomes ip_address, and nofollow becomes is_nofollow. On Backlinks and Pages, external_num and internal_num become external_links_count and internal_links_count. Referring Domains doesn’t return domain_trust_score.
zone or country, domains_num, backlinks_num
domain, country, backlinks_count
v4 returns individual referring domains rather than TLD or country totals. Totals require grouping all result pages by TLD or country. Country values change from country names to two-letter ISO 3166-1 alpha-2 codes.
neighbour, score, domains_num, backlinks_num
domain, similarity, common_refdomains
domain replaces neighbour. v4 returns similarity and common_refdomains but doesn’t return the v3 score, domains_num, or backlinks_num metrics. similarity changes from a percentage to a ratio from 0 to 1.
One response column for each target, matches_num, and domain_ascore or domain_score
backlinks_counts, matches_count, and domain_score
backlinks_counts replaces the separate target columns with an array ordered like urls. matches_count replaces matches_num. The domain authority score field is named domain_score.
target, target_type, ascore, and *_num fields
url, score, and *_count fields
url replaces target, score replaces ascore, and count names use *_count. v4 doesn’t return the v3 IP, nofollow, text, image, form, or frame counts.
ascore, domains_num
domain_score, domains_count
domain_score replaces ascore. domains_count replaces domains_num.
date, backlinks_num, domains_num
month_date, backlinks_count, domains_count
month_date replaces date. backlinks_count and domains_count replace backlinks_num and domains_num. v4 also returns follows_count.

Jump to Keyword reportsKeyword reports

v3 endpoint
v4 endpoint
v3 parameter
v4 parameter
Change
CSV rows
meta and data JSON response (format=json); CSV rows (format=csv)
JSON puts the keyword, country, and month in meta, and metrics in data. CSV contains the metric columns. Both formats use the v4 names, units, and values described below.
Nq, Cp, Co, Nr, In, Kd
search_volume, cpc, competitive_density, number_of_results, intents, keyword_difficulty
The v3 column abbreviations are replaced by the v4 field names shown here. In JSON, these fields are in data.
Td
trends
trends replaces Td. In JSON, it’s an array in data. Values change from a 0–1 scale to integers from 0 to 100.
Co value from 0 to 1; Cp in USD; In values from 0 to 3
competitive_density from 0 to 100; cpc in USD cents; intents string values
Competition changes from a 0–1 scale to 0–100. CPC changes from USD to USD cents. Search intents change from numeric codes to strings.
Dt, Db, Ph response columns
month, country, keyword
In JSON, month, country, and keyword are in meta, separate from the metrics in data.
Ph response column
keyword
In JSON, keyword is in meta. It isn’t a metric field in data.
Kd
keyword_difficulty
keyword_difficulty replaces Kd. In JSON, it’s in data.
CSV rows
JSON (default)
CSV (format=csv)
In JSON, data is an array of keyword objects. Each contains keyword and a metrics object. meta contains the seed keyword, country and pagination details.
Nq, Cp, Co, Nr, In, Kd, Td
search_volume, cpc, competitive_density, number_of_results, intents, keyword_difficulty, trends
Metric names change as shown. CPC uses USD cents. Competition and trends use a 0–100 scale. Search intents use strings. In JSON, these fields are in each keyword’s metrics object.
Fk numeric SERP feature codes
serp_features string values
SERP features use names such as FEATURED_SNIPPET instead of numeric codes.
Rr
relevance
relevance is an integer from 0 to 100, returned alongside keyword and metrics in each JSON result.

Jump to Domain AnalyticsDomain Analytics

v3 endpoint
v4 endpoint
v3 parameter
v4 parameter
Change
CSV rows
JSON response with data and meta
Results are in data. meta identifies the requested target, database and month, and includes pagination where supported. These v4 references document JSON output.
Rk, Or, Ot, Oc, Ad, At, Ac
rank, organic_positions, organic_traffic, organic_traffic_cost, adwords_positions, adwords_traffic, adwords_traffic_cost
Summary metrics use descriptive names and are grouped in metrics. rank and month are outside that object.
Ph, Po, Nq, Kd, Nr
keyword, position, volume, keyword_difficulty, results
Keyword fields use descriptive names. Gap positions are in the separate target and competitor objects. keyword_difficulty is new for paid keywords.
Cp as a USD amount
cpc object with value and currency
CPC is now an object with value and currency. value is in USD, same as in v3.
Tr, Tc, Tg
traffic_percent, traffic_cost_percent, traffic
Percentage shares remain separate from estimated traffic counts. traffic is a count, not a percentage.
Co from 0 to 1
competition_density from 0 to 100
The competition scale changes from 0–1 to 0–100.
In numeric codes, Td values from 0 to 1
intents strings, trends values from 0 to 100
Search intents use strings such as COMMERCIAL. Monthly search-interest values use a 0–100 scale.
Ur, Pc, Tg, Tr
url or subdomain, organic_positions, organic_traffic, traffic_percent (pages) or organic_traffic_percent (subdomains)
Page and subdomain results use named fields for the target, keyword counts, traffic and traffic share.
Dn, Np, Cr (Cr from 0 to 1)
domain, common_keywords, competition_density (competition_density from 0 to 100)
Competitor identifiers, shared keyword counts and competition levels use descriptive names. The competition scale changes from 0–1 to 0–100.
Tt, Ds, Vu, Ur, Pc
title, description, url_visible, url, positions
Ad copy and URLs use named fields. positions counts the keyword positions where the ad appeared.
Cv, Dt, Po, Tt, Ds
coverage_12m, best_positions, title, description
Coverage returns the 12-month percentage and a best_positions list containing month and position. Monthly keyword responses provide each month’s ad title and description.
Dt, Po, Dn, Tt, Ds, Ur, Vu
month, position, domain, title, description, url, url_visible
The requested month is in meta. Each advertiser has its best position and associated ad copy for that month.
Pr, Tt, Sn, Ur
price, title, shop_name, url
price is an object containing value and currency. Product titles, shop names and landing URLs use named fields.
P0 through P4
target, competitor
Each side has its own position and url. Its ranking object is omitted when that side doesn’t rank for the keyword.

Jump to Project managementProject management

v3 endpoint
v4 endpoint
v3 parameter
v4 parameter
Change
All Version 3 Project management endpoints with a Version 4 equivalent
Top-level project fields
data
Project fields are in data, with request metadata in meta. data is an array for List Projects and an object for single-project endpoints.
url
domain
domain replaces url.
permission
permissions
The v3 permission-code list becomes a permissions object with Boolean fields: read, edit, delete, share, and downgraded.
tool
name
Within tools, name replaces tool as the tool identifier.

Jump to Position TrackingPosition Tracking

v3 endpoint
v4 endpoint
v3 parameter
v4 parameter
Change
All Version 3 Position Tracking methods with a Version 4 equivalent
data plus endpoint-specific root fields, such as total, limit, offset, and state
meta and data
v3 response structure varies by endpoint. v4 groups status, request, campaign, and pagination details in meta, and results in data.
campaign_id
campaign_id, added_keywords
campaign_id moves from result to data, which also contains added_keywords. The project ID is returned as project_id in meta.
id, url, type, isGathering
campaign_id, tracking_url, tracking_url_type, weekly_notification, created_at, updated_at
In campaigns, campaign_id, tracking_url, and tracking_url_type replace id, url, and type. v4 adds weekly_notification, created_at, and updated_at. isGathering isn’t returned.
competitors array of domain strings
id, competitor_url, competitor_url_type
The competitors array changes from domain strings to objects containing id, competitor_url, and competitor_url_type.
Updated campaign details
added_keywords when adding keywords. Empty data object for the other operations
Adding keywords returns added_keywords in data. The other listed operations return an empty data object rather than updated campaign details.
Dt in the YYYYMMDD format; last_crawl
date in the YYYY-MM-DD format
Dates are returned as date fields in the tracking_points array and use YYYY-MM-DD. v4 doesn’t return last_crawl.
visibility, differenceVisibility, top3, top10, other ranking counters, and data
counter for ranking counters; tracking_points for visibility and traffic trends
The Top Counters endpoint returns ranking counts. The Trend endpoint returns visibility and traffic values in tracking_points. The data array, which holds the number of keywords at each position from 1 to 100, has no v4 equivalent. v4 provides aggregated Top N counters only.
Ph, Kb, Tg, Cp, Nq, Dt, Vi, Sov, Tr, Tc
keyword, created_at, tags, cpc, volume, tracking_points, diff
Each keyword has named fields, such as keyword, cpc, and volume. Values for each tracking date are grouped in tracking_points.
Ur, Dt, Mc, Av, Sq, Cl, Sov, Tr, Tc
competitor_url, tracking_points, diff
Each competitor is identified by competitor_url, with values for each tracking date in tracking_points and changes in diff.
Dt, Vi, Vr, Av, Sov, Tr, Tc
date, absolute_visibility, visibility, average_position, share_of_voice, traffic, traffic_cost
Metric fields use names such as visibility, average_position, and share_of_voice. The date field in tracking_points uses YYYY-MM-DD.
Ur, Tp, Mc, Av, Tr, Tc, Rq, Kw
url, status, metrics, diff, keywords
Page metrics in metrics are for comparison_date. diff contains changes between base_date and comparison_date. keywords contains per-date keyword positions. Tc (page traffic cost) isn’t returned by this endpoint.
Cp, Nq
cpc, volume
cpc remains in USD. volume is average monthly search volume. Both metrics are available for Google campaigns only.

Jump to Site AuditSite Audit

v3 endpoint
v4 endpoint
v3 parameter
v4 parameter
Change
Campaign metadata, crawl settings, progress, and audit results in one response
Separate responses in data
Get Campaign returns metadata and last_success_audit_report_id. Get Campaign Settings returns settings. Get Audit Progress returns live counters. Get Audit Report returns completed audit results. Get Linking Report returns the crawl depth distribution in depths.
id, url, last_audit, last_failed_audit, next_audit
campaign_id, domain, last_audit_at, last_failed_audit_at, next_audit_at
Identifiers and date fields are renamed as shown. v4 dates are ISO 8601 UTC strings.
snapshot_id
audit_report_id
v4 returns 202 Accepted before the audit finishes. data contains the ID of the report being generated (audit_report_id).
snapshot_id, finish_date
audit_report_id, finish_date
audit_report_id replaces snapshot_id. finish_date changes from a Unix timestamp in milliseconds to an ISO 8601 UTC string. Lists are in data, with pagination in meta.
quality, numeric issue id
total_score, issue_type
total_score replaces quality and keeps value and delta. Issues in errors, warnings, and notices use string issue_type values instead of numeric IDs.
issue_id, page, total, data
data, meta
Occurrences stay in data. Pagination and total_count move to meta, which also includes audit_report_id. v4 selects the issue through the issue_type path parameter.
data, total
data, total_count
Pages are returned in data. The result count is total_count in meta.
page_id, url, title, errors, warnings, notices
page, severity, issue_type, issues
Get Audited Page returns page details in page, inside data. Get Audited Page Issues returns issue groups in data, identified by severity and issue_type.
discovered, info
discovered, info
discovered changes from a Unix timestamp in milliseconds to an ISO 8601 UTC string. The structure inside info depends on the issue. For example, http_code_info contains the HTTP status code in a code field.

Last updated: November 13, 2026

Was this page helpful?