Semrush

Learn how to use Semrush with Composio

Overview

Enum

SEMRUSH

Description

Semrush is a popular SEO tool suite that specializes in keyword research, competitor analysis, and Google Ad campaign optimization.

Authentication Details

api_key
stringRequired

Actions

Retrieves unique ad copies semrush has observed for a specified domain from a regional database, detailing ads seen in google's paid search results.

Action Parameters

database
stringRequired
display_filter
array
display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to pc_desc
domain
stringRequired
export_columns
arrayDefaults to ['Ph', 'Un', 'Tt', 'Ds', 'Vu', 'Ur', 'Pc', 'Ts']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1

Action Response

data
string
error
successful
boolean
Use this action to get a csv report of anchor texts for backlinks pointing to a specified, publicly accessible domain, root domain, or url.

Action Parameters

display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to domains_num_desc
export_columns
arrayDefaults to ['anchor', 'domains_num', 'backlinks_num', 'first_seen', 'last_seen']
target
stringRequired
target_type
stringRequired

Action Response

data
string
error
successful
boolean
Retrieves the authority score (as) profile for a specified target, showing the count of referring domains that link to the target for each as value from 0 to 100.

Action Parameters

target
stringRequired
target_type
stringRequired

Action Response

data
string
error
successful
boolean
Compares backlink profiles for multiple specified targets (domains, subdomains, or urls) to analyze and compare link-building efforts.

Action Parameters

export_columns
arrayDefaults to ['target', 'target_type', 'ascore', 'backlinks_num', 'domains_num', 'ips_num', 'follows_num', 'nofollows_num', 'texts_num', 'images_num', 'forms_num', 'frames_num']
target_types
arrayRequired
targets
arrayRequired

Action Response

data
string
error
successful
boolean
Fetches a keyword overview report from a semrush regional database for up to 100 keywords, providing metrics like search volume, cpc, and keyword difficulty.

Action Parameters

database
stringRequired
display_date
string
export_columns
arrayDefaults to ['Ph', 'Nq', 'Cp', 'Co', 'Nr', 'Td', 'In', 'Kd']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1
phrase
stringRequired

Action Response

data
object
error
successful
boolean
Fetches broad match keywords for a given phrase; `display sort` and `display filter` parameters are defined but currently not utilized by the api call.

Action Parameters

database
stringRequired
display_date
string
display_filter
array
display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to nq_desc
export_columns
arrayDefaults to ['Ph', 'Nq', 'Cp', 'Co', 'Nr', 'Td', 'Fk', 'In', 'Kd']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1
phrase
stringRequired

Action Response

data
string
error
successful
boolean
Retrieves categories and their 0-1 confidence ratings for a specified domain, subdomain, or url, with results sorted by rating.

Action Parameters

display_limit
integer
display_offset
integer
export_columns
arrayDefaults to ['category_name', 'rating']
target
stringRequired
target_type
stringRequired

Action Response

data
string
error
successful
boolean
Retrieves a profile of content categories from referring domains for a specified target, analyzing its first 10,000 referring domains and sorting results by domain count.

Action Parameters

display_limit
integer
display_offset
integer
export_columns
arrayDefaults to ['category_name', 'rating']
target
stringRequired
target_type
stringRequired

Action Response

data
string
error
successful
boolean
Retrieves a customizable csv report of competitors for a specified target (root domain, domain, or url) based on shared backlinks or referring domains, ensuring the target is valid and its type is correctly specified.

Action Parameters

display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to common_backlinks_num_desc
export_columns
arrayDefaults to ['ascore', 'neighbour', 'similarity', 'common_refdomains', 'domains_num', 'backlinks_num']
target
stringRequired
target_type
stringRequired

Action Response

data
string
error
successful
boolean
Retrieves a domain's 12-month advertising history from semrush (keywords bid on, ad positions, ad copy) for ppc strategy and competitor analysis; most effective when the domain has ad history in the selected database.

Action Parameters

database
stringRequired
display_filter
array
display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to cv_desc
domain
stringRequired
export_columns
arrayDefaults to ['Ph', 'Dt', 'Po', 'Cp', 'Nq', 'Tr', 'Ur', 'Tt', 'Ds', 'Vu', 'Cv']
export_escape
integerDefaults to 1

Action Response

data
string
error
successful
boolean
Fetches a report on a domain's unique organic pages ranking in google's top 100 search results, with options for specifying database, date, columns, sorting, and filtering.

Action Parameters

database
stringRequired
display_date
string
display_filter
array
display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to pc_desc
domain
stringRequired
export_columns
arrayDefaults to ['Ur', 'Pc', 'Tg', 'Tr', 'Ipu', 'Ip0', 'Ip1', 'Ip2', 'Ip3', 'Itu', 'It0', 'It1', 'It2', 'It3', 'Sr', 'St']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1

Action Response

data
string
error
successful
boolean
Retrieves organic search keywords for a domain from a specified semrush regional database; `display positions` must be set if `display daily=1` for daily updates.

Action Parameters

database
stringRequired
display_daily
integer
display_date
string
display_filter
array
display_limit
integerDefaults to 10000
display_offset
integer
display_positions
string
display_positions_type
stringDefaults to organic
display_sort
stringDefaults to po_desc
domain
stringRequired
export_columns
arrayDefaults to ['Ph', 'Po', 'Pp', 'Pd', 'Nq', 'Cp', 'Ur', 'Tr', 'Tg', 'Tc', 'Co', 'Nr', 'Td', 'Kd', 'Fp', 'Fk', 'Ts', 'In', 'Pt']
export_escape
integerDefaults to 1

Action Response

data
string
error
successful
boolean
Retrieves a report on subdomains of a given domain that rank in google's top 100 organic search results for a specified regional database.

Action Parameters

database
stringRequired
display_date
string
display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to pc_desc
domain
stringRequired
export_columns
arrayDefaults to ['Ur', 'Pc', 'Tg', 'Tr', 'Sr', 'St']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1

Action Response

data
string
error
successful
boolean
Fetches keywords driving paid search traffic to a specified, existing domain using a supported semrush regional database.

Action Parameters

database
stringRequired
display_date
string
display_filter
array
display_limit
integerDefaults to 10000
display_offset
integer
display_positions
string
display_sort
stringDefaults to po_desc
domain
stringRequired
export_columns
arrayDefaults to ['Ph', 'Po', 'Pp', 'Pd', 'Ab', 'Nq', 'Cp', 'Tg', 'Tr', 'Tc', 'Co', 'Nr', 'Td', 'Tt', 'Ds', 'Vu', 'Ur', 'Ts', 'Un']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1

Action Response

data
string
error
successful
boolean
Retrieves product listing ad (pla) search keywords for a specified domain from a semrush regional database.

Action Parameters

database
stringRequired
display_filter
array
display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to po_desc
domain
stringRequired
export_columns
arrayDefaults to ['Ph', 'Po', 'Pp', 'Pd', 'Nq', 'Sn', 'Ur', 'Tt', 'Pr', 'Ts']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1

Action Response

data
string
error
successful
boolean
Analyzes keyword rankings by comparing up to five domains to find common, unique, or gap keywords, using specified organic/paid types and comparison logic in the `domains` string.

Action Parameters

database
stringRequired
display_date
string
display_filter
array
display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to p0_desc
domains
stringRequired
export_columns
arrayDefaults to ['Ph', 'P0', 'P1', 'P2', 'P3', 'P4', 'Nr', 'Cp', 'Nq', 'Kd', 'Co', 'Td']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1

Action Response

data
string
error
successful
boolean
Retrieves monthly historical backlink and referring domain data for a specified root domain, returned as a time series string with newest records first.

Action Parameters

display_limit
integer
display_offset
integer
export_columns
arrayDefaults to ['date', 'backlinks_num', 'domains_num', 'score']
target
stringRequired
target_type
stringRequired

Action Response

data
string
error
successful
boolean
Retrieves a list of indexed pages from semrush for a specified `target` (root domain, domain, or url) and `target type`, ensuring `target` is publicly accessible, semrush-analyzable, and correctly matches `target type`.

Action Parameters

display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to backlinks_num_desc
export_columns
arrayDefaults to ['source_url', 'source_title', 'response_code', 'backlinks_num', 'domains_num', 'last_seen', 'external_num', 'internal_num']
target
stringRequired
target_type
stringRequired

Action Response

data
string
error
successful
boolean
Fetches a historical report (last 12 months) of domains advertising on a specified keyword in google ads, optionally for a specific month ('yyyymm15') or the most recent period, returning raw csv-like data.

Action Parameters

database
stringRequired
display_date
string
display_limit
integerDefaults to 10000
display_offset
integer
export_columns
arrayDefaults to ['Dn', 'Dt', 'Po', 'Ur', 'Tt', 'Ds', 'Vu', 'At', 'Ac', 'Ad']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1
phrase
stringRequired

Action Response

data
string
error
successful
boolean
Determines the keyword difficulty (kd) score (0-100, higher means greater difficulty) for a given phrase in a specific semrush regional database to assess its seo competitiveness.

Action Parameters

database
stringRequired
export_columns
arrayDefaults to ['Ph', 'Kd']
export_escape
integerDefaults to 1
phrase
stringRequired

Action Response

data
string
error
successful
boolean
Fetches a keyword overview from semrush for a specified phrase, including metrics like search volume, cpc, and competition.

Action Parameters

database
string
export_columns
arrayDefaults to ['Dt', 'Db', 'Ph', 'Nq', 'Cp', 'Co', 'Nr', 'In', 'Kd']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1
phrase
stringRequired

Action Response

data
object
error
successful
boolean
Fetches a keyword summary for a specified phrase from a chosen regional database.

Action Parameters

database
stringRequired
display_date
string
export_columns
arrayDefaults to ['Ph', 'Nq', 'Cp', 'Co', 'Nr', 'Td', 'In', 'Kd']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1
phrase
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves up to 100,000 domains and urls from google's top 100 organic search results for a keyword and region, returning a raw string; use `display date` in 'yyyymm15' format (day must be '15') for historical data.

Action Parameters

database
stringRequired
display_date
string
display_limit
integerDefaults to 10000
display_offset
integer
export_columns
arrayDefaults to ['Po', 'Pt', 'Dn', 'Ur', 'Fk', 'Fp', 'Fl']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1
phrase
stringRequired
positions_type
stringDefaults to organic

Action Response

data
string
error
successful
boolean
Fetches domains ranking in google's paid search results (adwords) for a specified keyword and regional database.

Action Parameters

database
stringRequired
display_date
string
display_limit
integerDefaults to 10000
display_offset
integer
export_columns
arrayDefaults to ['Dn', 'Ur', 'Vu']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1
phrase
stringRequired

Action Response

data
string
error
successful
boolean
Fetches question-format keywords semantically related to a given query phrase for a specified regional database, aiding in understanding user search intent and discovering content ideas.

Action Parameters

database
stringRequired
display_filter
array
display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to nq_desc
export_columns
arrayDefaults to ['Ph', 'Nq', 'Cp', 'Co', 'Nr', 'Td', 'In', 'Kd']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1
phrase
stringRequired

Action Response

data
string
error
successful
boolean
Retrieves domains competing with a specified domain in google's product listing ads (pla) from a given semrush regional database.

Action Parameters

database
stringRequired
display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to np_desc
domain
stringRequired
export_columns
arrayDefaults to ['Dn', 'Cr', 'Np', 'Sh', 'Ad', 'At', 'Ac', 'Or']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1

Action Response

data
string
error
successful
boolean
Fetches product listing ad (pla) copies that semrush observed for a domain in google's paid search results.

Action Parameters

database
stringRequired
display_filter
array
display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to pr_desc
domain
stringRequired
export_columns
arrayDefaults to ['Tt', 'Pr', 'Ur', 'Pc', 'Un', 'Ts']
export_decode
integerDefaults to 1
export_escape
integerDefaults to 1

Action Response

data
string
error
successful
boolean
Retrieves a report as a text string (e.g., csv) listing domains that link to a target, with options to filter by type (not value).

Action Parameters

display_filter
array
display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to backlinks_num_desc
export_columns
arrayDefaults to ['domain_ascore', 'domain', 'backlinks_num', 'ip', 'country', 'first_seen', 'last_seen']
target
stringRequired
target_type
stringRequired

Action Response

data
string
error
successful
boolean
Generates a csv report detailing the geographic distribution of referring domains (by country, determined via ip address) for a specified, publicly accessible target.

Action Parameters

display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to domains_num_desc
export_columns
arrayDefaults to ['country', 'domains_num', 'backlinks_num']
target
stringRequired
target_type
stringRequired

Action Response

data
string
error
successful
boolean
Fetches ip addresses that are sources of backlinks for a specified target domain, root domain, or url.

Action Parameters

display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to backlinks_num_desc
export_columns
arrayDefaults to ['ip', 'country', 'domains_num', 'backlinks_num', 'first_seen', 'last_seen']
target
stringRequired
target_type
stringRequired

Action Response

data
string
error
successful
boolean
Fetches a report on the top-level domain (tld) distribution of referring domains for a specified target, useful for analyzing geographic or categorical backlink diversity.

Action Parameters

display_limit
integerDefaults to 10000
display_offset
integer
display_sort
stringDefaults to domains_num_desc
export_columns
arrayDefaults to ['zone', 'domains_num', 'backlinks_num']
target
stringRequired
target_type
stringRequired

Action Response

data
string
error
successful
boolean