Semrush | Composio Docs

Overview

SLUG

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

generic_api_key

stringRequired

Tools

Get keyword difficulty

SLUG: SEMRUSH_KEYWORD_DIFFICULTY

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

stringRequired

error

string

successful

booleanRequired

Get ad copies

SLUG: SEMRUSH_ADS_COPIES

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

stringRequired

error

string

successful

booleanRequired

Get anchor texts

SLUG: SEMRUSH_ANCHORS

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

stringRequired

error

string

successful

booleanRequired

Get authority score profile

SLUG: SEMRUSH_AUTHORITY_SCORE_PROFILE

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

stringRequired

error

string

successful

booleanRequired

Get backlinks

SLUG: SEMRUSH_BACKLINKS

Fetches backlinks for a specified domain or url as a csv-formatted string, allowing customization of columns, sorting, and filtering; ensure `display limit` surpasses `display offset` when an offset is used, and note the `urlanchor` filter may have limitations for targets with extensive backlinks.

Action Parameters

display_filter

array

display_limit

integer

display_offset

integer

display_sort

stringDefaults to page_ascore_desc

export_columns

arrayDefaults to ['page_ascore', 'response_code', 'source_size', 'external_num', 'internal_num', 'redirect_url', 'source_url', 'source_title', 'image_url', 'target_url', 'target_title', 'anchor', 'image_alt', 'last_seen', 'first_seen', 'nofollow', 'form', 'frame', 'image', 'sitewide', 'newlink', 'lostlink']

target

stringRequired

target_type

stringRequired

Action Response

data

stringRequired

error

string

successful

booleanRequired

Backlinks overview

SLUG: SEMRUSH_BACKLINKS_OVERVIEW

Provides a csv-formatted summary of backlinks, including authority score and link type breakdowns, for a specified and publicly accessible domain, root domain, or url.

Action Parameters

export_columns

arrayDefaults to ['ascore', 'total', 'domains_num', 'urls_num', 'ips_num', 'ipclassc_num', 'follows_num', 'nofollows_num', 'sponsored_num', 'ugc_num', 'texts_num', 'images_num', 'forms_num', 'frames_num']

target

stringRequired

target_type

stringRequired

Action Response

data

stringRequired

error

string

successful

booleanRequired

Batch comparison

SLUG: SEMRUSH_BATCH_COMPARISON

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

stringRequired

error

string

successful

booleanRequired

Batch keyword overview

SLUG: SEMRUSH_BATCH_KEYWORD_OVERVIEW

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

objectRequired

error

string

successful

booleanRequired

Broad match keyword

SLUG: SEMRUSH_BROAD_MATCH_KEYWORD

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

stringRequired

error

string

successful

booleanRequired

Get categories

SLUG: SEMRUSH_CATEGORIES

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

stringRequired

error

string

successful

booleanRequired

Get categories profile

SLUG: SEMRUSH_CATEGORIES_PROFILE

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

stringRequired

error

string

successful

booleanRequired

Get competitor data

SLUG: SEMRUSH_COMPETITORS

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

stringRequired

error

string

successful

booleanRequired

Get competitors in organic search

SLUG: SEMRUSH_COMPETITORS_IN_ORGANIC_SEARCH

Use to get a domain's organic search competitors from semrush as a semicolon-separated string; `display date` requires 'yyyymm15' format if used.

Action Parameters

database

stringRequired

display_date

string

display_limit

integerDefaults to 10000

display_offset

integer

display_sort

stringDefaults to np_desc

domain

stringRequired

export_columns

arrayDefaults to ['Dn', 'Cr', 'Np', 'Or', 'Ot', 'Oc', 'Ad', 'Sr', 'St', 'Sc']

export_decode

integerDefaults to 1

export_escape

integerDefaults to 1

Action Response

data

stringRequired

error

string

successful

booleanRequired

Get competitors in paid search

SLUG: SEMRUSH_COMPETITORS_IN_PAID_SEARCH

Retrieves a list of a domain's competitors in paid search results from a specified regional database.

Action Parameters

database

stringRequired

display_date

string

display_limit

integerDefaults to 10000

display_offset

integer

display_sort

stringDefaults to np_desc

domain

stringRequired

export_columns

arrayDefaults to ['Dn', 'Cr', 'Np', 'Ad', 'At', 'Ac', 'Or']

export_decode

integerDefaults to 1

export_escape

integerDefaults to 1

Action Response

data

stringRequired

error

string

successful

booleanRequired

Get domain ad history

SLUG: SEMRUSH_DOMAIN_AD_HISTORY

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

stringRequired

error

string

successful

booleanRequired

Get domain organic pages

SLUG: SEMRUSH_DOMAIN_ORGANIC_PAGES

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

stringRequired

error

string

successful

booleanRequired

Get domain organic search keywords

SLUG: SEMRUSH_DOMAIN_ORGANIC_SEARCH_KEYWORDS

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

stringRequired

error

string

successful

booleanRequired

Get domain organic subdomains

SLUG: SEMRUSH_DOMAIN_ORGANIC_SUBDOMAINS

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

stringRequired

error

string

successful

booleanRequired

Get domain paid search keywords

SLUG: SEMRUSH_DOMAIN_PAID_SEARCH_KEYWORDS

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

stringRequired

error

string

successful

booleanRequired

Get PLA search keywords for a domain

SLUG: SEMRUSH_DOMAIN_PLA_SEARCH_KEYWORDS

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

stringRequired

error

string

successful

booleanRequired