Skip to main content
Semrush
Betav1.0.0
20 actions · 1 auth method

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

Uses a per-account API key passed as a query parameter. API units are consumed per request and expire at the end of each…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

20 actions
Action
Description
Get Domain Overview
Get overview metrics for a domain across all regional databases.
Get Domain Rank
Get domain ranking data in a specific regional database.
List Domain Organic Keywords
List keywords that bring users to a domain via Google’s top 100 organic search results.
List Domain Paid Keywords
List keywords a domain has bid on in paid search results over the last 12 months.
List Domain Organic Competitors
List domains competing with the specified domain in organic search.
List Domain Paid Competitors
List domains competing with the specified domain in paid search.
Get Keyword Overview
Get keyword overview across all regional databases.
Get Keyword Overview (Single Database)
Get keyword overview in a specific regional database.
List Keyword Organic Results
List domains ranking in Google’s top 100 organic results for a keyword.
List Related Keywords
List related keywords for a given keyword.
Get Keyword Difficulty
Get keyword difficulty index for up to 100 keywords.
Get Backlinks Overview
Get backlinks overview summary for a domain, root domain, or URL.
List Backlinks
List backlinks pointing to a domain, root domain, or URL.
List Referring Domains
List referring domains linking to the target.
Get Traffic Summary
Get traffic summary for up to 200 domains.
Get Traffic Sources
Get traffic sources breakdown for a domain.
Get Traffic Top Pages
Get top pages by traffic for a domain.
List Projects
List all projects in the Semrush account.
Get Project
Get details of a specific project by ID.
Get API Units Balance
Get the remaining API units balance for the authenticated account.