Serpstat Integration with SmythOS

Want to build a powerful, automated SEO research engine? Connect Serpstat to SmythOS and empower your agents to perform in-depth keyword research, competitor analysis, and backlink audits automatically.

TL;DR

Securely link your Serpstat account to SmythOS using an API token. Then, use our extensive suite of components to automate every aspect of your SEO and digital marketing research, from finding related keywords to analyzing competitor ad copy.

List of Serpstat Components

Quickly compare Serpstat components by what they do and their key I/O. Click any component name to jump directly to its detailed guide.

Component	Action	What it Does	Inputs	Key Outputs	Use Case
Keyword Overview	Research	Provides a comprehensive overview for a list of keywords.	required keywords	result_data	Getting a quick summary of keyword metrics.
Related Keywords	Research	Retrieves related keywords with their metrics.	required search_question	keyword, volume	Building a topic cluster for content strategy.
Search Suggestions	Research	Provides search suggestions for a requested keyword.	required keyword	result_data	Discovering long-tail search terms.
Keywords Selection	Export	Exports organic keywords for a term to a CSV file.	required keyword	Response	Bulk keyword data analysis.
Export Search Questions And Suggestions	Export	Exports search suggestions and "People Also Ask" data.	required keyword, se	Response	Gathering data for large-scale content planning.
Domain Keywords	Research	Finds keywords a specific domain ranks for.	required domain, se	result_data	Analyzing a competitor's organic keyword strategy.
URL Rank Keywords	Research	Finds all keywords a specific URL ranks for.	required url, se	result_data	Deconstructing a competitor's on-page SEO.
Competitors in OSERP	Research	Lists a domain's main competitors in organic search.	required domain, se	result_data	Identifying who you're up against in the SERPs.
URL Competitors	Research	Returns a list of competing URLs in organic search.	required url, se	result_data	Finding who you compete with for specific topics.
Missing Keywords	Research	Finds keywords competitors rank for, but you don't.	required url, se	result_data	Identifying content gaps and SEO opportunities.
Top Pages By Domain	Research	Returns a site's pages ordered by SEO strength.	required domain	result_data	Identifying a competitor's most valuable pages.
Top Pages By Keyword	Research	Returns pages that rank for the most variations of a keyword.	required keyword	result_urls	Finding top content for a specific topic.
Traffic By URL Mask	Research	Estimates traffic for URLs matching a pattern.	required domain optional urlContains	traffic	Analyzing traffic to a specific blog subfolder.
List Domain URLs	Research	Returns a list of URLs within a domain.	required domain	result_data	Getting a sitemap-like view of a competitor.
Domain History	Research	Provides historical data on a domain's visibility.	required domain, se	result_data	Tracking a domain's SEO performance over time.
Domain Summary	Report	Provides summary information for multiple domains.	required domains	result_data	Quickly comparing key metrics for several domains.
Domain VS Domain	Competitors	Returns common keywords between up to 3 domains.	required domains	result_data	Finding keyword overlap with competitors.
Domains' Unique Keywords	Competitors	Finds unique keywords for domains that another domain lacks.	required domains, minusDomain	result_data	Advanced content gap analysis.
Domain Ads	Research	Returns paid keywords and ad copy for a domain.	required domain, se	result_data	Analyzing a competitor's PPC strategy.
Ads Examples	Research	Retrieves ad copy examples for specific keywords.	required keyword, se	result_data	Researching ad copy for a new campaign.
Paid SERP Competitors By Keyword	Research	Lists PPC competitors for a given keyword.	required query, se	result_data	Identifying top bidders for your target keywords.
Summary Report (Backlinks)	Report	Gets general information about a domain's link profile.	required query, searchType	result_data	A quick overview of a domain's backlink health.
Backlinks Dynamics	Audit	Shows the history of found and lost backlinks.	required query, searchType	result_data	Tracking link building velocity over time.
Domain Rank Distribution	Audit	Shows the quality distribution of referring domains.	required query, searchType	result_data	Assessing the authority of a backlink profile.
TOP-10 Anchors	Audit	Returns the top 10 most used anchor texts.	required domain, searchType	result_data	Checking for a natural anchor text profile.
Top Level Domains Distribution	Audit	Shows the TLD distribution of referring domains.	required domain, searchType	result_data	Analyzing the geographic source of backlinks.
Referring Domains	Audit	Lists all unique domains linking to the analyzed site.	required query, searchType	result_data	Assessing the quality of a site's link profile.
Malicious Domains Donors	Audit	Lists malicious domains linking to your site.	required query	result_data	Identifying potentially harmful backlinks.
Malicious Pages Donors	Audit	Lists malicious pages linking to your site.	required domain, searchType	result_data	Pinpointing specific toxic URLs.
Malicious Domains Acceptors	Audit	Lists malicious domains your site links out to.	required domain	result_data	Auditing your outbound link profile for safety.
Active Backlinks	Audit	Retrieves a list of active backlinks pointing to a domain.	required query, searchType	result_data	Monitoring your link-building efforts.
Lost Backlinks	Audit	Retrieves a list of backlinks that are no longer active.	required query	result_data	Finding link reclamation opportunities.
External Domains	Audit	Lists domains that the analyzed site links out to.	required query	result_data	Analyzing your outbound link strategy.
External Lost Links	Audit	Lists external links from your site that are now broken.	required query	result_data	Fixing broken outbound links.
External Active Links	Audit	Lists active external links from your site.	required domain	result_data	Reviewing all current outbound links.
Anchors	Audit	Gets a list of anchor texts used in backlinks.	required query	result_data	A detailed view of your anchor text profile.
Top Pages (Backlink)	Audit	Lists the pages on a site with the most backlinks.	required query, searchType	result_data	Identifying your most authoritative content.
Links Intersection Summary	Competitors	Shows the number of common referring domains between sites.	required query, intersect	result_data	Quick competitor backlink overlap analysis.
Links Intersection Detailing	Competitors	Lists the specific backlinks from intersecting donors.	required query, intersect	result_data	Finding specific domains that link to competitors.
Create Serpstat Project	Write	Creates a new project in your Serpstat account.	required domain, name	project_id	Setting up a new client or website for tracking.
Delete Serpstat Project	Write	Deletes a project from your Serpstat account.	required project_id	result	Removing an old or completed project.
List Serpstat Projects	Read	Retrieves a list of all your projects in Serpstat.	required id	result_data	Finding a project_id for other operations.
Get Project Settings	Read	Returns the settings for a specific audit project.	required projectId	result	Verifying audit configurations.
Audit Settings Saving	Write	Saves new settings for a site audit project.	required projectId, mainSettings	result	Programmatically configuring a site audit.
Get Project Default Settings	Read	Retrieves the default settings for a project.	required id	result	Checking default audit configurations.
Audit Start	Write	Initiates a site audit for a specified project.	required projectId	reportId	Kicking off a technical SEO audit automatically.
Stop Running Audit	Write	Stops an audit that is currently in progress.	required projectId	result	Halting an audit if needed.
List Audits	Read	Provides a list of all site audits for a project.	required projectId	result	Checking the history of site audits.
Audit Basic Info	Site Audit	Returns basic summary information for an audit report.	required reportId	sdo, progress	Checking the result of a completed audit.
List Report Issues	Site Audit	Lists all issues found in a specific audit report.	required reportId	result_categories	Getting a summary of technical SEO errors.
Issue Elements Data	Site Audit	Lists the specific URLs affected by a single issue.	required reportId, errorName	result_data	Pinpointing pages with a specific error.
Issue Subelements Data	Site Audit	Retrieves sub-elements related to a specific audit issue.	required projectId, reportId	result_data	Getting granular data on complex SEO issues.
List Project Regions	Rank Tracker	Returns the regions configured for a rank tracking project.	required projectId	regions	Checking which countries are being tracked.
List Rank Tracker Projects	Rank Tracker	Get a list of your rank tracking projects.	required id	result_data	Finding a projectId for other operations.
Get SERP History By Keywords	Rank Tracker	Returns historical Google top-100 results for project keywords.	required projectId, projectRegionId	keywords	Tracking ranking changes over time.
List Team Users	Account	Returns a list of all users in your Serpstat team.	required id	result_data	Auditing team access.
Add User To Team	Account	Invites a new user to join your Serpstat team.	required email	success	Automating user provisioning for new team members.
Check Account Balance	Account	Returns the current credit balance on your account.	required id	available_usd	Monitoring API usage and costs.

INFO

Why Integrate Serpstat with Your Agent?

Serpstat is a comprehensive SEO toolkit. Integrating it with SmythOS allows you to build powerful agents that can automate nearly every aspect of SEO research, analysis, and reporting.

• Automate Competitor Analysis: Create agents that run weekly to track your competitors' ranking keywords, new backlinks, and top pages, delivering a competitive intelligence report directly to you.
• Streamline Keyword Research: Build a workflow that takes a single "seed" keyword, uses Related Keywords and Search Suggestions to build a massive list of potential targets, and then filters that list based on volume and competition.
• Automated Content Audits: Use agents to find content gaps by comparing your domain's keywords to your competitors' with the Missing Keywords component, providing a ready-made list of content to create.
• Automate SEO Reporting: Schedule agents to fetch data from Domain History, Backlinks Dynamics, and URL Rank Keywords to build custom, automated reports on your site's SEO performance over time.

Prerequisites

Before you begin, please ensure you have the following:

• An active SmythOS account. (Sign up here).
• A Serpstat account with a subscription plan that includes API access.
• Your Serpstat API Token.

Getting Started With Serpstat

The connection between SmythOS and Serpstat is configured using a secure API Token.

Step 1: Get Your Serpstat API Token

1. Log in to your Serpstat account.
2. Navigate to your Profile Settings.
3. Find the API section.
4. Your API Token will be displayed here. If it's not present, you may need to generate it.
5. Copy the token to your clipboard.

Step 2: Store Your API Token in SmythOS Vault

Your API Token is a sensitive credential. Use the SmythOS Vault to store it securely.

1. In your SmythOS dashboard, navigate to the Vault.
2. Create a new secret and paste your Serpstat API Token as the value. Give it a memorable name, like serpstat_api_token.
3. For more details, see the Vault Documentation.

Step 3: Configure a Serpstat Component

1. In your SmythOS agent graph, drag and drop any Serpstat component.
2. Click the component to open its Settings panel.
3. In the API token field, select the secret you saved in the Vault (e.g., serpstat_api_token).
4. Your connection is now configured for that component.

Heads-up

You must add the API Token from the Vault to each Serpstat component you use. This ensures all your API calls are properly authenticated.

Which Serpstat Component Should I Use?

If you need to…	Target	Use this Component	Why this one?
Find new keyword ideas for a blog post	A seed keyword	Related Keywords	Expands your topic into a list of semantically similar keywords with metrics.
See what your competitor ranks for	A competitor's domain	Domain Keywords	The best way to analyze a competitor's entire organic keyword footprint.
Find easy content opportunities	Your domain and a competitor's	Missing Keywords	Directly shows you what keywords your competitors rank for that you don't.
Check your backlink profile health	Your domain	Active Backlinks	Provides a full list of all current backlinks pointing to your site.
Start a technical SEO audit for a new client	A projectId	Audit Start	Kicks off Serpstat's comprehensive site audit tool programmatically.
Get a quick overview of a domain's stats	A domain	Summary Report	Provides a high-level snapshot of a domain's visibility, traffic, and keywords.

Component Details

This section provides detailed information for each Serpstat component.

Keyword Overview

Provides a comprehensive overview for a list of keywords.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
keywords	array	Yes	An array of keyword strings to analyze.
se	string	Optional	Search engine and region. Default: g_us.

Outputs

Field	Type	Description
result_data	array	An array of overview data for each keyword.
left_lines	integer	Your remaining API requests.

Use Case

An agent takes a list of target keywords for a new campaign and uses this component to get a quick summary of their volume, CPC, and competition level.

Related Keywords

Retrieves related keywords with their metrics and search intent data.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
search_question	string	Yes	The keyword to find related terms for.
search_country	string	Yes	Target country for search data.

Outputs

Field	Type	Description
keyword	string	The related keyword found.
volume	integer	The search volume for the related keyword.
cpc	float	The Cost Per Click for the related keyword.
search-intent	string	User intent classification (e.g., informational).
competition_value	float	The level of advertiser competition.

Use Case

A content strategy agent uses this component to find a list of related keywords, then filters them by high volume and low competition_value to identify easy-win topics.

Search Suggestions

Provides search suggestions for a requested keyword.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
keyword	string	Yes	The search term to analyze.
se	string	Optional	Search engine and region (e.g., g_us). Default: g_us.

Outputs

Field	Type	Description
result_data	array	An array containing search suggestion results.
total	integer	Total number of available results.
left_lines	integer	Your remaining API requests for the day.

Use Case

An agent takes a broad topic like "content marketing" and uses this component to discover what specific long-tail searches users are performing related to it.

Keywords Selection

Exports organic keywords associated with a researched keyword to a CSV file.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
keyword	string	Yes	The keyword to analyze.
se	string	Optional	Search engine and region. Default: g_us.

Outputs

Field	Type	Description
Response	object	The API response, which will contain information about the export task.

Use Case

To perform a deep analysis, an agent uses this component to export thousands of organic keywords related to a core term into a CSV for processing in another tool.

Export Search Questions And Suggestions

Exports search suggestions and questions data to a file.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
keyword	string	Yes	The search term to analyze.
se	string	Yes	Search engine and region. Default: g_us.
withQuestions	boolean	Optional	Include "People Also Ask" questions in the export.

Outputs

Field	Type	Description
Response	object	The API response, containing details about the initiated export task.

Use Case

For a deep-dive content strategy session, an agent exports all search suggestions and questions for a core topic to a CSV for manual review.

Domain Keywords

Finds keywords for which the analyzed domain ranks in the top 100 search results.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
domain	string	Yes	The target domain.
se	string	Optional	Search engine and region.

Outputs

Field	Type	Description
result_data	array	An array of keyword objects the domain ranks for.
total	integer	Total number of ranking keywords found.

Use Case

To kick off a competitor analysis, an agent uses this component to get a full list of a competitor's organic keywords.

URL Rank Keywords

Returns keywords that a specific URL ranks for in the top 100 Google search results.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
url	string	Yes	The target URL to analyze.
se	string	Yes	Search engine and region. Default: g_us.

Outputs

Field	Type	Description
result_data	array	An array of keywords the URL ranks for, including position.
total	integer	Total number of ranking keywords found.

Use Case

An agent analyzes a competitor's top blog post by passing its URL to this component to see all the keywords it ranks for, revealing content optimization strategies.

Competitors in OSERP

Lists a domain's main competitors in the top 20 organic Google search results.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
domain	string	Yes	The target domain.
se	string	Optional	Search engine and region. Default: g_us.

Outputs

Field	Type	Description
result_data	array	An array of competitor domain objects.
left_lines	integer	Your remaining API requests.

Use Case

An agent runs this component monthly to identify new and emerging competitors in the organic search landscape.

URL Competitors

Returns a list of URLs that are competitors to a specific URL in organic search.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
url	string	Yes	The target URL to analyze.
se	string	Yes	Search engine and region. Default: g_us.

Outputs

Field	Type	Description
result_data	array	An array of competitor URL objects.
total	integer	Total number of competitors found.

Use Case

To understand the competitive landscape for a specific blog post, an agent uses this component to find the top-ranking competing articles.

Missing Keywords

Returns keywords that competitors rank for but the given URL does not.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
url	string	Yes	The URL of your page to analyze.
se	string	Yes	Search engine and region. Default: g_us.

Outputs

Field	Type	Description
result_data	array	An array of keyword objects you are missing.

Use Case

A content optimization agent uses this component to find content gaps by comparing your page to a top competitor, generating a list of keywords to add to your article.

Top Pages By Domain

Returns a hierarchical list of a website's pages based on their SEO strength.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
domain	string	Yes	The target domain.
se	string	Optional	Search engine and region. Default: g_us.

Outputs

Field	Type	Description
result_data	array	An array of page objects, ordered by SEO value.
total	integer	The total number of pages found.

Use Case

An SEO agent runs this component on a competitor's site to identify their most powerful pages, which are likely driving the most organic traffic.

Top Pages By Keyword

Returns website pages that rank for the largest number of variations of an analyzed keyword.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
keyword	string	Yes	The keyword to analyze.
se	string	Optional	Search engine and region. Default: g_us.

Outputs

Field	Type	Description
result_urls	array	An array of URL data objects.
keyword	string	The keyword that was analyzed.

Use Case

A content strategist uses this component to find the most comprehensive, top-ranking pages for a given topic to use as reference.

Traffic By URL Mask

Returns information about traffic and keyword count for URLs matching a specific pattern or mask.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
domain	string	Yes	The target domain to analyze.
se	string	Yes	Search engine and region. Default: g_us.
urlContains	string	Optional	A string that must be present in the URL (e.g., /blog/).

Outputs

Field	Type	Description
urls	array	A list of URLs matching the mask.
traffic	integer	The estimated traffic for the matching URLs.

Use Case

An agent analyzes the total traffic for all pages within the /blog/ section of a website to measure the performance of the content marketing efforts.

List Domain URLs

Returns the list of URLs within the analyzed domain and the number of keywords for each URL.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
domain	string	Yes	The target domain.
se	string	Optional	Search engine and region. Default: g_us.

Outputs

Field	Type	Description
result_data	array	An array of URL objects with their keyword counts.
total	integer	Total number of URLs found.

Use Case

An agent gets a sitemap-like overview of a competitor's site structure and identifies which pages are targeting the most keywords.

Domain History

Provides historical data on a domain's number of keywords and visibility.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
domain	string	Yes	The target domain to analyze.
se	string	Yes	Search engine and region.

Outputs

Field	Type	Description
result_data	array	An array of historical data points showing keywords and visibility over time.
total	integer	Total number of historical data points available.

Use Case

An agent tracks a competitor's SEO progress by fetching their domain history quarterly to see trends in keyword growth and overall visibility.

Domain Summary

Provides summary information for an array of domains.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
domains	array	Yes	A list of domain strings to analyze.
se	string	Yes	Search engine and region (e.g., g_us).

Outputs

Field	Type	Description
result_data	array	An array of summary objects, one for each requested domain.

Use Case

An agent gets a quick, high-level comparison of your domain versus three top competitors by passing all four domains to this component.

Domain VS Domain

Returns common keywords between up to 3 domains.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
domains	array	Yes	A list of 2 or 3 domains to compare.
se	string	Yes	Search engine and region.

Outputs

Field	Type	Description
result_data	array	An array of keywords that the specified domains have in common.
total	integer	Total number of common keywords.

Use Case

An agent finds the exact keywords that you and your top competitor both rank for to identify highly contested SERPs.

Domains' Unique Keywords

Returns unique keywords of two domains that a third domain does not rank for.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
domains	array	Yes	A list of domains to analyze.
se	string	Yes	Search engine and region.
minusDomain	string	Yes	The domain to use for exclusion.

Outputs

Field	Type	Description
result_data	array	An array of keywords unique to the domains list and not found for the minusDomain.

Use Case

An agent performs an advanced content gap analysis by finding keywords that two of your competitors rank for, but you (minusDomain) do not.

Paid SERP Competitors By Keyword

Lists PPC competitors for a given keyword.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
query	string	Yes	The search query/keyword.
se	string	Yes	Search engine and region.

Outputs

Field	Type	Description
result_data	array	An array of competitor objects in paid search for the keyword.
left_lines	integer	Your remaining API requests.

Use Case

A marketing agent identifies all the domains bidding on a high-value keyword to understand the competitive pressure in paid search.

Summary Report (Backlinks)

Provides general information and key metrics about a domain's or URL's backlink profile.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
query	string	Yes	The domain or URL to analyze.
searchType	string	Yes	The type of query (e.g., domain, url).

Outputs

Field	Type	Description
result_data	object	An object containing the summary report data.
left_lines	integer	Your remaining API requests.

Use Case

As a first step in a backlink audit, an agent fetches the summary report for a domain to get a high-level overview of its total backlinks and referring domains.

Malicious Pages Donors

Returns a list of links from malicious sites referring to the analyzed domain.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
domain	string	Yes	The target domain.
searchType	string	Yes	The type of search, typically domain.

Outputs

Field	Type	Description
result_data	array	An array of malicious page objects with link details.
total	integer	Total number of malicious pages found.

Use Case

A security agent runs this component to find the exact URLs of toxic backlinks, which can then be added to a disavow file.

Malicious Domains Acceptors

Returns a list of malicious domains that the analyzed domain links out to.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
domain	string	Yes	The target domain to audit.
searchType	string	Optional	The type of search, default is domain.

Outputs

Field	Type	Description
result_data	array	An array of malicious domains your site links to.
total	integer	Total number of malicious acceptor domains found.

Use Case

An agent audits your website's outbound links to ensure you are not linking to any known malicious or spammy domains.

External Domains

Gives you a list of the domains that are linked to from the analyzed site.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
query	string	Yes	The domain or URL to analyze.
searchType	string	Optional	The type of query (domain or url).

Outputs

Field	Type	Description
result_data	array	An array of external domain objects.
total	integer	Total number of external domains linked to.

Use Case

An agent reviews all external domains your site links to, which can be useful for partnership analysis or checking for broken affiliate links.

External Lost Links

Gives you a list of lost external links from a site you analyze (i.e., links that used to point from your site to another, but are now broken).

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
query	string	Yes	The domain or URL to analyze.
searchType	string	Yes	The type of query (domain or url).

Outputs

Field	Type	Description
result_data	array	An array of lost external link objects.
total	integer	Total number of lost external links found.

Use Case

A site maintenance agent runs this component to find and report broken outbound links that need to be fixed.

External Active Links

Lists all active external links pointing from your site to other domains.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
domain	string	Yes	The target domain to analyze.
searchType	string	Yes	The type of search (domain or url).

Outputs

Field	Type	Description
result_data	array	An array of active external link objects.
total	integer	Total number of active external links found.

Use Case

An agent performs a full audit of all outbound links on a website for review.

Anchors

Gives you a list of keywords used as anchors for a site's backlinks.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
query	string	Yes	The domain or URL to analyze.
searchType	string	Optional	The type of query (domain or url).

Outputs

Field	Type	Description
result_data	array	An array of anchor text objects and their usage counts.
total	integer	Total number of unique anchors found.

Use Case

An SEO specialist uses an agent to get a detailed breakdown of a competitor's anchor text strategy.

Top Pages (Backlink)

Gives you a list of the leading pages of the analyzed site by the number of backlinks.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
query	string	Yes	The domain or URL to analyze.
searchType	string	Yes	The type of query (domain or url).

Outputs

Field	Type	Description
result_data	array	An array of page objects, sorted by the number of backlinks.
total	integer	Total number of pages found.

Use Case

An agent identifies a competitor's "link magnet" pages by finding which of their URLs have attracted the most backlinks.

Links Intersection Summary

Shows the number of common referring domains between multiple sites.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
query	string	Yes	The primary domain for comparison.
intersect	string	Yes	Comma-separated list of competitor domains.

Outputs

Field	Type	Description
result_data	array	Summary data of the backlink intersection.
total	integer	Total number of intersecting domains.

Use Case

An agent gets a quick summary of how many of the same websites link to both you and your main competitor.

Links Intersection Detailing

Lists the specific backlinks from the domains that link to multiple analyzed sites.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
query	string	Yes	The primary domain for comparison.
intersect	string	Yes	Comma-separated list of competitor domains.

Outputs

Field	Type	Description
result_data	array	A detailed list of backlinks from the intersecting domains.
total	integer	Total number of intersecting backlinks.

Use Case

After finding common referring domains with the summary component, an agent uses this to get the exact URLs of the pages that link to your competitors, identifying high-value outreach targets.

Issue Categories Statistics

Brings in statistics by issue categories for a specific site audit report.

INFO

This component requires an API Token for authentication.

Inputs

Field	Type	Required	Notes
id	string	Yes	A unique identifier for your request.
reportId	string	Yes	The ID of the audit report.

Outputs

Field	Type	Description
result	array	An array of statistics for each issue category.
Response	object	The raw JSON response from the API.

Use Case

An agent fetches the statistics for a completed audit to create a high-level summary chart for a client report.

Best Practices & Advanced Tips

• Secure Your API Token: Always store your Serpstat API Token in the SmythOS Vault.
• Manage API Lines: Serpstat's API usage is measured in "lines" or requests per day. The left_lines output is crucial for monitoring your consumption. Design agents to be efficient to stay within your plan's limits.
• Use the se Parameter: For accurate, localized data, always specify the search engine and region code (e.g., g_uk for Google UK, g_ca for Google Canada) in your requests.
• Chain Components for Deep Insights: The most powerful workflows combine components. For example, use Domain Keywords to find a competitor's top keyword, then use URL Rank Keywords to see which of their pages ranks for it, and finally use Active Backlinks on that URL to understand why it ranks well.

Troubleshooting Common Issues

• Error: 401 Unauthorized

  • Cause: The API Token is incorrect, invalid, or your Serpstat plan does not include API access.
  • Solution: Verify that the API Token in your SmythOS Vault is correct. Log in to your Serpstat account to confirm your subscription level and that the token is active.

• Error: "You have reached the end of your line limit"

  • Cause: You have exhausted your daily API request quota.
  • Solution: Check the left_lines output on previous successful calls. You must wait for your quota to reset (typically every 24 hours). Consider upgrading your plan for higher limits.

• Empty result_data

  • Cause: The query may genuinely have no data (e.g., a new domain with no keywords), or the se (search engine region) specified has no database for that query.
  • Solution: Double-check your inputs (domain, keyword, se). Test the same query in the Serpstat web application to see if data exists there.

What's Next?

You are now ready to build powerful SEO intelligence workflows with the SmythOS Serpstat Integration!

Consider these ideas:

• Build an Agent That...

  • Creates a "Content Gap Analysis" report. It takes your domain and three competitor domains, uses Domain Keywords on all of them, and then identifies keywords that all three competitors rank for but you do not.
  • Automates outreach prospecting. The agent gets a list of top-ranking articles for a keyword using the URL Rank Keywords component, then finds their contact information using other tools.
  • Monitors for negative SEO. It runs the Lost Backlinks and Malicious Domains Donors components weekly and sends an alert if a significant number of valuable links are lost or new toxic links are found.

• Explore Other Integrations:

  • Combine Serpstat with an LLM component. Use Related Keywords to get a list of topics, then have the LLM write a draft article for the most promising one.
  • Feed the output of your Serpstat reports directly into a Google Sheet to create custom SEO dashboards and track performance over time.
  • When your agent discovers a new, high-authority backlink, post a celebratory message to a Slack or Microsoft Teams channel.