URL Report

2.3.1. URL Organic Keywords (url_keywords)

url_keywords —method returns keywords that URL ranks for in Google search results.

Pagination

Following parameters can be used for pagination:

• page_size : number of results per page (default: 100, max: 1000);
• page :  page number (set to the 1st page by default).

You can use the following parameters to filter the results:

To sort the results apply following parameters:

• sort : field that needs to be sorted;
• order : sorting order (asc - ascending, desc -  descending).

Metrics	Description
result	Encapsulates the answer
total	Number of keywords for which the page ranks in top-100
region_queries_count	Search volume in selected search engine database
region_queries_count_wide	Search volume (broad match)
domain	Domain
keyword_length	Number of words divided by space in a keyword
keyword	Query for which an ad is displayed in SERP
url	URL of a page which appears in SERP for the keyword
dynamic	How the position of this keyword has changed
traff	Approximate organic traffic prognosis
keyword_crc	the checksum for a quick search
types	A list of special elements shown in SERP (for example, video, carousel or map)
found_results	The number of results found for ""keywords""
url_crc	CRC code (encryption method)
cost	Cost per click, $
concurrency	Keyword competition in PPC (0-100)
position	Position for a keyword
keyword_id	Keyword ID in our database
subdomain	Subdomain which ranks for the keyword
types	A list of special elements shown in SERP (for example, video, carousel or map)
geo_names	List of toponyms in the array (if toponyms are present in the keywords)
status_msg	Response "OK" or "Error" report on a successful or unsuccessful request
status_code	Response code "200" — successful request. Errors occur when limits are exceeded (number of simultaneous requests or account limits)

Part of the API response, for which 1 limit is charged:

{
"region_queries_count": 10,
"domain": "example.com",
"keyword_length": 2,
"keyword": "site example.com",
"url": "https://example.com/",
"dynamic": null,
"traff": 1,
"found_results": "36500000",
"cost": 0,
"concurrency": 0,
"position": 2,
"subdomain": null,
"region_queries_count_wide": 0,
"types": [

],
"geo_names": [

],
"_id": "239122007-2"
}

2.3.2. List of URLs that compete with a queried page (url_competitors)

url_competitors — method returns the list of URLs that compete with a queried URL in organic search.

Metrics	Description
result	Encapsulates the answer
total	Number of keywords for which URL ranks in top-10
cnt	Number of keywords for which URL ranks in top-10
domain	Competitor's domain
url	Competitor's URL
status_msg	Response "OK" or "Error" report on a successful or unsuccessful request
status_code	Response code "200" — successful request. Errors occur when limits are exceeded (number of simultaneous requests or account limits)
left_lines	Number of remaining API queries

Part of the API response, for which 1 limit is charged:

 {
"cnt": 27,
"domain": "wikipedia.org",
"url": "https://en.wikipedia.org/wiki/Example.com"
}

2.3.3. Competitor's keywords that are missing from a queried page (url_missing_keywords)

url_missing_keywords 

Shows a list of keywords that competitors' URLs rank for in top-10 but that are missing from the queried page.

Pagination

Following parameters can be used for pagination:

• page_size : number of results per page (default: 100, max: 1000)
• page :  page number (set to the 1st page by default)

Metrics	Description
result	Encapsulates the answer
total	Results found
region_queries_count	Search volume in selected search engine database
region_queries_count_wide	Search volume (broad match)
geo_names	List of toponyms in the array (if toponyms are present in the keywords)
types	A list of special elements shown in SERP (for example, video, carousel or map)
cost	Cost per click, $
keyword_id	Keyword ID in our database
keyword	Keyword for which competitor's page rank but target page doesn't rank
concurrency	Keyword competition in PPC (0-100)
weight	Connection strength (How many competitors rank for this keyword)
status_msg	Response "OK" or "Error" report on a successful or unsuccessful request
status_code	Response code "200" — successful request. Errors occur when limits are exceeded (number of simultaneous requests or account limits)
left_lines	Number of remaining API queries

Part of the API response, for which 1 limit is charged:

{
"region_queries_count": 40,
"geo_names": [

],
"types": [
"refine_by_brand",
"also_asks",
"related_search",
"a_box_fsnippet",
"pic"
],
"cost": 13.23,
"region_queries_count_wide": 0,
"keyword": "example domain name",
"concurrency": 67,
"weight": 7
}

2.3.4. URL keywords V4 (SerpstatUrlProcedure.getUrlKeywords)

SerpstatUrlProcedure.getUrlKeywords — this method brings in top keywords in the search engine for the given URL.

Request parameters:

Parameter	Description	Type	Optional	Default value	Value Options
url	URLs	string	no		https://allo.ua/
se	ID of the search base to be searched	string	no		g_ua, g_ru, ...
filters	Filter conditions	array	yes	{"top_size": 100}	{ "cost_from": "0.1", "cost_to": "3" }
sort	Sort order the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending)	array	yes	[ ] empty array	"sort": {"cnt": "asc"}
page	Page number in response	int	yes	1	5
size	Number of results per page in response	int	yes	100	"size": {{page_size}}   min: 1, max: 1000

Sorting results is possible by the following fields:

Parameter

region_queries_count

cost

keyword_length

concurrency

difficulty

traff

region_queries_count_wide

dynamic

position

found_results

To filter the results, use the following parameters:

Parameter	Description	Possible values
position_from	Min keyword position	1-100
position_to	Max keyword position	1-100
queries_from	Min volume of monthly searches	0-100000000
queries_to	Max volume of monthly searches	0-100000000
cost_from	Min CPC	0-200
cost_to	Max CPC	0-200
concurrency_from	Min competition value	0-100
concurrency_to	Max competition value	0-100

Response metrics:

Metrics	Description
result	Contains the answer
total	Number of found keywords ranking the given domain in top-100
region_queries_count	Search volume in selected region
region_queries_count_wide	Search volume (broad match)
domain	Domain
keyword_length	Number of words divided by space in a keyword
keyword	Keyword
url	URL appeared in the search result for the query
dynamic	Position change for the keyword
traff	Estimated traffic to a website (number of visitors)
types	List of special elements shown in SERP (for example, video, carousel or map)
found_results	Number of results found for “keyword"
cost	Cost per click, $
concurrency	Keyword competition in the PPC (0-100)
position	Keyword position in search results
subdomain	Subdomain appeared in search results for a given keyword
types	List of special elements shown in SERP (for example, video, carousel or map)
geo_names	List of toponyms in the array (if toponyms are present in the keywords)
date	Position check date
left_lines	Number of remaining API lines

Limits: the number of charged limits corresponds to the number of results obtained upon request. You can get no more than 60000 results per a query.

Part of the API response, for which 1 credit is charged:

{
"domain": "allo.ua",
"subdomain": null,
"keyword": "алло",
"keyword_length": 1,
"url": "https://allo.ua/",
"position": 1,
"date": "2019-04-06",
"types": [
  "pic",
  "local_pack",
  "ads_top",
  "a_box_some",
  "kn_graph_card",
  "kn_graph_brand",
  "related_search",
  "snip_sitelinks",
  "snip_https",
  "snip_search_box"
],
"found_results": 13100000,
"cost": 0.00769553,
"concurrency": 61,
"region_queries_count": 550000,
"region_queries_count_wide": 0,
"geo_names": [
  
],
"traff": 550000,
"dynamic": 0,
}

2.3.5. URL lists competing with the page V4

SerpstatUrlProcedure.getUrlCompetitors - this method returns URL lists competing the given page.

Request parameters:

Parameter	Description	Type	Optional	Default value	Value Options
url	URLs for finding competing URLs	string	no		http://allo.ua/
se	ID of the search base to be searched	string	no		g_ua, g_ru, ...
sort	Sorted order of the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending)	array	yes	[ ] empty array	{"cnt": "asc"}
page	Page number in response	int	yes	1	5
size	Number of results per page in response	int	yes	100	"size": {{page_size}} min: 1, max: 1000

Results may be sorted by the following fields:

Parameter

cnt

Response metrics:

Metrics	Description
result	Contains the answer
total	Number of keywords in top-100
cnt	Number of keywords common to the analyzed page and competitors' pages.
domain	Competitor’s domain
url	Competitor’s page
left_lines	Number of remaining API lines

Limits: the number of charged limits corresponds to the number of results obtained upon request. You can get no more than 60000 results per a query.

Part of the API response, for which 1 credit is charged:

{
"domain": "allo.ua",
"url": "https://allo.ua/ru/mobilnye-telefony-i-sredstva-svyazi/",
"cnt": 149
}

2.3.6. Competitor’s keywords missing on the specified page V4 (SerpstatUrlProcedure.getUrlMissingKeywords)

SerpstatUrlProcedure.getUrlMissingKeywords — this method returns keywords that competitors are ranking but the given URL isn’t.

Request parameters:

Parameter	Description	Type	Optional	Default value	Value Options
url	Keyword to search for	string	no		to buy a car
se	ID of the search base to be searched	string	no		g_ua, g_ru, ...
sort	Sort order of the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending)	array	yes	[ ]empty array	{"weight": "asc"}
page	Page number in response	int	yes	1	5
size	Number of results per page in response	int	yes	100	"size": {{page_size}}   min: 1, max: 1000

Results may be sorted  by the following fields:

Parameter

weight

Request metrics:

Metrics	Description
result	Contains the answer
region_queries_count	Search volume in selected region
region_queries_count_wide	Search volume (broad match)
geo_names	List of toponyms in the array (if toponyms are present in the keywords)
types	List of special elements shown in SERP (for example, video, carousel or map)
cost	Cost per click, $
keyword	Keyword for which  competitors are ranking but the given URL isn’t.
concurrency	Keyword competition in PPC (0-100)
weight	Connection strength shows the number of competitors who are ranking for the given keyword
left_lines	Number of remaining API lines

Limits: the number of charged limits corresponds to the number of results obtained upon request. You can get no more than 60000 results per a query.

Part of the API response, for which 1 credit is charged:

{
"region_queries_count": 1,
"geo_names": [],
"types": [
    "pic",
    "video",
    "local_pack",
    "related_search",
    "snip_reviews_stars"
],
"cost": 0,
"region_queries_count_wide": 0,
"keyword": "магазин алло г харьков",
"concurrency": 0,
"weight": 9
}

2.3.7. Traffic by URL mask V4 (SerpstatUrlProcedure.getSummaryTraffic)

SerpstatUrlProcedure.getSummaryTraffic — this method brings in traffic report by URL mask.

Request parameters:

Parameter	Description	Type	Optional	Value Options
domain	Domain to be searched	string	no	allo.ua
se	ID of the search base to be searched	string	no	g_ua, y_213, ...
urlContains	Searched part of URL	string	no	/products/mobile/

Response metrics:

Parameter	Description
totalTraff	Total organic traffic found by URL mask
urls	Number of URLs to be searched
left_lines	Number of remaining limits

 Limits: When calculating used limits any API queries are taken into account in accordance with you pricing plan. This method charges 1000 API limits for a query.