Serpstat SEO Tool
Serpstat SEO Tool · Actions GPT
Serpstat SEO Tool
Discover SEO keywords for a specific topic and analyze SEO metrics/backlink data for a domain with the help of Serpstat.com
GET /keywords/search/Related KeywordsGet a list of related keywords.
GET /domains/summary/SummaryGet a list of SEO metrics, such as organic traffic or the number of keywords in Google, for a domain within a specific country.
GET /domains/link-profile/Link ProfileGet an overview of the backlink profile for the domain.
Schéma original API
{
"openapi": "3.1.0",
"info": {
"title": "Serpstat SEO Tool",
"description": "Discover SEO keywords for a specific topic and analyze SEO metrics/backlink data for a domain with the help of Serpstat.com",
"version": "v1"
},
"servers": [
{
"url": "https://gpts.serpstat.com"
}
],
"paths": {
"/keywords/search/": {
"get": {
"summary": "Related Keywords",
"description": "Get a list of related keywords.",
"operationId": "get_keywords_search",
"security": [
{
"APIKeyHeader": []
}
],
"parameters": [
{
"name": "keyword",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Seed keyword.",
"examples": [
"buy iphone"
],
"title": "Keyword"
},
"description": "Seed keyword.",
"examples": {
"default": {
"value": "buy iphone"
}
}
},
{
"name": "country",
"in": "query",
"required": true,
"schema": {
"type": "string",
"pattern": "^[a-zA-Z]{2}$",
"description": "The two-letter country code entered by the user.",
"examples": [
"us",
"US"
],
"title": "Country"
},
"description": "The two-letter country code entered by the user.",
"examples": {
"lowercase": {
"value": "us"
},
"uppercase": {
"value": "US"
}
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/RelatedKeywordsResponse"
},
{
"$ref": "#/components/schemas/DataNotFound"
}
],
"title": "Response Get Keywords Search"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"520": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnknownError"
}
}
},
"description": "Additional Response"
},
"523": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerpstatApiUnreachable"
}
}
},
"description": "Additional Response"
}
}
}
},
"/domains/summary/": {
"get": {
"summary": "Summary",
"description": "Get a list of SEO metrics, such as organic traffic or the number of keywords\nin Google, for a domain within a specific country.",
"operationId": "get_domains_summary",
"security": [
{
"APIKeyHeader": []
}
],
"parameters": [
{
"name": "domain",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "The domain name entered by the user to be researched.",
"examples": [
"apple.com"
],
"title": "Domain"
},
"description": "The domain name entered by the user to be researched.",
"examples": {
"default": {
"value": "apple.com"
}
}
},
{
"name": "country",
"in": "query",
"required": true,
"schema": {
"type": "string",
"pattern": "^[a-zA-Z]{2}$",
"description": "The two-letter country code entered by the user.",
"examples": [
"us",
"US"
],
"title": "Country"
},
"description": "The two-letter country code entered by the user.",
"examples": {
"lowercase": {
"value": "us"
},
"uppercase": {
"value": "US"
}
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/DomainSummaryResponse"
},
{
"$ref": "#/components/schemas/DataNotFound"
}
],
"title": "Response Get Domains Summary"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"520": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnknownError"
}
}
},
"description": "Additional Response"
},
"523": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerpstatApiUnreachable"
}
}
},
"description": "Additional Response"
}
}
}
},
"/domains/link-profile/": {
"get": {
"summary": "Link Profile",
"description": "Get an overview of the backlink profile for the domain.",
"operationId": "get_domains_link_profile",
"security": [
{
"APIKeyHeader": []
}
],
"parameters": [
{
"name": "domain",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "The domain name entered by the user to be researched.",
"examples": [
"apple.com"
],
"title": "Domain"
},
"description": "The domain name entered by the user to be researched.",
"examples": {
"default": {
"value": "apple.com"
}
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/DomainLinkProfileResponse"
},
{
"$ref": "#/components/schemas/DataNotFound"
}
],
"title": "Response Get Domains Link Profile"
}
}
}
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
},
"description": "Unauthorized"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"520": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnknownError"
}
}
},
"description": "Additional Response"
},
"523": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerpstatApiUnreachable"
}
}
},
"description": "Additional Response"
}
}
}
}
},
"components": {
"schemas": {
"DataNotFound": {
"properties": {
"message": {
"type": "string",
"title": "Message",
"default": "Sorry, there are no results matching your query. Try another query (keyword|domain) or database (country)"
}
},
"type": "object",
"title": "DataNotFound"
},
"DomainLinkProfile": {
"properties": {
"domain": {
"type": "string",
"title": "Domain"
},
"sersptat_domain_rank": {
"type": "integer",
"title": "Sersptat Domain Rank",
"description": "Serpstat Domain Rank (SDR) — an indicator of domain authority."
},
"referring_domains": {
"type": "integer",
"title": "Referring Domains",
"description": "Number of referring domains."
},
"referring_domains_change": {
"type": "integer",
"title": "Referring Domains Change",
"description": "Change in the number of links during the last 7 days."
},
"redirected_domains": {
"type": "integer",
"title": "Redirected Domains",
"description": "Number of referring redirecting domains."
},
"referring_malicious_domains": {
"type": "integer",
"title": "Referring Malicious Domains",
"description": "Number of referring malicious domains."
},
"referring_malicious_domains_change": {
"type": "integer",
"title": "Referring Malicious Domains Change",
"description": "Change in the number of referring malicious domains during the last 7 days."
},
"referring_ip_addresses": {
"type": "integer",
"title": "Referring Ip Addresses",
"description": "Number of referring IP-addresses"
},
"referring_ip_addresses_change": {
"type": "integer",
"title": "Referring Ip Addresses Change",
"description": "Change in the number of referring IP-addresses during the last 7 days."
},
"referring_subnets": {
"type": "integer",
"title": "Referring Subnets",
"description": "Number of referring subnets."
},
"referring_subnets_change": {
"type": "integer",
"title": "Referring Subnets Change",
"description": "Change in the number of referring subnets during the last 7 days."
},
"backlinks": {
"type": "integer",
"title": "Backlinks",
"description": "Number of backlinks."
},
"backlinks_change": {
"type": "integer",
"title": "Backlinks Change",
"description": "Change in the number of backlinks during the last 7 days."
},
"backlinks_from_mainpages": {
"type": "integer",
"title": "Backlinks From Mainpages",
"description": "Number of backlinks from main pages."
},
"backlinks_from_mainpages_change": {
"type": "integer",
"title": "Backlinks From Mainpages Change",
"description": "Change in the number of backlinks from main pages during the last 7 days."
},
"nofollow_backlinks": {
"type": "integer",
"title": "Nofollow Backlinks",
"description": "Number of nofollow backlinks."
},
"nofollow_backlinks_change": {
"type": "integer",
"title": "Nofollow Backlinks Change",
"description": "Change in the number of nofollow backlinks during the last 7 days."
},
"dofollow_backlinks": {
"type": "integer",
"title": "Dofollow Backlinks",
"description": "Number of dofollow backlinks."
},
"dofollow_backlinks_change": {
"type": "integer",
"title": "Dofollow Backlinks Change",
"description": "Change in the number of dofollow backlinks during the last 7 days."
},
"text_backlinks": {
"type": "integer",
"title": "Text Backlinks",
"description": "Number of text backlinks."
},
"text_backlinks_change": {
"type": "integer",
"title": "Text Backlinks Change",
"description": "Change in the number of text backlinks during the last 7 days."
},
"image_backlinks": {
"type": "integer",
"title": "Image Backlinks",
"description": "Number of image backlinks."
},
"image_backlinks_change": {
"type": "integer",
"title": "Image Backlinks Change",
"description": "Change in the number of image backlinks during the last 7 days."
},
"redirect_backlinks": {
"type": "integer",
"title": "Redirect Backlinks",
"description": "Number of referring redirects."
},
"redirect_backlinks_change": {
"type": "integer",
"title": "Redirect Backlinks Change",
"description": "Change in the number of referring redirects during the last 7 days."
},
"canonical_backlinks": {
"type": "integer",
"title": "Canonical Backlinks",
"description": "Number of backlinks rel=\"canonical\""
},
"canonical_backlinks_change": {
"type": "integer",
"title": "Canonical Backlinks Change",
"description": "Change in the number of backlinks rel=\"canonical\" during the last 7 days."
},
"alternate_backlinks": {
"type": "integer",
"title": "Alternate Backlinks",
"description": "Number of backlinks from tag."
},
"alternate_backlinks_change": {
"type": "integer",
"title": "Alternate Backlinks Change",
"description": "Change in the number of backlinks from tag during the last 7 days."
},
"rss_backlinks": {
"type": "integer",
"title": "Rss Backlinks",
"description": "Number of RSS backlinks."
},
"rss_backlinks_change": {
"type": "integer",
"title": "Rss Backlinks Change",
"description": "Change in the number of RSS backlinks during the last 7 days."
},
"frame_backlinks": {
"type": "integer",
"title": "Frame Backlinks",
"description": "Number of <frame> backlinks."
},
"frame_backlinks_change": {
"type": "integer",
"title": "Frame Backlinks Change",
"description": "Change in the number of <frame> backlinks during the last 7 days."
},
"form_backlinks": {
"type": "integer",
"title": "Form Backlinks",
"description": "Number of <form> backlinks."
},
"form_backlinks_change": {
"type": "integer",
"title": "Form Backlinks Change",
"description": "Change in the number of <form> backlinks during the last 7 days."
},
"external_domains": {
"type": "integer",
"title": "External Domains",
"description": "Number of domains to which the analyzed domain links."
},
"external_domains_change": {
"type": "integer",
"title": "External Domains Change",
"description": "Change in the number of domains to which the analyzed domain links during the last 7 days."
},
"external_malicious_domains": {
"type": "integer",
"title": "External Malicious Domains",
"description": "Number of malicious domains to which the analyzed domain links."
},
"external_malicious_domains_change": {
"type": "integer",
"title": "External Malicious Domains Change",
"description": "Change in the number of malicious domains to which the analyzed domain links during the last 7 days."
},
"external_links": {
"type": "integer",
"title": "External Links",
"description": "Number of links from the analyzed domain."
},
"external_links_change": {
"type": "integer",
"title": "External Links Change",
"description": "Change in the number of links from the analyzed domain during the last 7 days."
}
},
"type": "object",
"required": [
"domain",
"sersptat_domain_rank",
"referring_domains",
"referring_domains_change",
"redirected_domains",
"referring_malicious_domains",
"referring_malicious_domains_change",
"referring_ip_addresses",
"referring_ip_addresses_change",
"referring_subnets",
"referring_subnets_change",
"backlinks",
"backlinks_change",
"backlinks_from_mainpages",
"backlinks_from_mainpages_change",
"nofollow_backlinks",
"nofollow_backlinks_change",
"dofollow_backlinks",
"dofollow_backlinks_change",
"text_backlinks",
"text_backlinks_change",
"image_backlinks",
"image_backlinks_change",
"redirect_backlinks",
"redirect_backlinks_change",
"canonical_backlinks",
"canonical_backlinks_change",
"alternate_backlinks",
"alternate_backlinks_change",
"rss_backlinks",
"rss_backlinks_change",
"frame_backlinks",
"frame_backlinks_change",
"form_backlinks",
"form_backlinks_change",
"external_domains",
"external_domains_change",
"external_malicious_domains",
"external_malicious_domains_change",
"external_links",
"external_links_change"
],
"title": "DomainLinkProfile"
},
"DomainLinkProfileResponse": {
"properties": {
"domain_link_profile": {
"allOf": [
{
"$ref": "#/components/schemas/DomainLinkProfile"
}
],
"description": "Domain backlinks profile overview."
},
"full_report_link": {
"type": "string",
"title": "Full Report Link",
"description": "A link to the full report."
}
},
"type": "object",
"required": [
"domain_link_profile",
"full_report_link"
],
"title": "DomainLinkProfileResponse",
"description": "Domain backlink profile overview and a link to the full report."
},
"DomainSEOMetrics": {
"properties": {
"domain": {
"type": "string",
"title": "Domain"
},
"visible": {
"type": "number",
"title": "Visible",
"description": "Visibility of a domain in top-20 Google. It's a relative indicator, which is calculated as a ratio of the amount and popularity of keywords a domain is shown for."
},
"keywords": {
"type": "integer",
"title": "Keywords",
"description": "Number of keywords found in the chosen search engine."
},
"traff": {
"type": "integer",
"title": "Traff",
"description": "Estimated search traffic based on keyword positions and search volume."
},
"visible_dynamic": {
"type": "number",
"title": "Visible Dynamic",
"description": "Change in visibility since the last monitoring."
},
"keywords_dynamic": {
"type": "integer",
"title": "Keywords Dynamic",
"description": "Change in the number of keywords since the last monitoring."
},
"traff_dynamic": {
"type": "integer",
"title": "Traff Dynamic",
"description": "Traffic change since the last monitoring."
},
"ads_dynamic": {
"type": "integer",
"title": "Ads Dynamic",
"description": "Dynamics of changes in PPC Ads."
},
"new_keywords": {
"type": "integer",
"title": "New Keywords",
"description": "Number of new keywords for the domain since the last monitoring."
},
"out_keywords": {
"type": "integer",
"title": "Out Keywords",
"description": "Number of keywords lost by a domain since the last monitoring."
},
"rised_keywords": {
"type": "integer",
"title": "Rised Keywords",
"description": "Number of domain keywords for which positions have improved since the last monitoring."
},
"down_keywords": {
"type": "integer",
"title": "Down Keywords",
"description": "Number of domain keywords for which positions have dropped since the last monitoring."
},
"ad_keywords": {
"type": "integer",
"title": "Ad Keywords",
"description": "Number of keywords in PPC."
},
"ads": {
"type": "integer",
"title": "Ads",
"description": "Number of PPC Ads."
},
"prev_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Prev Date",
"description": "Previous verification date."
}
},
"type": "object",
"required": [
"domain",
"visible",
"keywords",
"traff",
"visible_dynamic",
"keywords_dynamic",
"traff_dynamic",
"ads_dynamic",
"new_keywords",
"out_keywords",
"rised_keywords",
"down_keywords",
"ad_keywords",
"ads",
"prev_date"
],
"title": "DomainSEOMetrics"
},
"DomainSummaryResponse": {
"properties": {
"domain_summary": {
"items": {
"$ref": "#/components/schemas/DomainSEOMetrics"
},
"type": "array",
"title": "Domain Summary",
"description": "A list of domains with their SEO metrics."
},
"full_report_link": {
"type": "string",
"title": "Full Report Link",
"description": "A link to the full report."
}
},
"type": "object",
"required": [
"domain_summary",
"full_report_link"
],
"title": "DomainSummaryResponse",
"description": "Domain SEO overview report and a link to the full report."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"Keyword": {
"properties": {
"keyword": {
"type": "string",
"title": "Keyword",
"description": "Suggested keyword."
},
"cpc": {
"type": "number",
"title": "Cpc",
"description": "Cost per click, $."
},
"competition": {
"type": "integer",
"title": "Competition",
"description": "Keyword competition in the PPC (0-100%)."
},
"serp_difficulty": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Serp Difficulty",
"description": "The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 0 to 100)."
},
"search_volume": {
"type": "integer",
"title": "Search Volume",
"description": "Search volume in a selected region."
}
},
"type": "object",
"required": [
"keyword",
"cpc",
"competition",
"search_volume"
],
"title": "Keyword"
},
"RelatedKeywordsResponse": {
"properties": {
"keywords": {
"items": {
"$ref": "#/components/schemas/Keyword"
},
"type": "array",
"title": "Keywords",
"description": "A list of keywords presented in a table format along with the metrics."
},
"full_report_link": {
"type": "string",
"title": "Full Report Link",
"description": "A link to the full report."
}
},
"type": "object",
"required": [
"keywords",
"full_report_link"
],
"title": "RelatedKeywordsResponse",
"description": "A list of related keywords with metrics and a link to the full report."
},
"SerpstatApiUnreachable": {
"properties": {
"error": {
"type": "string",
"title": "Error",
"default": "Serpstat API is unreachable"
},
"message": {
"type": "string",
"title": "Message",
"default": "The Serpstat API is currently unreachable. Try again later."
}
},
"type": "object",
"title": "SerpstatApiUnreachable"
},
"Unauthorized": {
"properties": {
"error": {
"type": "string",
"title": "Error",
"default": "Not unauthorized"
},
"message": {
"type": "string",
"title": "Message",
"default": "It is not intended to be used directly. Find our Gpt 'Serpstat SEO tool' in https://chat.openai.com/gpts"
}
},
"type": "object",
"title": "Unauthorized"
},
"UnknownError": {
"properties": {
"error": {
"type": "string",
"title": "Error",
"examples": [
"Error from Serpstat API"
]
},
"message": {
"type": "string",
"title": "Message",
"examples": [
"Additional information about the error"
]
}
},
"type": "object",
"required": [
"error",
"message"
],
"title": "UnknownError"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key"
}
}
}
}