Semrush

Domain name to investigate for ad copies.

Regional database code.

Sort order for results by ad position.

Maximum number of ad copies to return.

Set 1 for decoded response, 0 for URL-encoded.

Set 1 to wrap report columns in double quotation marks ("), 0 for unescaped.

Ad components to filter on. Supported: Tt (Ad Title), Ds (Ad Description), Vu (Visible URL).

Number of initial ad copies to skip for pagination.

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).

String containing the ad copies report, typically CSV-like.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Domain, root domain, or URL to analyze for its backlink anchor texts.

Specifies if the 'target' is a 'root_domain', 'domain', or 'url'.

Sorting criteria for the report; defaults to `domains_num_desc` (most referring domains first).

Maximum number of anchor text entries to return.

Number of anchor text entries to skip for pagination.

Columns to include in the report; defaults to all available columns if omitted.

Anchor text report data as a CSV-formatted string.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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'.

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').

A string (typically JSON formatted) representing the Authority Score profile. This data details the distribution of referring domains by their Authority Score (0-100), showing the count of domains for each score value that link to the target.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The target for which to retrieve backlink data. This can be a root domain, a subdomain, or a specific URL.

The type of the specified target. Must be one of 'root_domain' (e.g., 'example.com'), 'domain' (e.g., 'sub.example.com', includes subdomains), or 'url' (a specific page address).

Column and order for sorting backlink results.

Maximum number of backlinks to retrieve. If set to 0, it defaults to 10,000. The actual number returned is `max(0, display_limit - display_offset)`.

Filters to apply for refining backlink results (e.g., `['newlink']` for new, `['lostlink']` for lost).

Number of initial backlinks to skip. To get N backlinks after offset O, set `display_offset` to O and `display_limit` to O+N.

Columns to include in the exported backlink data. Defaults to all available columns if not specified. An empty list may result in API-specific default columns or an error.

A CSV-formatted string of backlink data; columns are determined by `export_columns` or API defaults.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The domain (e.g., 'example.com'), subdomain (e.g., 'blog.example.com'), or URL (e.g., 'https://example.com/page') for backlink analysis.

The type of the `target` (e.g., 'root_domain', 'domain', 'url').

Specifies columns for the CSV output. If omitted, all columns from `ExportColumns` are included. For available column names, see the `ExportColumns` enum.

CSV formatted string with the backlinks overview. Columns are determined by `export_columns`; each row represents a backlink.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A list of target domains, subdomains, or URLs for which to retrieve backlink comparison data.

Specifies the type for each corresponding target in 'targets'. Ensure this list aligns with 'targets' in order and count for accurate processing.

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.

Batch comparison data as a raw string, typically JSON formatted. The structure is determined by the requested 'export_columns' and 'targets'.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Up to 100 keywords to analyze, separated by newline characters ('\n'). For a single keyword, no newline character is needed.

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.

Date in "YYYYMM15" format for past month data (e.g., "20231215"); uses most recent data if omitted.

Set to 0 for URL-encoded response, or 1 for plain text (non-converted) response.

Set to 1 to wrap report columns in double quotation marks ("), or 0 to disable.

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.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Keyword, phrase, or expression to investigate for broad matches and alternative search queries.

Regional database for keyword research (e.g., 'us' for United States, 'gb' for United Kingdom).

Date in "YYYYMM15" format (e.g., "20231215") for historical data. If omitted or empty, most recent data is returned.

Column and order to sort results (e.g., 'nq_desc' for Search Volume descending).

Maximum number of results. The API interprets a value of 0 as the default (10,000). Max: 100,000.

If 1 (default), returns a raw text response; 0 for a URL-encoded string.

If 1 (default), wraps CSV columns in double quotes; 0 disables. Applies if output is CSV-like.

Filter conditions for results, from predefined criteria. Behavior depends on API interpretation of these values.

Number of results to skip from the beginning of the list for pagination.

Specific columns to include in the report (e.g., 'Ph' for Phrase). If not specified, all default columns are returned.

The API response data, typically in a text/CSV format, containing the broad match keyword report.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Domain, subdomain, or URL to analyze for category information.

Type of the target being analyzed.

Maximum results to return. Note: if set to 0 (the field's default), the API service will default to returning 10,000 lines.

Number of initial results to skip. To maintain desired fetched records after offset, increase `display_limit` by this value.

List of columns for the output. Defaults to all available columns if this list is empty or not provided.

Text-based table or CSV-formatted string with categories and their 0-1 confidence ratings for the target, sorted by rating descending.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The target URL, domain, or root domain for which to retrieve categories profile data.

Type of the target.

Maximum results to return. If 0 (default), 10,000 lines are returned. Max: 1,000,000.

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`).

Columns to include in the report; defaults to all available columns.

The categories profile data, returned as a text string, typically in CSV format. Each line details a category and the count of referring domains in that category which link to the queried target.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The domain, subdomain, or URL to analyze for competitors.

Type of the target: 'root_domain', 'domain', or 'url'.

Sort order for the competitors list.

Maximum number of competitors to return.

Number of results to skip for pagination.

Columns to include in the CSV report; defaults to all available columns if empty or omitted.

Competitor data in CSV string format, with columns determined by the `export_columns` request parameter.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Domain to investigate (e.g., 'example.com').

Regional database for analysis (e.g., 'us', 'gb'). See Semrush docs for all databases.

Snapshot date for data retrieval in 'YYYYMM15' format (e.g., '20231015'); defaults to latest period if omitted.

Sort column and order. Defaults to common keywords, descending.

Maximum results to return. Use with `display_offset` for >100,000 results.

Set to 0 for URL-encoded response, 1 for no URL-encoding.

Set to 1 to wrap output values in double quotes, 0 to disable.

Number of initial results to skip; for pagination with `display_limit`.

Data columns to include; defaults to all. See `CompetitorsInOrganicSearchExportColumns` for codes.

Competitor data as a string, typically semicolon-separated values. Format affected by `export_decode` and `export_escape`.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Domain name to investigate (e.g., 'example.com').

Regional database to query. For available databases, see Semrush API documentation.

Date for data retrieval (YYYYMM15 for monthly). If unspecified, API uses latest daily ranking data.

Sort column and order. Default: 'np_desc' (Common Paid Keywords, descending). Options: 'np_asc', 'np_desc', 'cr_asc', 'cr_desc'.

Maximum number of results. The API typically returns up to 100,000 per request; use with `display_offset` to retrieve more.

Set to 1 for a decoded response; 0 for a URL-encoded string.

Set to 1 to wrap columns in double quotes ("); 0 to disable.

Number of results to skip. The sum of `display_limit` and `display_offset` must not exceed 4,000,000.

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).

The API response data, typically in a CSV-like string format.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Website name (e.g., 'example.com') to investigate.

Regional database to use (e.g., 'us'). Link: https://developer.semrush.com/api/v3/analytics/basic-docs/#databases

Sort order for results: `cv_asc` (Costs % ascending), `cv_desc` (Costs % descending).

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.

If 1, wraps report columns in double quotation marks ("); if 0, no escaping.

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 %).

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.

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 %).

Raw text response from the API containing the domain advertising history, typically CSV-like, format determined by `export_columns` and `export_escape`.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Domain name to analyze (e.g., 'example.com').

Regional database for analysis (e.g., 'us', 'gb', 'de'). See Semrush API docs for full list.

Date for historical data report in YYYYMM15 format (e.g., '20231015'). If omitted, uses most recent data.

Column and order for sorting results (e.g., 'pc_desc' for traffic share descending).

Maximum number of results to return. For more than 100,000, use with `display_offset`.

Set to 0 for URL-encoded response, 1 for decoded (non-converted) response.

Set to 1 to wrap report columns in double quotation marks ("), 0 to disable.

Columns from `DomainOrganicPagesFilterType` to filter results by. If empty, no column-specific filters are applied.

Number of results to skip (for pagination with `display_limit`).

Columns to include in the report. If omitted, all columns from `DomainOrganicPagesExportColumns` are returned.

Report data as a string (typically CSV), structured by `export_columns` and `export_decode` settings.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The domain name (e.g., example.com) to investigate for organic search keywords.

The regional database to query (e.g., 'us', 'uk', 'de').

Date for keyword data: 'YYYYMM15' for monthly historical, 'YYYYMMDD' for daily (e.g., '20231015', '20231120'). Shows latest daily ranking changes if unspecified.

Column and order for sorting results (e.g., 'po_desc' for position descending).

Set to 1 for daily updates on position changes (last 31 days), or 0 for monthly results. Requires `display_positions` if set to 1.

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.

Set to 1 to wrap report columns in double quotation marks ("); 0 to disable.

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.

Number of initial results to skip for pagination. When used, `display_limit` should be `display_offset` + number of rows for the current page.

Data columns to include. If omitted, all columns from `DomainOrganicSearchKeywordsExportColumns` are requested.

Filter keywords by position changes in Google's top 100: 'new', 'lost', 'rise', or 'fall'.

Type of ranking positions: 'organic' (standard), 'all' (includes SERP features), or 'serp_features' (domain ranks in SERP features).

The organic search keyword data for the specified domain, typically returned in a text-based format (e.g., CSV).

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Domain name to analyze (e.g., 'example.com').

Regional database to query (e.g., 'us', 'gb'). Refer to Semrush API documentation for a complete list.

Date for report generation in YYYYMM15 format (e.g., '20231015'). If not provided, latest available data is used.

Column and order for sorting results (e.g., 'pc_desc' sorts by keyword count descending).

Number of results to return. For fetching over 100,000 results, `display_offset` should be used and `display_limit` may need appropriate adjustment.

Specifies if response data is URL-decoded (`1` for decoded, `0` for URL-encoded string).

Specifies if CSV columns are wrapped in double quotes (`1` to enable, `0` to disable).

Number of initial results to skip for pagination. When using `display_offset`, `display_limit` might need to be increased by the `display_offset` value.

Specific columns for the report (e.g., Ur, Pc, Tr). If omitted, a default set is returned. Consult Semrush API documentation for column definitions.

The report data, typically in a CSV-like plain text format, detailing the organic subdomains, their keywords, and traffic metrics.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Domain name to investigate.

Regional database to query.

Date for data retrieval (YYYYMM15 for monthly, YYYYMMDD for daily). Latest data if unspecified.

Column and order for sorting results.

Maximum number of keywords to return. Use with `display_offset` for pagination.

Set to 0 for URL-encoded response; 1 for non-URL-encoded response.

Set to 1 to wrap report columns in double quotation marks ("); 0 to disable.

Filters to apply using a specific format string: '[+/-]|[column_code]|[operator]|[value]'. Refer to Semrush API documentation for detailed filter syntax and available fields.

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.

Columns to include in the report. All columns returned if unspecified. See `DomainPaidSearchKeywordsExportColumns` for options.

Filter keywords by ranking status ('new', 'lost', 'rise', 'fall') in Google's top 100 paid search results.

Report data as a string, typically CSV. Structure depends on `export_columns` and `export_escape`.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Domain name (e.g., 'example.com') to investigate for PLA search keywords.

Semrush regional database to query (e.g., 'us', 'gb', 'ca').

Column and order for sorting results (e.g., 'po_desc' for position descending).

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.

If 1, decodes URL-encoded response data; if 0, returns data as a raw URL-encoded string.

If 1, wraps report column values in double quotes (e.g., "value"); 0 disables wrapping.

Column names (e.g., 'Ph', 'Tt') for filtering results. Filtering logic is Semrush API-specific; refer to their documentation for details.

Number of results to skip from the beginning of the report, for pagination.

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.

PLA search keywords data from Semrush, typically a raw string in CSV-like format. Structure and content depend on `export_columns` and other request parameters.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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).

Regional database for the query. Refer to `DatabaseEnum` or SEMrush documentation for a complete list.

Report date in YYYYMM15 format (e.g., '20231015') for historical/current data. Latest data used if omitted.

Sorting criteria: 'columnName_direction' (e.g., 'p0_desc'). See `DomainVsDomainSortOrder` for options.

Maximum number of keywords to return. Use with `display_offset` for pagination of large datasets (up to 100,000 results per call is typical).

Controls if the response is URL-decoded. 1: decode response; 0: return URL-encoded string.

Controls if special characters in output are escaped. 1: escape (columns wrapped in \"\"); 0: no escaping.

List of column codes from `DomainVsDomainFilterType` to filter results. Behavior is API-specific.

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.

Columns to include in the report. All default columns are returned if empty. See `DomainVsDomainExportColumns` for codes.

The API response data, typically a string in a table-like format (e.g., CSV-like with lines separated by newlines and columns by semicolons). The structure and encoding depend on parameters like `export_columns`, `export_escape`, and `export_decode`.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The root domain URL (e.g., 'example.com') for which to retrieve historical backlink data.

The type of target. Must be 'root_domain' for this action.

Maximum number of historical data records (lines) to return. If 0 (default), the API backend uses 10,000. Max: 1,000,000.

Number of initial records to skip in the results.

Specifies data columns for the report. Defaults to all: `date`, `backlinks_num`, `domains_num`, `score`.

String of historical data: each line is a monthly record (Unix timestamp, requested metrics), sorted newest to oldest. Columns depend on `export_columns`.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Target URL, domain, or root domain for which to retrieve indexed pages data.

Type of the target.

Sorting criteria for the results.

Maximum number of results to return.

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`).

Specific columns for the report; defaults to all available columns if omitted.

A string containing the report data, typically in a CSV-like format, listing indexed pages and their selected attributes.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The keyword or keyword phrase to analyze for difficulty.

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.

Set to 1 to wrap output columns in double quotes ("), or 0 to disable.

Specifies columns to include in the output (e.g., 'Ph' for Phrase, 'Kd' for Keyword Difficulty). Uses all available columns if omitted.

The raw keyword difficulty report data, typically in CSV format, as returned by the Semrush API.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Keyword or keyword phrase to investigate.

Regional database to query (e.g., 'us', 'gb'); if omitted, data is retrieved from all regional databases.

Set to 1 for a URL-decoded response, 0 for URL-encoded.

Set to 1 to wrap output columns in double quotes, 0 to disable.

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).

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The keyword or keyword phrase to investigate.

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).

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.

If set to 0, the response will be a URL-encoded string. If set to 1 (default), the response will not be URL-encoded.

If set to 1 (default), the report’s columns will be wrapped in double quotation marks ("). Set to 0 to disable.

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).

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Keyword or phrase for historical advertising data analysis.

Regional database to query.

Specifies a past month for data retrieval, formatted as 'YYYYMM15'. If omitted, returns most recent period's data.

Maximum number of results (lines) to return.

Set to 1 for a non-URL-encoded response, 0 for URL-encoded.

Set to 1 to wrap output columns in double quotes, 0 to disable.

Number of results to skip for pagination.

Specific columns to include. If omitted or empty, all columns are returned. See `KeywordsAdsHistoryExportColumns`.

Raw report data string, typically CSV-like, with keyword ads history. Structure depends on API output and `export_escape`.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Keyword or phrase to get Google's top 100 organic search results for.

Regional database to query (e.g., 'us' for United States).

Date in 'YYYYMM15' format (e.g., '20231215') for historical data of a past month; day must be '15'. Omit for most recent data.

Maximum number of results. API defaults to 10,000 if set to 0 or omitted by client. Max is 100,000.

Set to 1 for a plain URL-decoded response string, 0 for URL-encoded.

Set to 1 to wrap output columns in double quotation marks ("), 0 to not wrap.

Number of initial results to skip for pagination. Use with `display_limit` for results beyond the initial fetch.

List of column codes to include. See `ExportColumnsEnum` for codes. Defaults to all columns if omitted.

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.

Raw API response string, typically semicolon-separated values with CR+LF line endings. Structure depends on `export_escape` and `export_columns`.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Keyword or phrase to analyze for paid search results.

Semrush regional database code (e.g., 'us' for United States, 'gb' for United Kingdom).

Date in YYYYMM15 format (e.g., '20231215') for historical data of a specific month; if omitted, returns most recent data.

Maximum number of results to return.

Set to 0 for URL-encoded response data, or 1 to preserve special characters (non-URL-encoded).

Set to 1 to wrap report columns in double quotes, or 0 to disable.

Number of results to skip from the beginning, for pagination.

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.

API response data, usually a CSV-formatted string listing domains in paid search results.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Keyword or phrase to investigate for related questions.

Semrush regional database (e.g., 'us', 'gb'). See Semrush documentation for the full list.

Column and order for sorting results (e.g., 'nq_desc' for descending by Nq).

Maximum number of results to return.

Set to 0 for URL-encoded response data; 1 for unconverted data.

Set to 1 to wrap report columns in double quotation marks ("); 0 to disable.

Column identifiers (from `PhraseQuestionsFilterType`) for filtering; refer to Semrush API documentation for behavior.

Number of results to skip for pagination.

Columns from `PhraseQuestionsExportColumns` to include in the report.

Report data as CSV-like plain text, containing the requested phrase questions.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The domain name of the website to investigate (e.g., 'example.com').

The Semrush regional database to query (e.g., 'us', 'uk', 'ca').

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.

The maximum number of results to return in the response. Use with `display_offset` for comprehensive data retrieval.

Determines if the response string is URL-encoded. Set to 0 for URL-encoded output, 1 for a non-converted (raw) string.

Controls whether report columns are wrapped in double quotation marks. Set to 1 to enable wrapping, 0 to disable.

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.

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).

The competitor data, typically in a CSV-like string format, based on the export parameters.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Domain to investigate for PLA copies.

Regional database to query (e.g., 'us', 'gb', 'de').

Sort order for results. 'pr' is Price, 'pc' is Position Change.

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`.

If 0, response is URL-encoded; 1 for decoded response.

If 1, wraps report columns in double quotes ("); 0 disables.

Columns to filter on ('Tt': Title, 'Pr': Price). Filter conditions depend on API implementation.

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`.

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).

PLA copies data, usually a CSV-formatted string. Columns depend on the `export_columns` request parameter.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The target URL, domain, or root domain to analyze for referring domains.

Type of the `target`.

Column and order for sorting results.

Maximum number of referring domains to return. A value of 0 is also treated as 10,000.

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).

Number of initial results to skip. Consider adjusting `display_limit` if using an offset.

Columns to include in the report. All available columns are returned if empty.

The referring domains report data, typically as a text-based format (e.g., CSV string).

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Domain, subdomain, or URL to analyze for its referring domains by country.

Specifies the type of the provided target.

Sorting order for the results.

Maximum number of results to return.

Number of initial results to skip.

Columns to include in the report.

CSV-formatted report data; each row represents a country and its referring domain statistics.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The target URL, domain, or root domain for which to retrieve referring IPs data.

The type of target to analyze. Choose 'root_domain' for the main domain, 'domain' for a specific subdomain, or 'url' for a particular URL.

The column and order by which to sort the results. For example, 'backlinks_num_desc' sorts by the number of backlinks in descending order.

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.

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.

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'.

A string containing the referring IPs report data, typically in CSV format.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Keyword or phrase to find related terms for.

Regional database code (e.g., 'us', 'gb') for targeting data. See Semrush docs for full list.

Date ('YYYYMM15') for historical data from a specific past month. Omit for most recent.

Sort order for results (e.g., `nq_desc` for search volume descending). See `RelatedKeywordsSortOrder`.

Maximum number of related keywords to return.

If 0, returns URL-encoded string; if 1, returns plain text (typically CSV).

If 1, wraps CSV columns in double quotes; 0 disables.

Filters results by column types (e.g., Ph, Nq, Wc). See `RelatedKeywordsFilterType`. For complex filters, direct API use may be needed.

Number of initial entries to skip, for pagination.

Specifies data columns to include. Available (from `ExportColumnsEnum`): Ph (Keyword text), Nq (Search Volume), Cp (Competitive Density 0-1), Co (CPC in USD), Nr (Number of Results), Td (Trend 12mo), Rr (Relatedness score), Fk (SERP Features), In (Search Intent 0-Nav,1-Com,2-Info,3-Trans), Kd (Keyword Difficulty 0-100).

API response data. Typically CSV, but URL-encoded if `export_decode` in request was 0.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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').

Type of the target being analyzed.

Sorting criteria for the TLD distribution results.

Maximum number of results to return. If 0 is provided, the default limit of 10,000 will be applied.

Number of results to skip from the start. For Semrush API compatibility when using offset, `display_limit` may need to be `desired_limit + offset`.

Columns to include in the report. If omitted or empty, all columns (`zone`, `domains_num`, `backlinks_num`) are returned.

The TLD distribution report data, returned as a string. This string is typically in a structured text format (e.g., CSV-like) where each line represents a TLD and its metrics, based on the `export_columns` requested.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not