Skip to main content
Semrush logo
  • Category: marketing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 98
  • Triggers: 0
  • Slug: SEMRUSH
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: SEMRUSH_ACCOUNT_UNITS_BALANCEFetch remaining Semrush Standard API units for a legacy v3 connection. This documented balance request is free. Use it before large paid report batches to fail fast when units are exhausted or below a required threshold.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_ADD_REVIEW_COMMENTPublish an owner comment to a review that supports replies. This mutation creates a public reply. Requires a Semrush v4 API key and a Local Pro or Business, plus a connected publisher account that permits replies.

Input Parameters

string
required
Comment text.
string
required
Review to reply to.
string
required
Location to which the review belongs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_ADS_COPIESRetrieves unique ad copies Semrush has observed for a specified domain from a regional database, detailing ads seen in Google’s paid search results. Results are a sampled subset, not a complete picture of the domain’s advertising. Response is returned as a CSV-like string; parse columns (e.g., Tt, Ds) using the pipe or semicolon delimiter.

Input Parameters

string
required
Domain name to investigate for ad copies.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Regional database code.
string ("pc_asc" | "pc_desc")
Sort order for results by ad position.
integer
Maximum number of ad copies to return.
integer ("0" | "1")
Set 1 for decoded response, 0 for URL-encoded.
integer ("0" | "1")
Set 1 to wrap report columns in double quotation marks (”), 0 for unescaped.
array
Ad components to filter on. Supported: Tt (Ad Title), Ds (Ad Description), Vu (Visible URL).
integer
Number of initial ad copies to skip for pagination.
array
Columns to include. If omitted, all are returned. Available: Ph (Keyword phrase), Un (Unique ad identifier), Tt (Ad Title), Ds (Ad Description), Vu (Visible URL), Ur (Destination URL), Pc (Ad Position), Ts (Timestamp last seen).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_ANCHORSDEPRECATED: Please use ‘SEMRUSH_V4_ANCHORS’ instead. Use this action to get a CSV report of anchor texts for backlinks pointing to a specified, publicly accessible domain, root domain, or URL.

Input Parameters

string
required
Domain, root domain, or URL to analyze for its backlink anchor texts.
string ("root_domain" | "domain" | "url")
required
Specifies if the ‘target’ is a ‘root_domain’, ‘domain’, or ‘url’.
string ("domains_num_asc" | "domains_num_desc" | "backlinks_num_asc" | "backlinks_num_desc" | "first_seen_asc" | "first_seen_desc" | "last_seen_asc" | "last_seen_desc")
Sorting criteria for the report; defaults to domains_num_desc (most referring domains first).
integer
Maximum number of anchor text entries to return.
integer
Number of anchor text entries to skip for pagination.
array
Columns to include in the report; defaults to all available columns if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_AUTHORITY_SCORE_PROFILEDEPRECATED: Please use ‘SEMRUSH_V4_AUTHORITY_SCORE_PROFILE’ instead. 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.

Input Parameters

string
required
The target entity (URL, domain, or root domain) for which to retrieve the Authority Score profile. For example, ‘example.com’, ‘https://example.com/blog’, or ‘blog.example.com’.
string ("root_domain" | "domain" | "url")
required
Specifies the type of the target. Valid options are ‘root_domain’ (e.g., ‘example.com’), ‘domain’ (e.g., ‘blog.example.com’, which can be a subdomain), or ‘url’ (a specific page like ‘https://example.com/article’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_BATCH_COMPARISONDEPRECATED: Please use ‘SEMRUSH_V4_BACKLINKS_COMPARISON’ instead. Compares backlink profiles for multiple specified targets (domains, subdomains, or URLs) to analyze and compare link-building efforts.

Input Parameters

array
required
A list of target domains, subdomains, or URLs for which to retrieve backlink comparison data.
array
required
Specifies the type for each corresponding target in ‘targets’. Ensure this list aligns with ‘targets’ in order and count for accurate processing.
array
Specific columns to include in the report. Defaults to all columns. An empty list may result in specific API behavior, like returning a default or minimal set of columns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_BATCH_KEYWORD_OVERVIEWDEPRECATED: Semrush has deprecated this v3 report; no v4 equivalent exists. Fetches a keyword overview report from a Semrush regional database for up to 100 keywords, providing metrics like search volume, CPC, and keyword difficulty. Response is CSV-like text (not JSON); parse accordingly. Returns literal string ‘ERROR 50 :: NOTHING FOUND’ for keywords with no data in the selected database — treat as zero results and fall back to SEMRUSH_KEYWORD_OVERVIEW_ONE_DATABASE or SEMRUSH_KEYWORD_OVERVIEW_ALL_DATABASES for those terms.

Input Parameters

string
required
Up to 100 keywords to analyze. Keywords can be separated by newlines (‘\n’) or semicolons (’;’). The API requires semicolon-separated format with total phrase length of 1-255 characters. Newlines are automatically converted to semicolons. If you have many keywords, consider reducing the list or using shorter keyword phrases to stay within the 255-character limit.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
The Semrush regional database to use for the analysis (e.g., ‘us’, ‘gb’, ‘de’). Refer to Semrush API documentation for a full list of available databases. Database choice materially affects returned search volume and keyword difficulty values.
string
Date in “YYYYMM15” format for past month data (e.g., “20231215”); uses most recent data if omitted.
integer ("0" | "1")
Set to 0 for URL-encoded response, or 1 for plain text (non-converted) response.
integer ("0" | "1")
Set to 1 to wrap report columns in double quotation marks (”), or 0 to disable.
array
Specific columns for the report (e.g., Ph, Nq); defaults to all if omitted. Available columns: - Ph: Keyword/Phrase analyzed. - Nq: Search Volume (avg. monthly queries). - Cp: Cost-Per-Click (avg. CPC). - Co: Competition level of advertisers. - Nr: Number of URLs in organic results. - Td: Search volume trend (last 12 months). - In: Searcher intent (informational, navigational, commercial, transactional). - Kd: Keyword Difficulty score.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_BROAD_MATCH_KEYWORDDEPRECATED: Semrush has deprecated this v3 report; no v4 equivalent exists. Fetches broad match keywords for a given phrase. Response is CSV-like text (not JSON); parse by splitting on line breaks and delimiters. display_sort and display_filter parameters are defined but currently not utilized by the API call.

Input Parameters

string
required
Keyword, phrase, or expression to investigate for broad matches and alternative search queries.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Regional database for keyword research (e.g., ‘us’ for United States, ‘gb’ for United Kingdom).
string
Date in “YYYYMM15” format (e.g., “20231215”) for historical data. If omitted or empty, most recent data is returned.
string ("nq_asc" | "nq_desc" | "cp_asc" | "cp_desc" | "co_asc" | "co_desc" | "nr_asc" | "nr_desc" | "kd_asc" | "kd_desc")
Column and order to sort results (e.g., ‘nq_desc’ for Search Volume descending).
integer
Maximum number of results. The API interprets a value of 0 as the default (10,000). Max: 100,000.
integer ("0" | "1")
If 1 (default), returns a raw text response; 0 for a URL-encoded string.
integer ("0" | "1")
If 1 (default), wraps CSV columns in double quotes; 0 disables. Applies if output is CSV-like.
array
Filter conditions for results, from predefined criteria. Behavior depends on API interpretation of these values.
integer
Number of results to skip from the beginning of the list for pagination.
array
Specific columns to include in the report (e.g., ‘Ph’ for Phrase). If not specified, all default columns are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_CATEGORIESDEPRECATED: Semrush has deprecated this v3 report; no v4 equivalent exists. Retrieves categories and their 0-1 confidence ratings for a specified domain, subdomain, or URL, with results sorted by rating. Response is returned as semicolon-separated text in a single ‘data’ field requiring parsing before use. Some niche or atypical targets may return no category data.

Input Parameters

string
required
Domain, subdomain, or URL to analyze for category information.
string ("root_domain" | "domain" | "url")
required
Type of the target being analyzed.
integer
Maximum results to return. Note: if set to 0 (the field’s default), the API service will default to returning 10,000 lines.
integer
Number of initial results to skip. To maintain desired fetched records after offset, increase display_limit by this value.
array
List of columns for the output. Defaults to all available columns if this list is empty or not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_CATEGORIES_PROFILEDEPRECATED: Semrush has deprecated this v3 report; no v4 equivalent exists. 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.

Input Parameters

string
required
The target URL, domain, or root domain for which to retrieve categories profile data.
string ("root_domain" | "domain" | "url")
required
Type of the target.
integer
Maximum results to return. If 0 (default), 10,000 lines are returned. Max: 1,000,000.
integer
Number of initial results to skip; display_limit should be offset + desired_results (e.g., for 100 results from 51st, display_offset=50, display_limit=150).
array
Columns to include in the report; defaults to all available columns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_COMPETITORSDEPRECATED: Please use ‘SEMRUSH_V4_BACKLINK_COMPETITORS’ instead. Retrieves a CSV-formatted report of competitors for a specified target (root domain, domain, or URL) based on shared backlinks or referring domains. Output is a CSV string; use display_limit and display_offset to paginate without silent truncation.

Input Parameters

string
required
The domain, subdomain, or URL to analyze for competitors.
string ("root_domain" | "domain" | "url")
required
Type of the target: ‘root_domain’, ‘domain’, or ‘url’. Must match the format of target exactly: passing a full URL with ‘root_domain’ or ‘domain’ (or vice versa) produces empty or error responses indistinguishable from missing data.
string ("similarity_asc" | "similarity_desc")
Sort order for the competitors list. Only similarity-based sorting is supported (similarity_asc, similarity_desc). If omitted, the API returns results in its default order.
integer
Maximum number of competitors to return.
integer
Number of results to skip for pagination.
array
Columns to include in the CSV report; defaults to all available columns if empty or omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_COMPETITORS_IN_ORGANIC_SEARCHUse to get a domain’s organic search competitors from Semrush as a semicolon-separated string; display_date requires ‘YYYYMM15’ format if used.

Input Parameters

string
required
Domain to investigate (e.g., ‘example.com’).
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Regional database for analysis (e.g., ‘us’, ‘gb’). See Semrush docs for all databases.
string
Snapshot date for data retrieval in ‘YYYYMM15’ format (e.g., ‘20231015’); defaults to latest period if omitted.
string ("np_asc" | "np_desc" | "cr_asc" | "cr_desc")
Sort column and order. Defaults to common keywords, descending.
integer
Maximum results to return. Use with display_offset for >100,000 results.
integer ("0" | "1")
Set to 0 for URL-encoded response, 1 for no URL-encoding.
integer ("0" | "1")
Set to 1 to wrap output values in double quotes, 0 to disable.
integer
Number of initial results to skip; for pagination with display_limit.
array
Data columns to include; defaults to all. See CompetitorsInOrganicSearchExportColumns for codes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_COMPETITORS_IN_PAID_SEARCHRetrieves a list of a domain’s competitors in paid search results from a specified regional database.

Input Parameters

string
required
Domain name to investigate (e.g., ‘example.com’).
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Regional database to query. For available databases, see Semrush API documentation.
string
Date for data retrieval (YYYYMM15 for monthly). If unspecified, API uses latest daily ranking data.
string ("np_asc" | "np_desc" | "cr_asc" | "cr_desc")
Sort column and order. Default: ‘np_desc’ (Common Paid Keywords, descending). Options: ‘np_asc’, ‘np_desc’, ‘cr_asc’, ‘cr_desc’.
integer
Maximum number of results. The API typically returns up to 100,000 per request; use with display_offset to retrieve more.
integer ("0" | "1")
Set to 1 for a decoded response; 0 for a URL-encoded string.
integer ("0" | "1")
Set to 1 to wrap columns in double quotes (”); 0 to disable.
integer
Number of results to skip. The sum of display_limit and display_offset must not exceed 4,000,000.
array
Columns for the report. Defaults to all. Options: Dn (Domain Name), Cr (Competition Level), Np (Common Paid Keywords), Ad (Paid Keywords), At (Paid Search Traffic), Ac (Paid Search Traffic Cost), Or (Common Organic Keywords).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_CREATE_GBP_POSTCreate a draft, scheduled, or ready-to-send GBP post. Either content or image_urls must be supplied. Requires EDIT or OWNER rights for an active Semrush location with a Google Business Profile connection.

Input Parameters

string ("DRAFT" | "SCHEDULED" | "TO_SEND")
required
Status to assign after creating or updating the post.
string
Post text. Either this field or image_urls must be supplied.
array
Zero or one public post image URL. Either this field or content must be supplied.
string
required
Location associated with the post.
object
Optional post button configuration.
string
UTC publication time; required only for SCHEDULED posts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_CREATE_LISTING_MANAGEMENT_LOCATIONCreate a Semrush Listing Management location. HTTP success starts asynchronous provisioning; poll Get Listing Management location until its status is COMPLETED or FAILED, which may take up to seven days. Supply at least one location body field. Use the validation action to check a payload without creating. Create locations sequentially; Semrush does not support concurrent create requests and may return 429. Requires a v4 key with Read and write permission and Local Pro or Business. This family does not consume Standard API units.

Input Parameters

string
Postal or ZIP code. Required for US, AU, FR, DE, GB, CA, IN, ES, IT, NL, BR, AT, BE, DK, FI, NO, PL, SE, CH, JP, MX, IL, NZ, SG, ZA, TR, ID, VN, PK, CO, IE, BD, MY, SA, RO, CL, PH, PT, NG, GR, TH, AR, PE, KE, HU, CZ, RS, NP, LT, UA, BG, EC, CY, HR, EE, LV, IS, SK, SI, AM, AD, PY, EG, MV, UY, KH, LA, MT, PA, PR, TN, DO, MN, GU, VE, ME, MP.
string
City or locality, up to 64 characters.
string
Highest postal administrative subdivision. Required for CA, AU, BR, IN, and US; must not be supplied for other countries.
string ("US" | "AU" | "FR" | "DE" | "GB" | "CA" | "IN" | "ES" | "IT" | "NL" | "BR" | "AT" | "BE" | "DK" | "FI" | "NO" | "PL" | "SE" | "CH" | "JP" | "MX" | "IL" | "NZ" | "SG" | "ZA" | "TR" | "AE" | "HK" | "ID" | "VN" | "PK" | "CO" | "IE" | "BD" | "MY" | "SA" | "RO" | "CL" | "PH" | "PT" | "NG" | "GR" | "TH" | "AR" | "PE" | "KE" | "HU" | "CZ" | "RS" | "NP" | "LT" | "UA" | "BG" | "EC" | "CY" | "HR" | "EE" | "LV" | "IS" | "SK" | "SI" | "AM" | "AD" | "PY" | "GY" | "EG" | "MV" | "UY" | "SR" | "KH" | "BO" | "LA" | "MT" | "PA" | "PR" | "TN" | "DO" | "MN" | "GU" | "VE" | "ME" | "MP")
ISO 3166-1 alpha-2 country code supported by Semrush Local.
array
Additional weekly schedules by more-hours type.
object
Business latitude and longitude.
string
Business description, documented as 10 to 750 characters.
string
Future reopening date in YYYY-MM-DD format.
string
Public business website, up to 255 characters.
array
Up to 10 Semrush Local category IDs; the first is primary.
string
Primary phone number in international format, for example +49 351 8629318 or +1 541-754-3010.
string
Official public business name, up to 125 characters.
array
Date-specific exceptional business hours.
string
YouTube video URL, up to 150 characters.
string
Street address, up to 190 characters.
string
Supplemental address, up to 64 characters.
object
Regular weekly business hours.
array
Category-specific Google Business Profile attributes.
array
Payment option IDs returned by Get Location Payment Options.
Promotional profile message, up to 50 characters.
array
Up to 10 GBP category IDs; the first is primary.
boolean
Whether to hide the address; service areas must then be populated.
string
X (formerly Twitter) handle, up to 15 characters.
string
Instagram handle, up to 30 characters.
array
Places served by a service-area business.
Call-to-action URL, up to 255 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_CREATE_LOCATION_IMAGEAdd a base64-encoded JPEG or PNG image to a Semrush Listing Management location using a read-write v4 key and Local Pro or Business.

Input Parameters

string ("PHOTO" | "PROFILE" | "COVER")
required
Image use. PHOTO: 270x270 to 5000x5000; PROFILE: 250x250 to 5000x5000; COVER: 480x270 to 2120x1192.
string
required
Base64-encoded JPEG, JPG, or PNG image content, at most 4 MB.
string
Image caption.
string
required
Unique Semrush Local location identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DECIDE_GBP_SUGGESTIONStart accepting or rejecting an open GBP suggestion. Poll List GBP Suggestions until the status becomes ACCEPTED, REJECTED, or FAILED. Accepting a GBP_USER_EDIT may also close a paired GBP_DATA_MISMATCH suggestion for the same field. Requires EDIT or OWNER rights on an active location.

Input Parameters

string ("ACCEPT" | "REJECT")
required
Whether to ACCEPT or REJECT the open suggestion.
string
required
Location associated with the suggestion.
string
required
Suggestion to accept or reject.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DELETE_GBP_POSTPermanently delete a DRAFT, SCHEDULED, or TO_SEND GBP post. Requires EDIT or OWNER rights; posts for frozen or canceled locations cannot be deleted.

Input Parameters

string
required
Post to delete.
string
required
Location associated with the post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DELETE_LISTING_MANAGEMENT_LOCATIONPermanently delete an eligible location using a read-write v4 key and Local plan.

Input Parameters

string
required
Unique Semrush Local location identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DELETE_LOCATION_IMAGEPermanently delete an image using a read-write v4 key and Local plan.

Input Parameters

string
required
Unique Semrush Local image identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DELETE_REVIEW_COMMENTPermanently remove a public review comment. This destructive mutation cannot be undone. Requires a Semrush v4 API key and Local Pro or Business, plus a connected publisher account that permits comment removal.

Input Parameters

string
required
Review to which the comment belongs.
string
required
Comment to remove permanently.
string
required
Location to which the review belongs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DISABLE_LOCATION_LISTINGStop distribution for a controllable listing; a parent may affect child listings. Requires a read-write v4 key and Local Pro or Business.

Input Parameters

string
required
Unique Semrush Local listing identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DOMAIN_AD_HISTORYRetrieves 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.

Input Parameters

string
required
Website name (e.g., ‘example.com’) to investigate.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Regional database to use (e.g., ‘us’). Link: https://developer.semrush.com/api/v3/analytics/basic-docs/#databases
string ("cv_asc" | "cv_desc")
Sort order for results: cv_asc (Costs % ascending), cv_desc (Costs % descending).
integer
Number of results for the current request (typically up to 100k). For larger datasets, use with display_offset. Cumulative display_limit with offset should not exceed 4,000,000.
integer ("0" | "1")
If 1, wraps report columns in double quotation marks (”); if 0, no escaping.
array
Filters using column identifiers (e.g., Ph). Semrush’s API may expect +Column|Operator|Value format (e.g., +Ph|Ct|semrush); consult Semrush documentation. Simplified filterable columns available: Ph (Keyword), Nq (Num. keywords), Cp (CPC), Tr (Traffic %).
integer
Number of initial results to skip for pagination. When fetching beyond 100k, display_limit might need to reflect current_offset + desired_rows_for_this_page per Semrush guidance.
array
Data columns to include (e.g., Ph, Dt). If unspecified, all columns are returned. An empty list may error. Available: Ph (Keyword), Dt (Date), Po (Position), Cp (CPC), Nq (Num. keywords), Tr (Traffic %), Ur (URL), Tt (Ad Title), Ds (Ad Description), Vu (Volume), Cv (Costs %).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DOMAIN_ORGANIC_PAGESFetches 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. Response is semicolon-separated CSV text in a single data field requiring explicit parsing. The literal response ERROR 50 :: NOTHING FOUND means zero results for that domain/database combination, not a system error. Traffic metrics (e.g., Tr) are modeled estimates incompatible with first-party analytics data.

Input Parameters

string
required
Domain name to analyze (e.g., ‘example.com’).
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Regional database for analysis (e.g., ‘us’, ‘gb’, ‘de’). See Semrush API docs for full list.
string
Date for historical data report in YYYYMM15 format (e.g., ‘20231015’). If omitted, uses most recent data. Day component MUST be 15; any other day value will not return historical data correctly.
string ("pc_asc" | "pc_desc" | "tg_asc" | "tg_desc" | "tr_asc" | "tr_desc" | "sr_asc" | "sr_desc" | "st_asc" | "st_desc")
Column and order for sorting results (e.g., ‘pc_desc’ for traffic share descending).
integer
Maximum number of results to return. For more than 100,000, use with display_offset. Large domains may exceed 10,000 rows; results are silently truncated at display_limit. Paginate by incrementing display_offset until fewer rows than display_limit are returned. Avoid unnecessarily large values — each request consumes API units (HTTP 402 if exhausted) and may trigger rate limits (HTTP 429).
integer ("0" | "1")
Set to 0 for URL-encoded response, 1 for decoded (non-converted) response.
integer ("0" | "1")
Set to 1 to wrap report columns in double quotation marks (”), 0 to disable.
array
Columns from DomainOrganicPagesFilterType to filter results by. If empty, no column-specific filters are applied.
integer
Number of results to skip (for pagination with display_limit).
array
Columns to include in the report. If omitted, all columns from DomainOrganicPagesExportColumns are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DOMAIN_ORGANIC_SEARCH_KEYWORDSRetrieves an organic search keyword report for a domain from a selected Semrush regional database. Choose report columns, date and sort order, and use the limit and offset to page through results. The report is returned as text and requires a Semrush v3 connection.

Input Parameters

string
required
The domain name (e.g., example.com) to investigate for organic search keywords.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
The regional database to query (e.g., ‘us’, ‘uk’, ‘de’).
string
Date for keyword data: ‘YYYYMM15’ for monthly historical, ‘YYYYMMDD’ for daily (e.g., ‘20231015’, ‘20231120’). Shows latest daily ranking changes if unspecified.
string ("po_asc" | "po_desc" | "tg_asc" | "tg_desc" | "tr_asc" | "tr_desc" | "tc_asc" | "tc_desc" | "nq_asc" | "nq_desc" | "co_asc" | "co_desc" | "kd_asc" | "kd_desc" | "cp_asc" | "cp_desc" | "nr_asc" | "nr_desc" | "ts_asc" | "ts_desc")
Column and order for sorting results (e.g., ‘po_desc’ for position descending).
integer
Set to 1 for daily updates on position changes (last 31 days), or 0 for monthly results. Requires display_positions if set to 1.
integer
Number of results. When display_offset is used, this specifies the CUMULATIVE count from the start. Semrush may have per-call limits; use pagination for large datasets.
integer ("0" | "1")
Set to 1 to wrap report columns in double quotation marks (”); 0 to disable.
array
List of column codes from DomainOrganicSearchKeywordsFilterType for filtering (e.g., ‘Ph’, ‘Ur’). For complex filter syntax like ‘Ph|Cn|semrush’, refer to Semrush API documentation.
integer
Number of initial results to skip for pagination. When used, display_limit should be display_offset + number of rows for the current page.
array
Data columns to include. If omitted, all columns from DomainOrganicSearchKeywordsExportColumns are requested. Retain key metrics Tr (traffic), Cp (CPC), Po (position), and Kd (keyword difficulty) to avoid missing critical data.
string ("new" | "lost" | "rise" | "fall")
Filter keywords by position changes in Google’s top 100: ‘new’, ‘lost’, ‘rise’, or ‘fall’.
string ("organic" | "all" | "serp_features")
Type of ranking positions: ‘organic’ (standard), ‘all’ (includes SERP features), or ‘serp_features’ (domain ranks in SERP features).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DOMAIN_ORGANIC_SUBDOMAINSRetrieves a report on subdomains of a given domain that rank in Google’s top 100 organic search results for a specified regional database.

Input Parameters

string
required
Domain name to analyze (e.g., ‘example.com’).
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Regional database to query (e.g., ‘us’, ‘gb’). Refer to Semrush API documentation for a complete list.
string
Date for report generation in YYYYMM15 format (e.g., ‘20231015’). If not provided, latest available data is used.
string ("pc_asc" | "pc_desc" | "tg_asc" | "tg_desc" | "tr_asc" | "tr_desc" | "sr_asc" | "sr_desc" | "st_asc" | "st_desc")
Column and order for sorting results (e.g., ‘pc_desc’ sorts by keyword count descending).
integer
Number of results to return. For fetching over 100,000 results, display_offset should be used and display_limit may need appropriate adjustment.
integer ("0" | "1")
Specifies if response data is URL-decoded (1 for decoded, 0 for URL-encoded string).
integer ("0" | "1")
Specifies if CSV columns are wrapped in double quotes (1 to enable, 0 to disable).
integer
Number of initial results to skip for pagination. When using display_offset, display_limit might need to be increased by the display_offset value.
array
Specific columns for the report (e.g., Ur, Pc, Tr). If omitted, a default set is returned. Consult Semrush API documentation for column definitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DOMAIN_PAID_SEARCH_KEYWORDSFetches keywords driving paid search traffic to a specified, existing domain using a supported Semrush regional database.

Input Parameters

string
required
Domain name to investigate.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Regional database to query.
string
Date for data retrieval (YYYYMM15 for monthly, YYYYMMDD for daily). Latest data if unspecified.
string ("po_asc" | "po_desc" | "tg_asc" | "tg_desc" | "tr_asc" | "tr_desc" | "tc_asc" | "tc_desc" | "nq_asc" | "nq_desc")
Column and order for sorting results.
integer
Maximum number of keywords to return. Use with display_offset for pagination.
integer ("0" | "1")
Set to 0 for URL-encoded response; 1 for non-URL-encoded response.
integer ("0" | "1")
Set to 1 to wrap report columns in double quotation marks (”); 0 to disable.
array
Filters to apply using a specific format string: ’[+/-]|[column_code]|[operator]|[value]’. Refer to Semrush API documentation for detailed filter syntax and available fields.
integer
Number of results to skip for pagination. If used, display_limit should be increased by this value; total display_limit (inclusive of offset) must not exceed 4,000,000.
array
Columns to include in the report. All columns returned if unspecified. See DomainPaidSearchKeywordsExportColumns for options.
string ("new" | "lost" | "rise" | "fall")
Filter keywords by ranking status (‘new’, ‘lost’, ‘rise’, ‘fall’) in Google’s top 100 paid search results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DOMAIN_PLA_SEARCH_KEYWORDSRetrieves Product Listing Ad (PLA) search keywords for a specified domain from a Semrush regional database.

Input Parameters

string
required
Domain name (e.g., ‘example.com’) to investigate for PLA search keywords.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Semrush regional database to query (e.g., ‘us’, ‘gb’, ‘ca’).
string ("po_asc" | "po_desc" | "nq_asc" | "nq_desc" | "pr_asc" | "pr_desc")
Column and order for sorting results (e.g., ‘po_desc’ for position descending).
integer
Maximum number of results to return. For pagination with display_offset, display_limit might need to be desired_count + display_offset. Semrush may return up to 100,000 lines per call if display_offset is not used.
integer ("0" | "1")
If 1, decodes URL-encoded response data; if 0, returns data as a raw URL-encoded string.
integer ("0" | "1")
If 1, wraps report column values in double quotes (e.g., “value”); 0 disables wrapping.
array
Column names (e.g., ‘Ph’, ‘Tt’) for filtering results. Filtering logic is Semrush API-specific; refer to their documentation for details.
integer
Number of results to skip from the beginning of the report, for pagination.
array
Specific data columns to include in the report (e.g., ‘Ph’ for Keyword, ‘Ur’ for Landing Page URL, ‘Tt’ for Ad Title). If not specified, all available columns are requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_DOMAIN_VS_DOMAINAnalyzes 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.

Input Parameters

string
required
A URL-encoded string specifying the domains to compare and the comparison logic, separated by the ’|’ symbol. Each domain entry follows the format: <sign>|<type>|<domain>. Up to five domains can be compared. <sign>: Operation type (+, -, , /). <type>: Keyword type (‘or’ for organic, ‘ad’ for paid). <domain>: The domain name. Examples of combinations: • Shared keywords: |or|<your_domain>||or|<domain2>||or|<domain3> • All keywords: *|or|<your_domain>|+|or|<domain2>|+|or|<domain3> • Unique keywords for your domain: *|or|<your_domain>|-|or|<domain2>|-|or|<domain3> • Untapped keywords (keywords in others, not yours): *|or|<domain2>|+|or|<domain3>|-|or|<your_domain> • Missing keywords (keywords in common among others, not yours): |or|<domain2>||or|<domain3>|-|or|<your_domain> • Keywords exclusive to one domain: *|or|<your_domain>|/|or|<domain2>|/|or|<domain3> (API only).
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Regional database for the query. Refer to DatabaseEnum or SEMrush documentation for a complete list.
string
Report date in YYYYMM15 format (e.g., ‘20231015’) for historical/current data. Latest data used if omitted.
string ("p0_asc" | "p0_desc" | "p1_asc" | "p1_desc" | "p2_asc" | "p2_desc" | "p3_asc" | "p3_desc" | "p4_asc" | "p4_desc" | "nq_asc" | "nq_desc" | "co_asc" | "co_desc" | "cp_asc" | "cp_desc" | "nr_asc" | "nr_desc")
Sorting criteria: ‘columnName_direction’ (e.g., ‘p0_desc’). See DomainVsDomainSortOrder for options.
integer
Maximum number of keywords to return. Use with display_offset for pagination of large datasets (up to 100,000 results per call is typical).
integer ("0" | "1")
Controls if the response is URL-decoded. 1: decode response; 0: return URL-encoded string.
integer ("0" | "1")
Controls if special characters in output are escaped. 1: escape (columns wrapped in ""); 0: no escaping.
array
List of column codes from DomainVsDomainFilterType to filter results. Behavior is API-specific.
integer
Number of initial results to skip for pagination with display_limit. For instance, display_offset=10000 and display_limit=10000 retrieves results 10,001-20,000.
array
Columns to include in the report. All default columns are returned if empty. See DomainVsDomainExportColumns for codes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_ENABLE_LOCATION_LISTINGResume distribution for a controllable disconnected listing. Requires a read-write v4 key and Local Pro or Business.

Input Parameters

string
required
Unique Semrush Local listing identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_GET_GBP_METRICSReturn GBP metrics for up to five locations. Provide at least one of aggregated_metrics or total_metrics. Requires a Semrush v4 API key and Local Pro or Business. Each location requires a Google Business Profile connection. Semrush does not document the total_metrics response shape, so that field remains untyped.

Input Parameters

string
required
Report end date within the last 24 months.
string
required
Report start date within the last 24 months.
array
required
One to five Semrush location IDs.
array
Metrics totaled across the full period. Provide at least one of aggregated_metrics or total_metrics. Accepted values: TOTAL_VIEWS, TOTAL_MAPS_VIEWS, TOTAL_SEARCH_VIEWS, TOTAL_MOBILE_SEARCH_VIEWS, TOTAL_DESKTOP_SEARCH_VIEWS, TOTAL_MOBILE_MAPS_VIEWS, TOTAL_DESKTOP_MAPS_VIEWS, TOTAL_ACTION, TOTAL_WEBSITE_CLICKS_ACTION, TOTAL_BUSINESS_DIRECTION_REQUESTS_ACTION, TOTAL_CALL_CLICKS_ACTION.
string ("DAILY" | "WEEKLY" | "MONTHLY")
Metric aggregation period.
array
Metrics grouped by aggregation period. Provide at least one of aggregated_metrics or total_metrics. Accepted values: ALL_ACTION, MAPS_VIEWS, SEARCH_VIEWS, TOTAL_VIEWS, BUSINESS_IMPRESSIONS_MOBILE_SEARCH, BUSINESS_IMPRESSIONS_DESKTOP_SEARCH, BUSINESS_IMPRESSIONS_MOBILE_MAPS, BUSINESS_IMPRESSIONS_DESKTOP_MAPS, WEBSITE_CLICKS, BUSINESS_DIRECTION_REQUESTS, CALL_CLICKS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_GET_LISTING_MANAGEMENT_LOCATIONGet one Listing Management location using a v4 key and Local Pro or Business.

Input Parameters

string
required
Unique Semrush Local location identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_GET_REVIEW_AUTO_REPLY_CONFIGReturn review auto-reply settings for a location. Requires a Semrush v4 API key, Local Pro or Business, and a GBP connection.

Input Parameters

string
required
Location whose auto-reply settings are requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_GET_REVIEW_OVERVIEWReturn review counts, rating distribution, and reply statistics. Requires a Semrush v4 API key, Local Pro or Business, and a GBP connection.

Input Parameters

string
required
Location whose review overview is requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_HISTORICAL_DATADEPRECATED: Please use ‘SEMRUSH_V4_BACKLINKS_HISTORICAL_SUMMARY’ instead. Retrieves monthly historical backlink and referring domain data for a specified root domain, returned as a time series string with newest records first.

Input Parameters

string
required
The root domain URL (e.g., ‘example.com’) for which to retrieve historical backlink data.
string
required
The type of target. Must be ‘root_domain’ for this action.
integer
Maximum number of historical data records (lines) to return. If 0 (default), the API backend uses 10,000. Max: 1,000,000.
integer
Number of initial records to skip in the results.
array
Specifies data columns for the report. Defaults to all: date, backlinks_num, domains_num, score.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_INDEXED_PAGESDEPRECATED: Retrieves a Semrush indexed-pages report for a specified root domain, domain, or URL and target type. Returns CSV-like text for parsing.

Input Parameters

string
required
Target URL, domain, or root domain for which to retrieve indexed pages data.
string ("root_domain" | "domain" | "url")
required
Type of the target.
string ("backlinks_num_asc" | "backlinks_num_desc" | "domains_num_asc" | "domains_num_desc" | "last_seen_asc" | "last_seen_desc")
Sorting criteria for the results.
integer
Maximum number of results to return.
integer
Number of initial results to skip. Note: When using display_offset, the display_limit should be the desired number of results plus the display_offset (e.g., for 100 results after skipping 50, set display_offset=50, display_limit=150).
array
Specific columns for the report; defaults to all available columns if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_KEYWORD_DIFFICULTYDEPRECATED: Please use ‘SEMRUSH_V4_KEYWORD_METRICS’ instead. 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. Returns CSV-formatted text; parse before programmatic use.

Input Parameters

string
required
The keyword or keyword phrase to analyze for difficulty. Minor wording variations produce different KD scores; normalize phrases before comparing results.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
The Semrush regional database to use for the analysis (e.g., ‘us’, ‘gb’, ‘ca’). Refer to the Semrush API documentation for a complete list of valid database codes: https://developer.semrush.com/api/v3/analytics/basic-docs/#databases.
integer ("0" | "1")
Set to 1 to wrap output columns in double quotes (”), or 0 to disable.
array
Specifies columns to include in the output (e.g., ‘Ph’ for Phrase, ‘Kd’ for Keyword Difficulty). Uses all available columns if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_KEYWORD_OVERVIEW_ALL_DATABASESDEPRECATED: Semrush has deprecated this v3 report; no v4 equivalent exists. Fetches a keyword overview from Semrush for a specified phrase, including metrics like search volume, CPC, and competition. Response is returned as a CSV-like string; parse headers and rows into a structured table before extracting values like Nq, Cp, or Kd.

Input Parameters

string
required
Keyword or keyword phrase to investigate.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
Regional database to query (e.g., ‘us’, ‘gb’); if omitted, data is retrieved from all regional databases.
integer
Set to 1 for a URL-decoded response, 0 for URL-encoded.
integer ("0" | "1")
Set to 1 to wrap output columns in double quotes, 0 to disable.
array
Specific columns for the report (e.g., ‘Ph’, ‘Nq’, ‘Cp’). Defaults to all columns, including Date (Dt), Database (Db), Phrase (Ph), Search Volume (Nq), CPC (Cp), Competition (Co), Number of Results (Nr), Intent (In), and Keyword Difficulty (Kd).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_KEYWORD_OVERVIEW_ONE_DATABASEDEPRECATED: Please use ‘SEMRUSH_V4_KEYWORD_METRICS’ instead. Fetches a keyword summary for a specified phrase from a chosen regional database. Returns CSV-like text (not JSON) with column headers matching export_columns codes (e.g., ‘Ph’, ‘Nq’, ‘Kd’); parse headers and rows into structured data before use. A plain-text ‘ERROR 50 :: NOTHING FOUND’ response indicates zero results, not a transport error.

Input Parameters

string
required
The keyword or keyword phrase to investigate.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
A regional database code (e.g., ‘us’ for United States, ‘gb’ for United Kingdom). Refer to Semrush documentation for a comprehensive list of available databases (https://developer.semrush.com/api/v3/analytics/basic-docs/#databases).
string
Optional. Date in “YYYYMM15” format (e.g., “20231215” for December 2023) to retrieve data for a specific past month. If omitted or empty, the most recent data is returned.
integer ("0" | "1")
If set to 0, the response will be a URL-encoded string. If set to 1 (default), the response will not be URL-encoded.
integer ("0" | "1")
If set to 1 (default), the report’s columns will be wrapped in double quotation marks (”). Set to 0 to disable.
array
A list of specific columns to include in the report. If omitted, all available columns are returned by default. Available columns: Ph (Keyword phrase), Nq (Monthly search volume), Cp (Cost Per Click in USD), Co (Competition level of advertisers, 0 to 1), Nr (Number of URLs in organic search results), Td (Search trend over the last 12 months), In (Searcher intent types like informational, navigational, commercial, transactional), Kd (Keyword difficulty score, 0 to 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_KEYWORDS_ADS_HISTORYDEPRECATED: Semrush has deprecated this v3 report; no v4 equivalent exists. 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.

Input Parameters

string
required
Keyword or phrase for historical advertising data analysis.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Regional database to query.
string
Specifies a past month for data retrieval, formatted as ‘YYYYMM15’. If omitted, returns most recent period’s data.
integer
Maximum number of results (lines) to return.
integer ("0" | "1")
Set to 1 for a non-URL-encoded response, 0 for URL-encoded.
integer ("0" | "1")
Set to 1 to wrap output columns in double quotes, 0 to disable.
integer
Number of results to skip for pagination.
array
Specific columns to include. If omitted or empty, all columns are returned. See KeywordsAdsHistoryExportColumns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_LIST_GBP_ADDITIONAL_HOUR_TYPESReturn additional business-hour types available for a GBP location. Requires a Semrush v4 API key and Local Pro or Business. An active Google Business Profile connection is required for the location.

Input Parameters

string
required
GBP-connected Semrush location ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_LIST_GBP_ATTRIBUTESReturn GBP attributes and allowed values for a category and country. Requires a Semrush v4 API key and Local Pro or Business.

Input Parameters

string ("US" | "AU" | "FR" | "DE" | "GB" | "CA" | "IN" | "ES" | "IT" | "NL" | "BR" | "AT" | "BE" | "DK" | "FI" | "NO" | "PL" | "SE" | "CH" | "JP" | "MX" | "IL" | "NZ" | "SG" | "ZA" | "TR" | "AE" | "HK" | "ID" | "VN" | "PK" | "CO" | "IE" | "BD" | "MY" | "SA" | "RO" | "CL" | "PH" | "PT" | "NG" | "GR" | "TH" | "AR" | "PE" | "KE" | "HU" | "CZ" | "RS" | "NP" | "LT" | "UA" | "BG" | "EC" | "CY" | "HR" | "EE" | "LV" | "IS" | "SK" | "SI" | "AM" | "AD" | "PY" | "GY" | "EG" | "MV" | "UY" | "SR" | "KH" | "BO" | "LA" | "MT" | "PA" | "PR" | "TN" | "DO" | "MN" | "GU" | "VE" | "ME" | "MP" | "AC" | "AG" | "AI" | "AL" | "AO" | "AS" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BF" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BQ" | "BS" | "BT" | "BW" | "BY" | "BZ" | "CC" | "CD" | "CF" | "CG" | "CI" | "CK" | "CM" | "CR" | "CV" | "CW" | "CX" | "DJ" | "DM" | "DZ" | "EH" | "ER" | "ET" | "FJ" | "FK" | "FM" | "FO" | "GA" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GT" | "GW" | "HN" | "HT" | "IM" | "IO" | "IQ" | "JE" | "JM" | "JO" | "KG" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LU" | "LY" | "MA" | "MC" | "MD" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MO" | "MQ" | "MR" | "MS" | "MU" | "MW" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NI" | "NR" | "NU" | "OM" | "PF" | "PG" | "PM" | "PS" | "PW" | "QA" | "RE" | "RU" | "RW" | "SB" | "SC" | "SH" | "SJ" | "SL" | "SM" | "SN" | "SO" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TC" | "TD" | "TG" | "TJ" | "TK" | "TL" | "TM" | "TO" | "TT" | "TV" | "TW" | "TZ" | "UG" | "UZ" | "VA" | "VC" | "VG" | "VI" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZM" | "ZW")
required
GBP-supported ISO 3166-1 alpha-2 country code.
string
required
GBP category whose attributes are requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_LIST_GBP_CATEGORIESReturn GBP categories supported in a country. Requires a Semrush v4 API key and Local Pro or Business.

Input Parameters

integer
Maximum categories returned.
integer
Starting record offset.
string ("US" | "AU" | "FR" | "DE" | "GB" | "CA" | "IN" | "ES" | "IT" | "NL" | "BR" | "AT" | "BE" | "DK" | "FI" | "NO" | "PL" | "SE" | "CH" | "JP" | "MX" | "IL" | "NZ" | "SG" | "ZA" | "TR" | "AE" | "HK" | "ID" | "VN" | "PK" | "CO" | "IE" | "BD" | "MY" | "SA" | "RO" | "CL" | "PH" | "PT" | "NG" | "GR" | "TH" | "AR" | "PE" | "KE" | "HU" | "CZ" | "RS" | "NP" | "LT" | "UA" | "BG" | "EC" | "CY" | "HR" | "EE" | "LV" | "IS" | "SK" | "SI" | "AM" | "AD" | "PY" | "GY" | "EG" | "MV" | "UY" | "SR" | "KH" | "BO" | "LA" | "MT" | "PA" | "PR" | "TN" | "DO" | "MN" | "GU" | "VE" | "ME" | "MP" | "AC" | "AG" | "AI" | "AL" | "AO" | "AS" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BF" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BQ" | "BS" | "BT" | "BW" | "BY" | "BZ" | "CC" | "CD" | "CF" | "CG" | "CI" | "CK" | "CM" | "CR" | "CV" | "CW" | "CX" | "DJ" | "DM" | "DZ" | "EH" | "ER" | "ET" | "FJ" | "FK" | "FM" | "FO" | "GA" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GT" | "GW" | "HN" | "HT" | "IM" | "IO" | "IQ" | "JE" | "JM" | "JO" | "KG" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LU" | "LY" | "MA" | "MC" | "MD" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MO" | "MQ" | "MR" | "MS" | "MU" | "MW" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NI" | "NR" | "NU" | "OM" | "PF" | "PG" | "PM" | "PS" | "PW" | "QA" | "RE" | "RU" | "RW" | "SB" | "SC" | "SH" | "SJ" | "SL" | "SM" | "SN" | "SO" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TC" | "TD" | "TG" | "TJ" | "TK" | "TL" | "TM" | "TO" | "TT" | "TV" | "TW" | "TZ" | "UG" | "UZ" | "VA" | "VC" | "VG" | "VI" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZM" | "ZW")
required
GBP-supported ISO 3166-1 alpha-2 country code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_LIST_GBP_POSTSReturn filtered GBP posts for one or more Semrush locations. Requires a Semrush v4 API key and Local Pro or Business. An active Google Business Profile connection is required for each location.

Input Parameters

integer
Maximum posts returned.
integer
Starting record offset.
string ("DRAFT" | "SCHEDULED" | "TO_SEND" | "SENDING" | "PUBLISHED" | "FAILED")
Optional post status filter.
array
required
One to 100 Semrush location IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_LIST_GBP_SUGGESTIONSReturn GBP data-change suggestions for one or more active locations. The request fails if any location lacks a GBP connection or is frozen or canceled.

Input Parameters

string ("GBP_USER_EDIT" | "GBP_DATA_MISMATCH")
Suggestion source to include.
integer
Maximum suggestions returned.
integer
Starting record offset.
array
Suggestion workflow statuses to include.
array
required
One to 100 Semrush location IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_LIST_LISTING_MANAGEMENT_LOCATIONSList locations using a v4 key and Local Pro or Business; uses no API units.

Input Parameters

integer
Maximum locations to return; default and max are 50.
boolean
Filter by frozen state; omit to include either state.
integer
Zero-based starting offset; default is 0.
array
Filter by location provisioning status. Accepted values: COMPLETED, PROCESSING, FAILED.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_LIST_LOCATION_CATEGORIESList Semrush Local business categories supported for a country. Requires a v4 key and Local Pro or Business and uses no Standard API units.

Input Parameters

integer
Maximum categories to return; default and max are 1000.
integer
Zero-based starting offset; default is 0.
string ("US" | "AU" | "FR" | "DE" | "GB" | "CA" | "IN" | "ES" | "IT" | "NL" | "BR" | "AT" | "BE" | "DK" | "FI" | "NO" | "PL" | "SE" | "CH" | "JP" | "MX" | "IL" | "NZ" | "SG" | "ZA" | "TR" | "AE" | "HK" | "ID" | "VN" | "PK" | "CO" | "IE" | "BD" | "MY" | "SA" | "RO" | "CL" | "PH" | "PT" | "NG" | "GR" | "TH" | "AR" | "PE" | "KE" | "HU" | "CZ" | "RS" | "NP" | "LT" | "UA" | "BG" | "EC" | "CY" | "HR" | "EE" | "LV" | "IS" | "SK" | "SI" | "AM" | "AD" | "PY" | "GY" | "EG" | "MV" | "UY" | "SR" | "KH" | "BO" | "LA" | "MT" | "PA" | "PR" | "TN" | "DO" | "MN" | "GU" | "VE" | "ME" | "MP")
required
Supported ISO 3166-1 alpha-2 country code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_LIST_LOCATION_IMAGESList location images using a v4 key and Local Pro or Business.

Input Parameters

integer
Maximum images to return; default and max are 50.
integer
Zero-based starting offset; default is 0.
array
Filter by one or more image categories. Accepted values: PHOTO, PROFILE, COVER.
string
required
Unique Semrush Local location identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_LIST_LOCATION_LISTINGSGet directory listings using a v4 key and Local Pro or Business.

Input Parameters

string
required
Unique Semrush Local location identifier.
array
Filter by one or more listing connection statuses. Accepted values: CONNECTED, SUBMITTED, UNAVAILABLE, DISCONNECTED, PROCESSING.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_LIST_LOCATION_PAYMENT_OPTIONSGet payment options using a v4 key and Local Pro or Business.

Input Parameters

string
required
Unique Semrush Local location identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_LIST_REVIEWSReturn a filtered, paginated list of reviews for a Semrush location. Requires a Semrush v4 API key, Local Pro or Business, and a GBP connection.

Input Parameters

integer
Maximum reviews returned.
integer
Starting record offset.
array
Star ratings to include. Accepted values: 0, 1, 2, 3, 4, 5.
boolean
Filter by reply status.
string
required
Location whose reviews should be returned.
boolean
Filter by automatic-reply status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_MAP_RANK_TRACKER_COLLECT_CAMPAIGNStart a data-collection mutation that creates a new campaign report. This consumes Map Rank Tracker credits equal to points multiplied by keywords. Requires a Semrush v4 API key with Read and write permission. Map-specific docs say no special subscription or Standard API units are required; the general API FAQ still requires an eligible subscription.

Input Parameters

string
required
Unique campaign ID.
string
Optional ISO-8601 timestamp to associate with the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_MAP_RANK_TRACKER_CREATE_CAMPAIGNCreate persistent Map Rank Tracker campaign data. Requires a Semrush v4 API key with Read and write permission. Map-specific docs say no special subscription or Standard API units are required; the general API FAQ still requires an eligible subscription.

Input Parameters

string
Custom campaign name.
array
Custom tracking points; cannot be combined with grid settings.
array
required
One to 100 keywords, each containing at most 255 characters.
string
required
Google Place ID of the business to track.
object
Grid-generation settings; cannot be combined with points.
object
Automatic collection schedule; omission selects manual collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_MAP_RANK_TRACKER_DELETE_CAMPAIGNPermanently delete a campaign and all its collected data. This destructive mutation cannot be undone. Requires a Semrush v4 API key. Requires Read and write permission. Map-specific docs say no special subscription or Standard API units are required; the general API FAQ still requires an eligible subscription.

Input Parameters

string
required
Unique campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_MAP_RANK_TRACKER_GET_CAMPAIGNGet one Map Rank Tracker campaign without consuming API units. Requires a Semrush v4 API key. Map-specific docs say no special subscription or Standard API units are required; Semrush’s general API FAQ still requires an eligible subscription.

Input Parameters

string
required
Unique campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_MAP_RANK_TRACKER_GET_HEATMAPGet a campaign heatmap for one keyword and report timestamp. Requires a Semrush v4 API key. Map-specific docs say no special subscription or Standard API units are required; the general API FAQ still requires an eligible subscription.

Input Parameters

array
Google Place IDs; provide these or google_business_id.
string
required
Unique keyword ID.
string
required
Unique campaign ID.
string
required
ISO-8601 campaign report timestamp used to rank competitors.
string
Google business ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_MAP_RANK_TRACKER_GET_KEYWORD_STATUSESGet campaign keyword statuses for the latest or a specified report. Requires a Semrush v4 API key. Map-specific docs say no special subscription or Standard API units are required; the general API FAQ still requires an eligible subscription.

Input Parameters

string
required
Unique campaign ID.
string
Report timestamp; the latest report is used when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_MAP_RANK_TRACKER_GET_METRICSGet average-position and share-of-voice history for one keyword. Requires a Semrush v4 API key. Map-specific docs say no special subscription or Standard API units are required; the general API FAQ still requires an eligible subscription.

Input Parameters

array
Google Place IDs; provide these or google_business_id.
string
required
Unique keyword ID.
string
required
Unique campaign ID.
string
Google business ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_MAP_RANK_TRACKER_GET_USER_LIMITSGet campaign-slot and monthly Map Rank Tracker credit limits. Requires a Semrush v4 API key. Map-specific docs say no special subscription or Standard API units are required; the general API FAQ still requires an eligible subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_MAP_RANK_TRACKER_LIST_CAMPAIGNSList and filter Map Rank Tracker campaigns without consuming API units. Requires a Semrush v4 API key. Map-specific docs say no special subscription or Standard API units are required; the general API FAQ still requires an eligible subscription.

Input Parameters

integer
Zero-based page index.
integer
Number of campaigns per page.
string ("createdAt,ASC" | "createdAt,DESC" | "businessName,ASC" | "businessName,DESC")
Campaign sort field and direction.
string
Campaign-name or business-address search query.
boolean
Return only campaigns scheduled for removal when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_MAP_RANK_TRACKER_LIST_TOP_COMPETITORSGet a paginated competitor ranking for one keyword and report. Requires a Semrush v4 API key. Map-specific docs say no special subscription or Standard API units are required; the general API FAQ still requires an eligible subscription.

Input Parameters

integer
Zero-based page index.
integer
Number of competitors per page.
string ("averagePosition,ASC" | "averagePosition,DESC" | "name,ASC" | "name,DESC" | "rating,ASC" | "rating,DESC" | "reviewNumber,ASC" | "reviewNumber,DESC" | "shareOfVoice,ASC" | "shareOfVoice,DESC")
Competitor sort field and direction.
string
required
Unique keyword ID.
string
required
Unique campaign ID.
string
required
ISO-8601 heatmap report timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_MAP_RANK_TRACKER_UPDATE_CAMPAIGNMutate selected settings of an existing Map Rank Tracker campaign. Provide at least one of keywords, name, grid_settings, points, or collecting_frequency. Requires a Semrush v4 API key with Read and write permission. Map-specific docs say no special subscription or Standard API units are required; the general API FAQ still requires an eligible subscription.

Input Parameters

string
Replacement campaign name; provide this or another update field.
array
Replacement custom points; cannot be combined with grid_settings. Provide this or another update field.
array
Replacement keywords; each may contain at most 255 characters. Provide this or at least one other campaign update field.
string
required
Unique campaign ID.
object
Replacement grid settings; cannot be combined with points. Provide this or another update field.
object
Fields of the automatic collection schedule to update. Provide this or at least one other campaign update field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_ORGANIC_RESULTSDEPRECATED: Semrush has deprecated this v3 report; no v4 equivalent exists. 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.

Input Parameters

string
required
Keyword or phrase to get Google’s top 100 organic search results for.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Regional database to query (e.g., ‘us’ for United States).
string
Date in ‘YYYYMM15’ format (e.g., ‘20231215’) for historical data of a past month; day must be ‘15’. Omit for most recent data.
integer
Maximum number of results. API defaults to 10,000 if set to 0 or omitted by client. Max is 100,000.
integer ("0" | "1")
Set to 1 for a plain URL-decoded response string, 0 for URL-encoded.
integer ("0" | "1")
Set to 1 to wrap output columns in double quotation marks (”), 0 to not wrap.
integer
Number of initial results to skip for pagination. Use with display_limit for results beyond the initial fetch.
array
List of column codes to include. See ExportColumnsEnum for codes. Defaults to all columns if omitted.
string ("organic" | "all")
Type of search results: ‘organic’ for traditional results, or ‘all’ to include SERP Features. If ‘all’, ‘Pt’ column indicates SERP feature code or ‘-1’ for organic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_PAID_RESULTSDEPRECATED: Semrush has deprecated this v3 report; no v4 equivalent exists. Fetches domains ranking in Google’s paid search results (AdWords) for a specified keyword and regional database.

Input Parameters

string
required
Keyword or phrase to analyze for paid search results.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Semrush regional database code (e.g., ‘us’ for United States, ‘gb’ for United Kingdom).
string
Date in YYYYMM15 format (e.g., ‘20231215’) for historical data of a specific month; if omitted, returns most recent data.
integer
Maximum number of results to return.
integer ("0" | "1")
Set to 0 for URL-encoded response data, or 1 to preserve special characters (non-URL-encoded).
integer ("0" | "1")
Set to 1 to wrap report columns in double quotes, or 0 to disable.
integer
Number of results to skip from the beginning, for pagination.
array
List of column codes to include (e.g., Dn for Domain, Ur for URL, Vu for a context-specific value). Defaults to all (Dn, Ur, Vu) if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_PHRASE_QUESTIONSDEPRECATED: Semrush has deprecated this v3 report; no v4 equivalent exists. 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.

Input Parameters

string
required
Keyword or phrase to investigate for related questions.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Semrush regional database (e.g., ‘us’, ‘gb’). See Semrush documentation for the full list.
string ("nq_asc" | "nq_desc" | "cp_asc" | "cp_desc" | "co_asc" | "co_desc" | "nr_asc" | "nr_desc" | "kd_asc" | "kd_desc")
Column and order for sorting results (e.g., ‘nq_desc’ for descending by Nq).
integer
Maximum number of results to return.
integer ("0" | "1")
Set to 0 for URL-encoded response data; 1 for unconverted data.
integer ("0" | "1")
Set to 1 to wrap report columns in double quotation marks (”); 0 to disable.
array
Column identifiers (from PhraseQuestionsFilterType) for filtering; refer to Semrush API documentation for behavior.
integer
Number of results to skip for pagination.
array
Columns from PhraseQuestionsExportColumns to include in the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_PLA_COMPETITORSRetrieves domains competing with a specified domain in Google’s Product Listing Ads (PLA) from a given Semrush regional database.

Input Parameters

string
required
The domain name of the website to investigate (e.g., ‘example.com’).
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
The Semrush regional database to query (e.g., ‘us’, ‘uk’, ‘ca’).
string ("np_asc" | "np_desc" | "cr_asc" | "cr_desc")
Specifies the sorting criteria for the results. Options include sorting by ‘Np’ (Number of PLA Keywords) or ‘Cr’ (Common Keywords count), in ‘asc’ (ascending) or ‘desc’ (descending) order.
integer
The maximum number of results to return in the response. Use with display_offset for comprehensive data retrieval.
integer ("0" | "1")
Determines if the response string is URL-encoded. Set to 0 for URL-encoded output, 1 for a non-converted (raw) string.
integer ("0" | "1")
Controls whether report columns are wrapped in double quotation marks. Set to 1 to enable wrapping, 0 to disable.
integer
The starting position of the results to fetch, effectively skipping this number of initial results. Used for pagination when display_limit is less than the total number of available results.
array
Specifies which data columns to include in the report. Available column codes: ‘Dn’ (Domain Name), ‘Cr’ (Common Keywords), ‘Np’ (Number of PLA Keywords), ‘Sh’ (PLA Keywords), ‘Ad’ (Number of PLA Ads), ‘At’ (PLA Ad Titles), ‘Ac’ (PLA Ad Copies), ‘Or’ (Organic Keywords).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_PLA_COPIESFetches Product Listing Ad (PLA) copies that Semrush observed for a domain in Google’s paid search results.

Input Parameters

string
required
Domain to investigate for PLA copies.
string ("us" | "uk" | "ca" | "ru" | "de" | "fr" | "es" | "it" | "br" | "au" | "ar" | "be" | "ch" | "dk" | "fi" | "hk" | "ie" | "il" | "mx" | "nl" | "no" | "pl" | "se" | "sg" | "tr" | "jp" | "in" | "hu" | "af" | "al" | "dz" | "ao" | "am" | "at" | "az" | "bh" | "bd" | "by" | "bz" | "bo" | "ba" | "bw" | "bn" | "bg" | "cv" | "kh" | "cm" | "cl" | "co" | "cr" | "hr" | "cy" | "cz" | "cd" | "do" | "ec" | "eg" | "sv" | "ee" | "et" | "ge" | "gh" | "gr" | "gt" | "gy" | "ht" | "hn" | "is" | "id" | "jm" | "jo" | "kz" | "kw" | "lv" | "lb" | "lt" | "lu" | "mg" | "my" | "mt" | "mu" | "md" | "mn" | "me" | "ma" | "mz" | "na" | "np" | "nz" | "ni" | "ng" | "om" | "py" | "pe" | "ph" | "pt" | "ro" | "sa" | "sn" | "rs" | "sk" | "si" | "za" | "kr" | "lk" | "th" | "bs" | "tt" | "tn" | "ua" | "ae" | "uy" | "ve" | "vn" | "zm" | "zw" | "ly" | "mobile-us" | "mobile-uk" | "mobile-ca" | "mobile-de" | "mobile-fr" | "mobile-es" | "mobile-it" | "mobile-br" | "mobile-au" | "mobile-dk" | "mobile-mx" | "mobile-nl" | "mobile-se" | "mobile-tr" | "mobile-in" | "mobile-id" | "mobile-il" | "il-ext" | "tr-ext" | "dk-ext" | "no-ext" | "se-ext" | "fi-ext" | "ch-ext" | "mobile-il-ext" | "pa" | "pk" | "tw" | "qa")
required
Regional database to query (e.g., ‘us’, ‘gb’, ‘de’).
string ("pr_asc" | "pr_desc" | "pc_asc" | "pc_desc")
Sort order for results. ‘pr’ is Price, ‘pc’ is Position Change.
integer
Number of results to return. Up to 100,000 results can be retrieved in a single call without offset. For more, use with display_offset.
integer ("0" | "1")
If 0, response is URL-encoded; 1 for decoded response.
integer ("0" | "1")
If 1, wraps report columns in double quotes (”); 0 disables.
array
Columns to filter on (‘Tt’: Title, ‘Pr’: Price). Filter conditions depend on API implementation.
integer
Results to skip. When used, display_limit should be display_offset + (number of results per page, up to 100k), not exceeding 4,000,000 total for display_limit.
array
Specific columns for the report. If empty or omitted, all columns are returned. Available: ‘Tt’ (Title), ‘Pr’ (Price), ‘Ur’ (URL), ‘Pc’ (Position Change), ‘Un’ (Number of Keywords), ‘Ts’ (Timestamp).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_REFERRING_DOMAINSDEPRECATED: Please use ‘SEMRUSH_V4_REFERRING_DOMAINS’ instead. Retrieves a semicolon-delimited text report listing domains that link to a target, with options to filter by type (not value). Parse with sep=’;’ and cast numeric columns (e.g., backlinks_num, domain_ascore) before aggregating.

Input Parameters

string
required
The target URL, domain, or root domain to analyze for referring domains.
string ("root_domain" | "domain" | "url")
required
Type of the target.
string ("domain_ascore_asc" | "domain_ascore_desc" | "backlinks_num_asc" | "backlinks_num_desc" | "last_seen_asc" | "last_seen_desc" | "first_seen_asc" | "first_seen_desc")
Column and order for sorting results.
integer
Maximum number of referring domains to return. A value of 0 is also treated as 10,000.
array
Filter types to apply (e.g., ‘newdomain’, ‘country’). This specifies the types of filters, not the filter values themselves (e.g., a specific country code).
integer
Number of initial results to skip. Consider adjusting display_limit if using an offset. Use with display_limit to paginate through large result sets (default limit is 10,000 rows).
array
Columns to include in the report. All available columns are returned if empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_REFERRING_DOMAINS_BY_COUNTRYDEPRECATED: Semrush has deprecated this v3 report; no v4 equivalent exists. Generates a CSV report detailing the geographic distribution of referring domains (by country, determined via IP address) for a specified, publicly accessible target.

Input Parameters

string
required
Domain, subdomain, or URL to analyze for its referring domains by country.
string ("root_domain" | "domain" | "url")
required
Specifies the type of the provided target.
string ("domains_num_asc" | "domains_num_desc" | "backlinks_num_asc" | "backlinks_num_desc")
Sorting order for the results.
integer
Maximum number of results to return.
integer
Number of initial results to skip.
array
Columns to include in the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_REFERRING_I_PSDEPRECATED: Please use ‘SEMRUSH_V4_REFERRING_IPS’ instead. Fetches IP addresses that are sources of backlinks for a specified target domain, root domain, or URL.

Input Parameters

string
required
The target URL, domain, or root domain for which to retrieve referring IPs data.
string ("root_domain" | "domain" | "url")
required
The type of target to analyze. Choose ‘root_domain’ for the main domain, ‘domain’ for a specific subdomain, or ‘url’ for a particular URL.
string ("domains_num_asc" | "domains_num_desc" | "backlinks_num_asc" | "backlinks_num_desc" | "first_seen_asc" | "first_seen_desc" | "last_seen_asc" | "last_seen_desc")
The column and order by which to sort the results. For example, ‘backlinks_num_desc’ sorts by the number of backlinks in descending order.
integer
The maximum number of referring IPs to return in the response. If set to 0 or not specified, the default is 10,000. When using display_offset, this limit applies to the number of results after the offset.
integer
The number of results to skip from the beginning of the list. If this parameter is used, the display_limit value might need to be adjusted to retrieve the desired number of results after the offset. For instance, to get results 101-200, set display_offset to 100 and display_limit to 100.
array
A list of columns to include in the report. If not specified, all default columns will be returned. Available columns: ‘ip’, ‘country’, ‘domains_num’, ‘backlinks_num’, ‘first_seen’, ‘last_seen’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_TLD_DISTRIBUTIONDEPRECATED: Semrush has deprecated this v3 report; no v4 equivalent exists. 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.

Input Parameters

string
required
The target for which to retrieve TLD distribution data. This can be a root domain (e.g., ‘example.com’), a subdomain (e.g., ‘blog.example.com’), or a specific URL (e.g., ‘https://example.com/path’).
string ("root_domain" | "domain" | "url")
required
Type of the target being analyzed.
string ("domains_num_asc" | "domains_num_desc" | "backlinks_num_asc" | "backlinks_num_desc")
Sorting criteria for the TLD distribution results.
integer
Maximum number of results to return. If 0 is provided, the default limit of 10,000 will be applied.
integer
Number of results to skip from the start. For Semrush API compatibility when using offset, display_limit may need to be desired_limit + offset.
array
Columns to include in the report. If omitted or empty, all columns (zone, domains_num, backlinks_num) are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_UPDATE_GBP_POSTUpdate a DRAFT, SCHEDULED, or TO_SEND GBP post. Only fields named by update_mask are changed. Requires EDIT or OWNER rights; frozen or canceled locations cannot be updated.

Input Parameters

string ("DRAFT" | "SCHEDULED" | "TO_SEND")
New mutable post status.
string
New post text.
string
required
Post to update.
array
Zero or one public post image URL.
string
required
Location associated with the post.
array
required
One or more body fields to update.
object
New post button configuration.
string
UTC publication time; required only for SCHEDULED posts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_UPDATE_LISTING_MANAGEMENT_LOCATIONPatch selected fields on a Semrush Listing Management location. Use the validation action to check an update without applying it. Requires a v4 key with Read and write permission and Local Pro or Business. This family does not consume Standard API units.

Input Parameters

string
Postal or ZIP code. Required for US, AU, FR, DE, GB, CA, IN, ES, IT, NL, BR, AT, BE, DK, FI, NO, PL, SE, CH, JP, MX, IL, NZ, SG, ZA, TR, ID, VN, PK, CO, IE, BD, MY, SA, RO, CL, PH, PT, NG, GR, TH, AR, PE, KE, HU, CZ, RS, NP, LT, UA, BG, EC, CY, HR, EE, LV, IS, SK, SI, AM, AD, PY, EG, MV, UY, KH, LA, MT, PA, PR, TN, DO, MN, GU, VE, ME, MP.
string
City or locality, up to 64 characters.
string
Highest postal administrative subdivision. Required for CA, AU, BR, IN, and US; must not be supplied for other countries.
string ("US" | "AU" | "FR" | "DE" | "GB" | "CA" | "IN" | "ES" | "IT" | "NL" | "BR" | "AT" | "BE" | "DK" | "FI" | "NO" | "PL" | "SE" | "CH" | "JP" | "MX" | "IL" | "NZ" | "SG" | "ZA" | "TR" | "AE" | "HK" | "ID" | "VN" | "PK" | "CO" | "IE" | "BD" | "MY" | "SA" | "RO" | "CL" | "PH" | "PT" | "NG" | "GR" | "TH" | "AR" | "PE" | "KE" | "HU" | "CZ" | "RS" | "NP" | "LT" | "UA" | "BG" | "EC" | "CY" | "HR" | "EE" | "LV" | "IS" | "SK" | "SI" | "AM" | "AD" | "PY" | "GY" | "EG" | "MV" | "UY" | "SR" | "KH" | "BO" | "LA" | "MT" | "PA" | "PR" | "TN" | "DO" | "MN" | "GU" | "VE" | "ME" | "MP")
ISO 3166-1 alpha-2 country code supported by Semrush Local.
array
Additional weekly schedules by more-hours type.
object
Business latitude and longitude.
string
Business description, documented as 10 to 750 characters.
string
required
Unique identifier of the location to update.
string
Future reopening date in YYYY-MM-DD format.
array
required
Non-empty list of fields to update; include matching values in the request. Accepted values: business_name, address_line_1, address_line_2, city, zip, phone_number, category_ids, region, featured_message, featured_message_url, website_url, description, instagram_username, twitter_username, business_hours, special_hours, service_area_places, suppress_address, coordinates, youtube_video, reopen_date, payment_options, more_hours, gbp_category_ids, gbp_attributes.
string
Public business website, up to 255 characters.
array
Up to 10 Semrush Local category IDs; the first is primary.
string
Primary phone number in international format, for example +49 351 8629318 or +1 541-754-3010.
string
Official public business name, up to 125 characters.
array
Date-specific exceptional business hours.
string
YouTube video URL, up to 150 characters.
string
Street address, up to 190 characters.
string
Supplemental address, up to 64 characters.
object
Regular weekly business hours.
array
Category-specific Google Business Profile attributes.
array
Payment option IDs returned by Get Location Payment Options.
Promotional profile message, up to 50 characters.
array
Up to 10 GBP category IDs; the first is primary.
boolean
Whether to hide the address; service areas must then be populated.
string
X (formerly Twitter) handle, up to 15 characters.
string
Instagram handle, up to 30 characters.
array
Places served by a service-area business.
Call-to-action URL, up to 255 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_UPDATE_LOCATION_IMAGEReplace a location image caption using a read-write v4 key and Local Pro or Business.

Input Parameters

string
required
Unique identifier of the image to update.
string
required
Replacement image caption, up to 255 characters; the only mutable field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_UPDATE_REVIEW_AUTO_REPLY_CONFIGReplace all review auto-reply settings for a location. This mutation is a full replacement: fields omitted by the caller are reset to the Semrush defaults represented by the request model, rather than left unchanged. Enabling settings can publish future replies automatically. Requires a Semrush v4 API key with Read and write permission, Local Pro or Business, and a GBP connection.

Input Parameters

string ("FRIENDLY" | "PROFESSIONAL" | "CALM" | "ENERGETIC")
Generated reply tone.
string
required
Location whose settings will be replaced.
string ("SPECIFIC_LANGUAGE" | "REVIEW_LANGUAGE")
Strategy used to select the generated reply language.
string ("AUTO" | "AFRIKAANS" | "ALBANIAN" | "ARABIC" | "ARABIC_EGYPT" | "ARABIC_GULF" | "ARMENIAN" | "AZERBAIJANI" | "ASTURIAN" | "BASQUE" | "BELARUSIAN" | "BENGALI" | "BENGALI_WEST_BENGAL" | "BOSNIAN" | "BRETON" | "BULGARIAN" | "BURMESE" | "CATALAN" | "CHINESE_SIMPLIFIED" | "CHINESE_TRADITIONAL" | "CROATIAN" | "CZECH" | "DANISH" | "DUTCH" | "DUTCH_BELGIUM" | "ENGLISH" | "ENGLISH_AUSTRALIA" | "ENGLISH_CANADA" | "ENGLISH_IRELAND" | "ENGLISH_INDIA" | "ENGLISH_NEW_ZEALAND" | "ENGLISH_SINGAPORE" | "ENGLISH_GB" | "ESTONIAN" | "FAROESE" | "FINNISH" | "FRENCH" | "FRENCH_BELGIUM" | "FRENCH_CANADA" | "FRENCH_SWITZERLAND" | "FRENCH_CREOLE" | "GAELIC" | "GALICIAN" | "GEORGIAN" | "GERMAN" | "GERMAN_AUSTRIA" | "GERMAN_SWITZERLAND" | "GREEK" | "GUJARATI" | "HAITIAN_CREOLE" | "HEBREW" | "HINDI" | "HUNGARIAN" | "ICELANDIC" | "ILOCANO" | "INDONESIAN" | "IRISH" | "ITALIAN" | "JAPANESE" | "JAVANESE" | "KALAALLISUT" | "KANNADA" | "KANURI" | "KAZAKH" | "KHMER" | "KOREAN" | "KYRGYZ" | "LAOTIAN" | "LATVIAN" | "LITHUANIAN" | "LUXEMBOURGISH" | "MACEDONIAN" | "MALAY" | "MALAYALAM" | "MALTESE" | "MAORI" | "MARATHI" | "MONTENEGRIN" | "NAVAJO" | "NEPALI" | "NORTHERN_SAMI" | "NORWEGIAN_BOKMAL" | "ODIA" | "PUNJABI" | "PERSIAN" | "POLISH" | "PORTUGUESE" | "PORTUGUESE_BRAZIL" | "ROMANIAN" | "RUSSIAN" | "SANSKRIT" | "SCOTS" | "SERBIAN" | "SLOVAK" | "SLOVENIAN" | "SPANISH" | "SPANISH_ARGENTINE" | "SPANISH_LATIN_AMERICA" | "SPANISH_MEXICO" | "SPANISH_US" | "SWAHILI" | "SWEDISH" | "TAGALOG" | "TAJIK" | "TAMIL" | "TATAR" | "THAI" | "TURKISH" | "TURKMEN" | "UKRAINIAN" | "URDU" | "UZBEK" | "VIETNAMESE" | "WELSH" | "WESTERN_FRISIAN" | "YIDDISH")
Fixed generated reply language, or AUTO.
boolean
Enable automatic replies for zero- through three-star reviews.
boolean
Enable automatic replies for four- and five-star reviews.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_UPDATE_REVIEW_COMMENTReplace the public text of an editable review comment. This mutation changes a published reply. Requires a Semrush v4 API key and a Local Pro or Business, plus a connected publisher account that permits comment editing.

Input Parameters

string
required
Replacement comment text.
string
required
Review to which the comment belongs.
string
required
Comment to update.
string
required
Location to which the review belongs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_V4_AUTHORITY_SCORE_PROFILEGet the v4 referring-domain authority-score distribution. Select a Semrush connection configured with a v4 API key. format=json returns typed meta and data; format=csv returns raw semicolon-delimited text in csv. The nominal published price is 1 API unit per returned line. This API is in Early Access and currently bills at v3 rates; pricing may change.Instant: Supported on the latest version.Instant pricing: $0.325 per 1,000 API units used

Input Parameters

string
required
Target URL or domain.
string ("ROOT_DOMAIN" | "SUBDOMAIN" | "SUBFOLDER" | "PAGE")
required
Part of the target URL to analyze.
string ("json" | "csv")
Response format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_V4_CREATE_PROJECTCreate a Semrush v4 project for a domain. Select a Semrush connection configured with a v4 Read and write API key. This operation returns typed JSON meta and data; CSV is not supported. Semrush publishes no nominal per-operation unit price for this Projects API operation.

Input Parameters

string
required
Project domain without a protocol.
string
required
Human-readable project name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_V4_DELETE_PROJECTPermanently delete a Semrush v4 project and all associated data. Select a Semrush connection configured with a v4 Read and write API key. This operation returns typed JSON meta and data; CSV is not supported. Semrush publishes no nominal per-operation unit price for this Projects API operation.

Input Parameters

integer
required
Unique project identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_V4_GET_PROJECTGet the full details of one accessible Semrush v4 project. Select a Semrush connection configured with a v4 API key. This operation returns typed JSON meta and data; CSV is not supported. Semrush publishes no nominal per-operation unit price for this Projects API operation.

Input Parameters

integer
required
Unique project identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_V4_INDEXED_PAGESList v4 indexed backlink pages for a URL or domain. Select a Semrush connection configured with a v4 API key. format=json returns typed meta and data; format=csv returns raw semicolon-delimited text in csv. The nominal published price is 40 API units per returned line. This API is in Early Access and currently bills at v3 rates; pricing may change.Instant: Supported on the latest version.Instant pricing: $0.325 per 1,000 API units used

Input Parameters

string
required
Target URL or domain.
integer
Number of results to return.
string ("ROOT_DOMAIN" | "SUBDOMAIN" | "SUBFOLDER" | "PAGE")
required
Part of the target URL to analyze.
array
Indexed-page response fields to return; all fields are returned when omitted.
string
Semrush expression over response fields using AND/OR, parentheses, comparisons, LIKE, or NOT LIKE, for example country = 'US' AND domain_score >= 50.
string ("json" | "csv")
Response format.
integer
Number of rows to skip.
string ("backlinks_count" | "domains_count" | "external_links_count" | "first_seen_at" | "internal_links_count" | "last_seen_at" | "response_code" | "source_title" | "source_url")
Response field used to sort results.
string ("ASC" | "DESC")
Sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_V4_KEYWORD_METRICSGet Semrush v4 SEO and PPC metrics for one keyword and country. Select a Semrush connection configured with a v4 API key. format=json returns typed meta and data; format=csv returns raw semicolon-delimited text in csv. The nominal published price is 20 API units per request. This API is in Early Access and currently bills at v3 rates; pricing may change.Instant: Supported on the latest version.Instant pricing: $0.325 per 1,000 API units used

Input Parameters

string
Monthly snapshot in YYYY-MM format, no earlier than 2012-01.
string ("json" | "csv")
Response format.
string ("AF" | "AL" | "DZ" | "AO" | "AR" | "AM" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BY" | "BE" | "BZ" | "BO" | "BA" | "BW" | "BR" | "BN" | "BG" | "KH" | "CM" | "CA" | "CV" | "CL" | "CO" | "CR" | "HR" | "CY" | "CZ" | "CD" | "DK" | "DO" | "EC" | "EG" | "SV" | "EE" | "ET" | "FI" | "FR" | "GE" | "DE" | "GH" | "GR" | "GT" | "GY" | "HT" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IE" | "IL" | "IT" | "JM" | "JP" | "JO" | "KZ" | "KW" | "LV" | "LB" | "LY" | "LT" | "LU" | "MG" | "MY" | "MT" | "MU" | "MX" | "MD" | "MN" | "ME" | "MA" | "MZ" | "NA" | "NP" | "NL" | "NZ" | "NI" | "NG" | "NO" | "OM" | "PK" | "PA" | "PY" | "PE" | "PH" | "PL" | "PT" | "QA" | "RO" | "RU" | "SA" | "SN" | "RS" | "SG" | "SK" | "SI" | "ZA" | "KR" | "ES" | "LK" | "SE" | "CH" | "TW" | "TH" | "TT" | "TN" | "TR" | "UA" | "AE" | "UK" | "US" | "UY" | "VE" | "VN" | "ZM" | "ZW")
required
Supported ISO 3166-1 alpha-2 country code.
string
required
Keyword to get metrics for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_V4_LIST_PROJECTSList Semrush v4 projects by ownership or sharing scope. Select a Semrush connection configured with a v4 API key. This operation returns typed JSON meta and data; CSV is not supported. Semrush publishes no nominal per-operation unit price for this Projects API operation.

Input Parameters

integer
Maximum projects to return.
string ("OWN" | "ALL" | "SHARED" | "CORPORATE")
Ownership or sharing scope.
integer
Projects to skip before returning results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_V4_REFERRING_DOMAINSList v4 referring domains for a URL or domain. Select a Semrush connection configured with a v4 API key. format=json returns typed meta and data; format=csv returns raw semicolon-delimited text in csv. The nominal published price is 40 API units per returned line. This API is in Early Access and currently bills at v3 rates; pricing may change.Instant: Supported on the latest version.Instant pricing: $0.325 per 1,000 API units used

Input Parameters

string
required
Target URL or domain.
integer
Number of results to return.
string ("ROOT_DOMAIN" | "SUBDOMAIN" | "SUBFOLDER" | "PAGE")
required
Part of the target URL to analyze.
array
Referring-domain response fields to return; all fields are returned when omitted.
string
Semrush expression over response fields using AND/OR, parentheses, comparisons, LIKE, or NOT LIKE, for example country = 'US' AND domain_score >= 50.
string ("json" | "csv")
Response format.
integer
Number of rows to skip.
string ("backlinks_count" | "country" | "domain" | "domain_score" | "first_seen_at" | "ip_address" | "is_follow" | "is_lost" | "is_new" | "last_seen_at")
Response field used to sort results.
string ("ASC" | "DESC")
Sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_V4_REFERRING_IPSList v4 referring IP addresses for a URL or domain. Select a Semrush connection configured with a v4 API key. format=json returns typed meta and data; format=csv returns raw semicolon-delimited text in csv. The nominal published price is 20 API units per returned line. This API is in Early Access and currently bills at v3 rates; pricing may change.Instant: Supported on the latest version.Instant pricing: $0.325 per 1,000 API units used

Input Parameters

string
required
Target URL or domain.
integer
Number of results to return.
string ("ROOT_DOMAIN" | "SUBDOMAIN" | "SUBFOLDER" | "PAGE")
required
Part of the target URL to analyze.
array
Referring-IP response fields to return; all fields are returned when omitted.
string
Semrush expression over response fields using AND/OR, parentheses, comparisons, LIKE, or NOT LIKE, for example country = 'US' AND domain_score >= 50.
string ("json" | "csv")
Response format.
integer
Number of rows to skip.
string ("backlinks_count" | "country" | "domains_count" | "first_seen_at" | "ip_address" | "last_seen_at")
Response field used to sort results.
string ("ASC" | "DESC")
Sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_V4_UPDATE_PROJECTRename a Semrush v4 project. Select a Semrush connection configured with a v4 Read and write API key. This operation returns typed JSON meta and data; CSV is not supported. Semrush publishes no nominal per-operation unit price for this Projects API operation.

Input Parameters

integer
required
Unique project identifier.
string
required
New project name. This is the only mutable project field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_VALIDATE_LISTING_MANAGEMENT_LOCATION_CREATEValidate a Listing Management location payload without creating it or consuming a Local Pro location limit. Supply at least one location body field. Requires a read-write v4 key.

Input Parameters

string
Postal or ZIP code. Required for US, AU, FR, DE, GB, CA, IN, ES, IT, NL, BR, AT, BE, DK, FI, NO, PL, SE, CH, JP, MX, IL, NZ, SG, ZA, TR, ID, VN, PK, CO, IE, BD, MY, SA, RO, CL, PH, PT, NG, GR, TH, AR, PE, KE, HU, CZ, RS, NP, LT, UA, BG, EC, CY, HR, EE, LV, IS, SK, SI, AM, AD, PY, EG, MV, UY, KH, LA, MT, PA, PR, TN, DO, MN, GU, VE, ME, MP.
string
City or locality, up to 64 characters.
string
Highest postal administrative subdivision. Required for CA, AU, BR, IN, and US; must not be supplied for other countries.
string ("US" | "AU" | "FR" | "DE" | "GB" | "CA" | "IN" | "ES" | "IT" | "NL" | "BR" | "AT" | "BE" | "DK" | "FI" | "NO" | "PL" | "SE" | "CH" | "JP" | "MX" | "IL" | "NZ" | "SG" | "ZA" | "TR" | "AE" | "HK" | "ID" | "VN" | "PK" | "CO" | "IE" | "BD" | "MY" | "SA" | "RO" | "CL" | "PH" | "PT" | "NG" | "GR" | "TH" | "AR" | "PE" | "KE" | "HU" | "CZ" | "RS" | "NP" | "LT" | "UA" | "BG" | "EC" | "CY" | "HR" | "EE" | "LV" | "IS" | "SK" | "SI" | "AM" | "AD" | "PY" | "GY" | "EG" | "MV" | "UY" | "SR" | "KH" | "BO" | "LA" | "MT" | "PA" | "PR" | "TN" | "DO" | "MN" | "GU" | "VE" | "ME" | "MP")
ISO 3166-1 alpha-2 country code supported by Semrush Local.
array
Additional weekly schedules by more-hours type.
object
Business latitude and longitude.
string
Business description, documented as 10 to 750 characters.
string
Future reopening date in YYYY-MM-DD format.
string
Public business website, up to 255 characters.
array
Up to 10 Semrush Local category IDs; the first is primary.
string
Primary phone number in international format, for example +49 351 8629318 or +1 541-754-3010.
string
Official public business name, up to 125 characters.
array
Date-specific exceptional business hours.
string
YouTube video URL, up to 150 characters.
string
Street address, up to 190 characters.
string
Supplemental address, up to 64 characters.
object
Regular weekly business hours.
array
Category-specific Google Business Profile attributes.
array
Payment option IDs returned by Get Location Payment Options.
Promotional profile message, up to 50 characters.
array
Up to 10 GBP category IDs; the first is primary.
boolean
Whether to hide the address; service areas must then be populated.
string
X (formerly Twitter) handle, up to 15 characters.
string
Instagram handle, up to 30 characters.
array
Places served by a service-area business.
Call-to-action URL, up to 255 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEMRUSH_VALIDATE_LISTING_MANAGEMENT_LOCATION_UPDATEValidate selected changes to a Listing Management location without applying them. Requires a read-write v4 key and Local Pro or Business.

Input Parameters

string
Postal or ZIP code. Required for US, AU, FR, DE, GB, CA, IN, ES, IT, NL, BR, AT, BE, DK, FI, NO, PL, SE, CH, JP, MX, IL, NZ, SG, ZA, TR, ID, VN, PK, CO, IE, BD, MY, SA, RO, CL, PH, PT, NG, GR, TH, AR, PE, KE, HU, CZ, RS, NP, LT, UA, BG, EC, CY, HR, EE, LV, IS, SK, SI, AM, AD, PY, EG, MV, UY, KH, LA, MT, PA, PR, TN, DO, MN, GU, VE, ME, MP.
string
City or locality, up to 64 characters.
string
Highest postal administrative subdivision. Required for CA, AU, BR, IN, and US; must not be supplied for other countries.
string ("US" | "AU" | "FR" | "DE" | "GB" | "CA" | "IN" | "ES" | "IT" | "NL" | "BR" | "AT" | "BE" | "DK" | "FI" | "NO" | "PL" | "SE" | "CH" | "JP" | "MX" | "IL" | "NZ" | "SG" | "ZA" | "TR" | "AE" | "HK" | "ID" | "VN" | "PK" | "CO" | "IE" | "BD" | "MY" | "SA" | "RO" | "CL" | "PH" | "PT" | "NG" | "GR" | "TH" | "AR" | "PE" | "KE" | "HU" | "CZ" | "RS" | "NP" | "LT" | "UA" | "BG" | "EC" | "CY" | "HR" | "EE" | "LV" | "IS" | "SK" | "SI" | "AM" | "AD" | "PY" | "GY" | "EG" | "MV" | "UY" | "SR" | "KH" | "BO" | "LA" | "MT" | "PA" | "PR" | "TN" | "DO" | "MN" | "GU" | "VE" | "ME" | "MP")
ISO 3166-1 alpha-2 country code supported by Semrush Local.
array
Additional weekly schedules by more-hours type.
object
Business latitude and longitude.
string
Business description, documented as 10 to 750 characters.
string
required
Unique identifier of the location to update.
string
Future reopening date in YYYY-MM-DD format.
array
required
Non-empty list of fields to update; include matching values in the request. Accepted values: business_name, address_line_1, address_line_2, city, zip, phone_number, category_ids, region, featured_message, featured_message_url, website_url, description, instagram_username, twitter_username, business_hours, special_hours, service_area_places, suppress_address, coordinates, youtube_video, reopen_date, payment_options, more_hours, gbp_category_ids, gbp_attributes.
string
Public business website, up to 255 characters.
array
Up to 10 Semrush Local category IDs; the first is primary.
string
Primary phone number in international format, for example +49 351 8629318 or +1 541-754-3010.
string
Official public business name, up to 125 characters.
array
Date-specific exceptional business hours.
string
YouTube video URL, up to 150 characters.
string
Street address, up to 190 characters.
string
Supplemental address, up to 64 characters.
object
Regular weekly business hours.
array
Category-specific Google Business Profile attributes.
array
Payment option IDs returned by Get Location Payment Options.
Promotional profile message, up to 50 characters.
array
Up to 10 GBP category IDs; the first is primary.
boolean
Whether to hide the address; service areas must then be populated.
string
X (formerly Twitter) handle, up to 15 characters.
string
Instagram handle, up to 30 characters.
array
Places served by a service-area business.
Call-to-action URL, up to 255 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not