Domain Reports
2.1.1. Domain Summary (domain_info)
domain_info — method provides the number of keywords for which the domain is ranked in SEO and PPC, shows its visibility, traffic and other metrics.
Metrics | Description |
result | Encapsulates the answer |
visible | Site visibility |
keywords | The number of keywords found in the chosen search engine |
traff |
Estimate traffic based on keyword positions and search volume
|
visible_dynamic | Change in visibility since the last update |
keywords_dynamic | Change in the number of keywords since the last update |
traff_dynamic | Traffic change over the last n-time (in comparison with ""prev_date"") |
date | Current visibility, keywords, and traffic verification date |
prev_date | Previous verification date |
new_keywords | The number of acquired keywords for the domain since the last update |
out_keywords | Number of keywords lost by the domain since the last update |
rised_keywords | Number of domain's keywords which positions have improved since the last update |
down_keywords | Number of domain's keywords which positions have dropped since the last update |
ad_keywords | Number of keywords in PPC |
ads | Number of the PPC ads |
ads_dynamic | History of changes in PPC Ads |
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 | API limits remaining |
We charge 1 API limit per query.
2.1.2. Domain History (domain_history)
domain_history — this method provides historical data on a domain’s number of keywords and visibility.
Metrics | Description |
result | Encapsulates the answer |
visible_static | Visibility |
visible | Site visibility |
domain | Domain |
keywords | The number of keywords found in the chosen search engine |
ads | Number of Ads as of ""date"" |
ad_keywords | Number of keywords in ads |
new_keywords | Number of new keywords |
out_keywords | Number of keywords which were lost by a domain in the last N-days |
rised_keywords | Number of domain's keywords which positions have improved over the last N-days |
down_keywords | Number of domain's keywords which positions have dropped over the last N-days |
date | Verification date of a particular array element |
traff | Approximate organic traffic prognosis |
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 | API limits remaining |
Part of the API response, for which 1 limit is charged:
{
"visible_static": 0.0087,
"domain": "serpstat.com",
"ads": 191,
"visible": 0.0087,
"rised_keywords": 32,
"keywords": 430,
"down_keywords": 28,
"new_keywords": 101,
"ad_keywords": 293,
"traff": 2575,
"out_keywords": 37,
"date": "2016-11-13"
},
"visible_static": 0.0087,
"domain": "serpstat.com",
"ads": 191,
"visible": 0.0087,
"rised_keywords": 32,
"keywords": 430,
"down_keywords": 28,
"new_keywords": 101,
"ad_keywords": 293,
"traff": 2575,
"out_keywords": 37,
"date": "2016-11-13"
},
2.1.3. Domain Organic Keywords (domain_keywords)
domain_keywords — method shows keywords for which the domain ranks for in Google top 100 search results.
You can get up to 60000 results in this report.
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:
Parameter | Description | Possible settings |
position_from | min position for a keyword | 1-100 |
position_to | max position for a keyword | 1-100 |
queries_from | min number of monthly searches | 0-100,000,000 |
queries_to | max number of monthly searches | 0-100,000,000 |
cost_from | min CPC | 0-200 |
cost_to | max CPC | 0-200 |
concurrency_from | min level of competition | 1-100 |
concurrency_to | max level of competition | 1-100 |
filtering by |
string | |
keywords | filtering by keywords (list of keywords separated by commas) | string |
minus_keywords | filtering by negative keywords (separated by commas) | string |
pm_url | lookup belonging to the partial |
1/0 (active/inactive) |
To sort the results apply the
sort : field that needs to be sortedorder : sorting order (asc - ascending, desc - descending)
Metrics | Description |
result | Encapsulates the answer |
total |
Number of keywords for which the domain ranks in top 100 |
region_queries_count | Search volume in selected search engine database |
domain | |
keyword | Keyword for which the domain ranks |
keyword_length | Number of words divided by space in a keyword |
URL of a page which appears in SERP for the keyword | |
right_spelling | Proposed correction for a keyword with a spelling error |
dynamic | How the position of this keyword has changed |
found_results |
The number of results found for |
keyword_crc | The checksum for a quick search |
url_crc | |
cost | Cost per click, $ |
concurrency | Keyword competition in PPC |
position | Domain's 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) |
left_lines | API limits remaining |
Part of the API response, for which 1 limit is charged:
{
"domain": "example.com",
"subdomain": "www.example.com",
"keyword": "gmail и мой домен",
"keyword_length": 4,
"url": "https://www.example.com/",
"position": 43,
"types": [
"related_search",
"video"
],
"found_results": 60,
"cost": 0,
"concurrency": 0,
"region_queries_count": 1,
"region_queries_count_wide": 0,
"geo_names": [],
"traff": 0,
"dynamic": null,
"_id": "66411178-43"
},
2.1.4. List of domain's URLs (domain_urls)
domain_urls — method returns the list of URLs within the analyzed domain. Also, shows the number of keywords from top 100 search engine results for each URL.
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 | Number of keywords for which the domain ranks in top-100 |
url | URL |
keywords | Keyword for which the domain ranks |
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 | API limits remaining |
Part of the API response, for which 1 limit is charged:
{
"url": "http://example.com/",
"keywords": 182
}
2.1.5. Domain Comparison (domains_intersection)
domains_intersection — method returns common keywords of up to 3 domains.
- query – domains to be compared. You can compare up to 3 domains at once.
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 |
Number of keywords which the domain ranges by Top-100 |
region_queries_count | Keyword volume in selected search engine |
keyword_length | Number of words divided by space in a keyword |
domain 1,2,3 | Positions of the compared domains for a given keyword. (1,2,3) |
found_results | Number of results found for [keyword] |
keyword_crc | The checksum for a quick search |
url_crc | crc (encryption method) for the "" |
concurrency | Competition in AdWords (0-100) |
keyword_id | Keyword ID in our database |
region_queries_count_wide | Search volume (broad match) |
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) |
left_lines | API limits remaining |
Part of the API response, for which 1 limit is charged:
{
"keyword": "regnm домен",
"keyword_length": 2,
"types": [
"related_search",
"pic",
"ads_top",
"ads_bot",
"snip_reviews_stars",
"snip_breadcrumbs"
],
"found_results": 6260000,
"cost": 0,
"concurrency": 0,
"region_queries_count": 1,
"region_queries_count_wide": 0,
"geo_names": [],
"traff": 0,
"domain1": "example.com",
"subdomain1": null,
"url1": "http://example.com/",
"position1": 86,
"dynamic1": null,
"domain3": "google.com",
"subdomain3": "support.google.com",
"url3": "https://support.google.com/domains/answer/4491208?hl=ru",
"position3": 40,
"dynamic3": null,
"domain2": "serpstat.com",
"subdomain2": null,
"url2": "https://serpstat.com/ru/blog/poisk-drop-domenov-kak-najti-istekshie-domeni-i-viyavit-potentcialnie-dropi/",
"position2": 59,
"dynamic2": null
}
2.1.6. Common and Unique Keywords (domains_uniq_keywords)
domains_uniq_keywords — method returns unique keywords of a domain. Keywords that queried domain has in common with one or two other domains are removed from the list.
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
Parameter | Description | Possible settings |
queries_from | min number of monthly searches | 0-100,000,000 |
queries_to | max number of monthly searches | 0-100,000,000 |
cost_from | min CPC | 0-200 |
cost_to | max CPC | 0-200 |
concurrency_from | min level of competition | 1-100 |
concurrency_to | max level of competition | 1-100 |
Metrics | Description |
result | Encapsulates the answer |
total | Number of keywords for which the domain ranks in top-100 |
region_queries_count | Search volume in selected search engine database |
domain | Domain |
keyword_length | Number of words divided by space in a keyword |
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 |
found_results | The number of results found for "keywords" |
url_crc | CRC code (encryption method) for the "" |
concurrency | Keyword competition in PPC (0-100) |
position | Domain's position for a keyword |
keyword_id | Keyword ID in our database |
region_queries_count_wide | Search volume (broad match) |
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) |
left_lines | Number of remaining API queries |
Part of the API response, for which 1 limit is charged:
{
"domain": "example.com",
"subdomain": null,
"keyword": "use somebody",
"keyword_length": 2,
"url": "https://example.com/",
"position": 16,
"types": [
"related_search",
"video",
"pic",
"refine_by_brand"
],
"found_results": 90,
"cost": 0,
"concurrency": 0,
"region_queries_count": 10,
"region_queries_count_wide": 0,
"geo_names": [],
"traff": 0,
"dynamic": null,
"_id": "92473146-76",
"google.com": 30,
"example.com": 56
}
2.1.7. Competitors in Organic Search (competitors)
competitors — method returns the list of competitors for domain or keyword in top 20 Google search results.
Metrics | Description |
result | Encapsulates the answer |
domain | Domain |
visible | Domain's visibility |
keywords | The number of keywords found in the chosen search engine |
traff | Approximate organic traffic prognosis |
visible_dynamic | Change in visibility since the last upgrade |
keywords_dynamic | Change in the number of keywords over the last N-time |
traff_dynamic | Traffic change over the last N-time (in comparison with ""prev_date"" ) |
ads_dynamic | Change in the number of keywords used in PPC Ads |
new_keywords | The number of acquired keywords for the domain over the last N-days |
out_keywords | Number of keywords lost by a domain over the last N-days |
rised_keywords | Number of domain's keywords which positions have improved over the last N-days |
down_keywords | Number of domain's keywords which positions have dropped over the last N-days |
ad_keywords | Number of keywords used by domain in PPC Ads |
ads | Number of Ads as of |
intersected | Keywords domains have in common |
relevance | Domain's relevancy to the 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:
{
"domain": "kicksusa.com",
"visible": 10.99955,
"keywords": 300529,
"traff": 4565959,
"visible_dynamic": -1.14701,
"keywords_dynamic": -256,
"traff_dynamic": -1043552,
"ads_dynamic": 0,
"new_keywords": 3644,
"out_keywords": 3900,
"rised_keywords": 3914,
"down_keywords": 5986,
"ad_keywords": 1,
"ads": 1,
"intersected": 209719,
"not_intersected": 90810,
"relevance": 69.78,
"new_relevance": 8.99,
"our_relevance": 9.36
}
2.1.8. Advertising report with specified name of domain (ad_keywords)
ad_keywords — method returns ads copies that pop up for the queried keyword in Google paid search results.
If you specify the name of the domain, the report lists all ads copies the domain is currently running.
If you specify the keyword, the report lists all ads copies the keyword is currently running.
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:
Parameter | Description | Possible settings |
position_from | min position for a keyword | 1-100 |
position_to | max position for a keyword | 1-100 |
queries_from | min number of monthly searches | 0-100,000,000 |
queries_to | max number of monthly searches | 0-100,000,000 |
cost_from | min CPC | 0-200 |
cost_to | max CPC | 0-200 |
concurrency_from | min level of competition | 1-100 |
concurrency_to | max level of competition | 1-100 |
right_spelling | filtering by misspelled keywords |
not_contains - contains misspelled keywords; contains - does not contain misspelled keywords |
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 paid search results for the keyword |
hits | Encapsulates the answer |
region_queries_count | Search volume in selected search engine database |
region_queries_count_wide | Search volume (broad match) |
region_queries_count_last | Search volume (last month) |
domain | Domain |
keyword_length | Number of words divided by space in a keyword |
keyword | Query for which an ad is displayed in SERP |
title | Ad Title |
url | Ad URL |
text | Ad text |
found_results | The number of results found for |
url_crc | CRC code (encryption method) for the "" |
CRC | The checksum for a quick search |
concurrency | Competition in AdWords |
position | Ad position |
keywords_id | Keyword ID in our database |
subdomain | Subdomain |
type | Ad placement type in relation to SERP (1. Above; 2. Under; 3. Side) |
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) |
left_lines | Number of remaining API queries |
Part of the API response, for which 1 limit is charged:
{
"keyword": "nike air force 1",
"keyword_length": 4,
"domain": "nike.com",
"subdomain": "www.nike.com",
"url": "https://www.nike.com/w/air-force-1-shoes-5sj3yzy7ok?cp=15839883195_search_%7Cnike+air+force+1%7CGOOGLE%7C71700000042134106%7CAll_X_X_X_X-Device_X_AF1-General_Exact%7Ce%7Cc&gclid=EAIaIQobChMIj6f9r4Sx5QIVR3ZgCh360Qx6EAAYASAAEgL9FPD_BwE&gclsrc=aw.ds",
"title": "Nike Air Force 1 | Nike Official Site",
"text": "Shop The Official Nike Store For The Latest Nike Shoes, Apparel & Gear.",
"position": 1,
"type": 1,
"cost": 0.71,
"concurrency": 100,
"found_results": 69,
"region_queries_count": 90500,
"region_queries_count_wide": 0,
"region_queries_count_last": 0,
"types": [
"related_search",
"also_asks",
"ads_top",
"shopping_top"
],
"geo_names": [
],
"_id": "24829288_1"
}
2.1.9. Domain Top Pages (get_top_urls)
get_top_urls — method returns all website's pages in hierarchical order. Also, it shows the number of keywords from Google top-100 or Yandex top-50 for each URL, visitors a page would receive per month if it was to rank number 1 in Google or Yandex SERP for its top-20 keywords, Facebook and LinkedIn shares of the researched domain's page. The results are sorted by traffic volume.
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)
Sorting
Following parameters can be used for sorting:
- sort: field that needs to be sorted (organic_keyword, facebook_shares, linkedin_shares, google_shares, potencial_traff). For example sort=organic_keywords&page_size=100
- order: sort results in descending order "desc" or ascending order "
asc " ( default: desc ). For example order=desc
Metrics | Description |
result | Encapsulates the answer |
total | The total number of the website pages |
top_urls | Encapsulates the answer |
URL of the domain |
|
organic_keywords | The number of keywords the URL ranks for in Google top-100 or Yandex top-50 results |
facebook_shares | The number of Facebook shares of the researched domain's page. |
potencial_traff | The number of visitors a page would receive per month if it was to rank number 1 in Google or Yandex SERP for its top-20 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) |
left_lines | API limits left |
2.1.10. Domain Summary V4 (SerpstatDomainProcedure.getDomainsInfo)
SerpstatDomainProcedure.getDomainsInfo — this report provides with the summary information for an array of domains.
Request parameters:
Metrics | Description | Optional | Value |
domains | Array of domains | no | ["nike.ua", "citrus.ua" ] |
se | ID of the search base to be searched | no | g_ua, y_213 |
Response metrics:
Metrics | Description |
result | Contains the answer |
visible | Site visibility |
keywords | Number of keywords found in the chosen search engine |
traff |
Estimated traffic to a site (number of visitors)
|
visible_dynamic | Change in visibility since the last upgrade |
keywords_dynamic | Change in the number of keywords over the last 2 weeks |
traff_dynamic | Traffic change over the last 2 weeks |
date | Current visibility, keywords, and traffic verification date |
prev_date | Previous verification date |
new_keywords | Number of new keywords for the domain over the last 2 weeks |
out_keywords | Number of keywords lost by a domain over the last 2 weeks |
rised_keywords | Number of domain keywords for which positions have improved over the last 2 weeks |
down_keywords | Number of domain keywords for which positions have dropped over the last 2 weeks |
ad_keywords | Number of keywords in PPC |
ads | Number of PPC Ads |
ads_dynamic | History of changes in PPC Ads |
left_lines | API credits remaining |
Credits: for each domain for which information is received, 1 credit is charged.
Part of the API response, for which 1 credit is charged:
{
"domain": "allo.ua",
"visible": 1427.64772,
"keywords": 21834506,
"traff": 137705752,
"visible_dynamic": -51.550359999999955,
"keywords_dynamic": -76425,
"traff_dynamic": 17517324,
"ads_dynamic": 18237,
"new_keywords": 17040,
"out_keywords": 17179,
"rised_keywords": 21708,
"down_keywords": 44294,
"ad_keywords": 161823,
"ads": 122695,
"visible_mysql": 0,
"prev_date": "2020-01-27"
}
2.1.11. Domain history V4 (SerpstatDomainProcedure.getDomainsHistory)
SerpstatDomainProcedure.getDomainsHistory — this report provides you with the historical data on a domain’s number of keywords and visibility.
Request parameters:
Metrics |
Description |
Optional |
Default value |
Value options |
domain |
Domain name |
no |
- |
|
se |
ID of the search base to be searched |
no |
- |
g_ua |
sort |
Order of sorting the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending) |
yes |
- |
{"ads":"desc"} |
page |
Page number in response |
yes |
1 |
5 |
size |
Number of results per page in response |
yes |
100 |
100-1000 |
Sorting results is possible by the following fields:
Parameter |
date
|
down_keywords
|
visible
|
rised_keywords
|
keywords
|
traff |
visible_static |
new_keywords |
out_keywords |
down_keywords |
ad_keywords |
Response metrics:
Metrics: |
Description |
result |
Contains the answer |
visible |
Site visibility |
domain |
Domain |
keywords |
Number of keywords found in the chosen search engine |
traff |
Estimated organic traffic to a site (number of visitors) |
date |
Date of current visibility, key phrase, and traffic check |
new_keywords |
Number of new keywords, for which the domain ranked in the last 2 weeks |
out_keywords |
Number of keywords for which rankings were lost by a domain over the last 2 weeks |
rised_keywords |
Number of domain's keywords for which positions have improved over the last 2 weeks |
down_keywords |
Number of domain's keywords for which positions have dropped over the last 2 weeks |
ad_keywords |
Number of keywords in PPC |
ads |
Number of ads in PPC |
left_lines |
API credits remaining |
Credits: the number of charged credits corresponds to the number of results obtained.
Part of the API response, for which 1 credit is charged:
{
"domain": "google.com",
"rised_keywords": 176915,
"visible": 5995.61211,
"traff": 120802965,
"keywords": 3964146,
"visible_static": 5995.61211,
"date": "2018-07-05",
"ads": 1662,
"new_keywords": 184914,
"down_keywords": 232468,
"ad_keywords": 7638,
"out_keywords": 146804
}
2.1.12. Top search engine keywords by V4 domain (SerpstatDomainProcedure.getDomainKeywords)
SerpstatDomainProcedure.getDomainKeywords — this method shows top search engine keywords by domain. You can load up to 60000 results using this method.
Request parameters:
Parameter |
Description |
Optional |
Default value |
Value options |
domain |
Domain name |
no |
|
|
se |
ID of the search base to be searched |
no |
|
g_ua, y_213 |
url |
Link to refine your search |
yes |
null |
https://allo.ua |
keywords |
Array of keywords to search for |
yes |
[] |
["buy"] |
minusKeywords |
Negative keyword array |
yes |
[] |
["allo", "alo"] |
filters |
Filter conditions |
yes |
|
{ "concurrency_from": "0", "concurrency_to": "1" } |
sort |
Sort order of the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending) |
yes |
{"position": "asc", "region_queries_count":"desc"} |
{"cost": "asc"} |
page |
Page number in response |
yes |
1 |
5 |
size |
Number of results per page in response |
yes |
100 |
"size": {{page_size}} min: 1, max: 1000 |
Sorting results is possible by the following fields:
Parameter |
region_queries_count |
types |
cost
|
keyword_length |
concurrency |
geo_names |
traff |
region_queries_count_wide |
dynamic |
position |
found_results |
To filter the results use the following parameters:
Parameter | Description | Possible value |
position_from | min position for a keyword | 1-100 |
position_to | max position for a keyword | 1-100 |
queries_from | min number of monthly searches | 0-100,000,000 |
queries_to | max number of monthly searches | 0-100,000,000 |
cost_from | min CPC | 0-200 |
cost_to | max CPC | 0-200 |
concurrency_from | min competition value | 1-100 |
concurrency_to | max competition value | 1-100 |
Response parameters:
Parameter |
Description |
result |
Contains the answer |
total |
Number of keywords found for which the domain ranked in top-100 |
region_queries_count |
Number of keyword queries in a selected region |
domain |
Domain ranking by keyword |
keyword |
Keyword ranking on a selected website |
keyword_length |
Number of words divided by space in a keyword |
url |
URL appeared in the search result for the query |
right_spelling |
Recommended correction of a misspelled keyword |
dynamic |
Position change for the keyword |
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) |
left_lines |
Number of remaining API lines |
Part of the API response, for which 1 credit is charged:
{
"domain": "google.com",
"subdomain": "translate.google.com",
"keyword": "переводчик",
"keyword_length": 1,
"url": "https://translate.google.com/?hl=ru",
"position": 1,
"types": [
"pic",
"a_box_translation",
"related_search"
],
"found_results": 39600000,
"cost": 0.2,
"concurrency": 0,
"region_queries_count": 9140000,
"region_queries_count_wide": 6120000,
"geo_names": [
],
"traff": 9140000,
"dynamic": 0
}
2.1.13. List of domain URLs V4 (SerpstatDomainProcedure.getDomainUrls)
SerpstatDomainProcedure.getDomainUrls — this method brings returns URL and the number of keywords for the URL.
Request parameters:
Parameter |
Description |
Optional |
Default value |
Value options |
domain |
Domain name |
no |
- |
|
se |
ID of the search base to be searched |
no |
- |
g_ua, g_ru, ... |
sort |
Order of sorting the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending) |
yes |
{"keywords":"desc"} |
{"keywords":"asc"} |
page |
Page number in response |
yes |
1 |
5 |
size |
Number of results per page in response |
yes |
100 |
"size": {{page_size}} min: 1, max: 1000 |
Sorting results is possible by the following fields:
Parameter |
keywords
|
Response parameters:
Parameter |
Description |
result |
Contains the answer |
total |
Number of found URLs |
url |
Page |
keyword |
Number of keywords found ranking the page |
left_lines |
Number of remaining API lines |
Limits: the number of charged limits corresponds to the number of results obtained upon request. Part of the API response, for which 1 credit is charged:
{
"url": "https://play.google.com/store?hl=ru",
"keywords": 4938
}
2.1.14. Domains intersection V4 (SerpstatDomainProcedure.getDomainsIntersection)
SerpstatDomainProcedure.getDomainsIntersection — this method introduces general keywords for domains.
Request parameters:
Parameter |
Description |
Optional |
Default value |
Value options |
domains |
Array of domains min2, max3 |
no |
- |
["starbucks.com", "apple.com"] |
se |
ID of the search base to be searched |
no |
- |
g_us, g_es, ... |
page |
Page number in response |
yes |
1 |
5 |
size |
Number of results per page in response |
yes |
100 |
100-1000 |
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 |
keyword |
Keyword ranking the given website |
keyword_length |
Number of words divided by space in a keyword |
keyword_id |
Keyword id in our database |
keyword_crc |
Checksum for a quick search |
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) |
region_queries_count_wide | Search volume (broad match) |
url_crc | CRC code (encryption method) for the "url" variable |
domain 1,2,3 | Positions of the intersected domains for the given keyword |
geo_names | List of toponyms in the array (if toponyms are present in the keywords) |
traff | Estimated traffic to a website (number of visitors) |
subdomain 1,2,3 | Website subdomain which is displayed in search results for the given keyword |
url 1,2,3 | URL displayed in SERP for the given keyword |
position 1,2,3 | Keyword position in search results |
dynamic 1,2,3 | Position change 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.
Part of the API response, for which 1 credit is charged:
{
"keyword": "знімок екрану леново",
"keyword_length": 3,
"types": [
"pic",
"related_search",
"also_asks"
],
"found_results": 100,
"cost": 0,
"concurrency": 0,
"region_queries_count": 1,
"region_queries_count_wide": 0,
"geo_names": [
],
"traff": 0,
"domain3": "rozetka.ua",
"subdomain3": "i1.rozetka.ua",
"url3": "https://i1.rozetka.ua/goods/documents/1079791/lenovo_vibe_k5_note_pro_silver_documents_1079791792.pdf",
"position3": 19,
"dynamic3": null,
"domain2": "citrus.ua",
"subdomain2": "www.citrus.ua",
"url2": "https://www.citrus.ua/planshety/lenovo-yoga3-x50f-16gbl-za0h0060ua-608291.html",
"position2": 42,
"dynamic2": null,
"domain1": "allo.ua",
"subdomain1": "blog.allo.ua",
"url1": "https://blog.allo.ua/obzor-smartfona-lenovo-vibe-x2_2014-11-13/",
"position1": 30,
"dynamic1": null
}
2.1.15. General and unique keywords V4 (SerpstatDomainProcedure.getDomainsUniqKeywords)
SerpstatDomainProcedure.getDomainsUniqKeyword - this method helps to bring keywords without domain’s negative keywords.
Request parameters:
Parameter |
Description |
Type |
Optional |
Default value |
Value Options |
domains |
Array of domains min 1, max 2 |
array |
no |
["allo.ua", "citrus.ua"] |
|
minusDomain |
Domain with keywords which must not intersect domains parameters |
string |
no |
||
se |
ID of the search base to be searched |
string |
no |
g_ua, g_ru, ... |
|
filters |
Filter conditions |
array |
no |
|
{"queries_from": 10} {"queries_to": 10} |
page |
Page number in response |
aint |
yes |
1 |
5 |
size | Number of results per page in response | int | yes | 100 |
"size": {{page_size}} min: 1, max: 1000 |
To filter the results, use the following parameters:
Parameter | Description | Possible values |
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 value of competitor’s keyword in the PPC | 0-100 |
concurrency_to | max value of competitor’s keyword in the PPC | 0-100 |
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 |
domain |
Domain |
keyword_length |
Number of words divided by space in a keyword |
keyword |
Keyword ranking the given website |
url |
URLs displayed in SERP by the given keyword |
date |
Search result issue date |
dynamic |
Position change of the given keyword |
traff |
Estimated traffic to a website (number of visitors) |
found_results |
Number of results found for "keyword" |
cost |
Cost per click, $ |
concurrency |
Keyword competition in PPC (0-100) |
position |
Keyword position in search result |
subdomain |
Subdomain displayed in search result by the given keyword |
region_queries_count_wide |
Search volume (broad match) |
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) |
left_lines | Number of remaining API lines |
Limits: the number of charged limits corresponds to the number of results obtained upon request.
Part of the API response, for which 1 credit is charged:
{
"domain": "allo.ua",
"subdomain": null,
"keyword": "купить дом в чернигове бу",
"keyword_length": 5,
"url": "https://allo.ua/ru/mobilnye-telefony-i-sredstva-svyazi/",
"position": 42,
"date": "2019-04-08",
"types": [
"pic",
"related_search"
],
"found_results": 62,
"cost": 0,
"concurrency": 0,
"region_queries_count": 1,
"region_queries_count_wide": 0,
"geo_names": [
"чернигове"
],
"traff": 0,
"dynamic": 15,
"citrus.ua": 40,
"allo.ua": 42
}
2.1.16. Domain competitors in V4 search result (SerpstatDomainProcedure.getCompetitors)
SerpstatDomainProcedure.getCompetitors — this method brings in the list of domain competitors from Google top-20 search results.
Request parameters:
Parameter |
Description |
Optional |
Default value |
Value options |
domain |
Domain name |
no |
- |
|
se |
ID of the search base to be searched |
no |
- |
g_ua |
sort |
Sort order of the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending) |
yes |
{"relevance":"desc"} |
{"ads":"desc"} |
page |
Page number in response |
yes |
1 |
5 |
size |
Number of results per page in response |
yes |
100 |
50-1000 |
Parameter |
visible |
keywords
|
traff |
visible_dynamic |
keywords_dynamic
|
traff_dynamic |
ads_dynamic |
new_keywords |
out_keywords |
rised_keywords |
down_keywords |
ad_keywords |
ads |
intersected |
relevance |
new_relevance |
our_relevance |
Response metrics:
Metrics |
Description |
result |
Contains the answer |
visible |
Site visibility |
domain |
Domain |
keywords |
Number of keywords found in the chosen search engine |
traff |
Estimated organic traffic to a site (number of visitors) |
visible_dynamic |
Change in visibility since the last upgrade |
keywords_dynamic |
Change in the number of keywords over the period of time |
traff_dynamic | Traffic change over the period of time |
ads_dynamic | Change in the number of keywords in the PPC ads |
new_keywords | Number of new keywords for the domain over the period of time |
out_keywords | Number of keywords lost by a domain over the period of time |
rised_keywords | Number of domain keywords for which positions have improved over the period of time |
down_keywords | Number of domain keywords for which positions have dropped over the period of time |
ad_keywords | Number of keywords in the PPC |
ads | Number of ads |
intersected | Number of domain keywords that contain a target keyword |
relevance | Total domain relevance for a target word |
left_lines | Number of remaining API lines |
Limits: the number of charged limits corresponds to the number of results obtained upon request.
Part of the API response, for which 1 credit is charged:
{
"domain": "google.com",
"visible": 6292.39888,
"keywords": 514454762,
"traff": 2795219750,
"visible_dynamic": -132.55671,
"keywords_dynamic": 48860651,
"traff_dynamic": 927779,
"ads_dynamic": 554,
"new_keywords": 54740992,
"out_keywords": 5880341,
"rised_keywords": 1010039,
"down_keywords": 985120,
"ad_keywords": 62679,
"ads": 41551,
"intersected": 514454762,
"relevance": 100,
"new_relevance": 100,
"our_relevance": 100
}
2.1.17. Advertising report with specified name of domain V4 (SerpstatDomainProcedure.getAdKeywords)
SerpstatDomainProcedure.getAdKeywords — this report shows Ads by domain.
Request parameters:
Parameter |
Value |
Optional |
Default value |
Value Options |
domain |
Domain name |
no |
||
se |
ID of the search base to be searched |
no |
g_uk, g_ca, ... |
|
url |
Link to refine your search |
yes |
null |
|
keywords |
Array of key phrases to search for |
yes |
[] |
["buy"] |
minusKeywords |
Negative keyword array |
yes |
[] |
["vnike", "nnike"] |
filters |
Filter conditions |
yes |
|
{ "concurrency_from": "0", "concurrency_to": "1" }
|
sort |
Order of sorting the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending) |
yes |
{"position": "asc", "region_queries_count":"desc"} |
{"cost": "asc"} |
page |
Page number in response |
yes |
1 |
5 |
size |
Number of results per page in response |
yes |
100 |
"size": {{page_size}} |
Sorting results is possible by the following fields:
Parameter |
keyword_length
|
position
|
type
|
cost
|
concurrency
|
found_results
|
region_queries_count
|
region_queries_count_wide
|
types
|
difficulty
|
geo_names
|
To filter the results, use the following parameters:
Parameter | Description | Possible values |
position_from | min position for a keyword | 1-100 |
position_to | max position for a keyword | 1-100 |
queries_from | min number of monthly searches | 0-100000000 |
queries_to | max number of monthly searches | 0-100000000 |
cost_from | min CPC | 0-200 |
cost_to | max CPC | 0-200 |
concurrency_from | min level of competition | 0-100 |
concurrency_to | max level of competition | 0-100 |
Response metrics:
Metrics |
Description |
result |
Contains the answer |
total |
Number of ads found that appear for queries containing the search word |
hits |
Conatains the answer |
region_queries_count |
Search volume in selected search engine database |
region_queries_count_wide |
Search volume (broad match) |
region_queries_count_last |
Search volume (last month) |
domain |
Domain |
keyword_length |
Number of words divided by space in a keyword |
keyword |
Query for which an ad is displayed in SERP |
title |
Ad Title |
url |
Ad URL |
text |
Ad text |
found_results |
Number of results found for |
url_crc |
CRC code (encryption method) for the "" |
CRC |
Checksum for a quick search |
cost |
|
concurrency |
Competition in Google Ads (0-100) |
position |
Ad position |
date |
|
keywords_id |
Keyword ID in our database |
subdomain |
Subdomain |
type |
Ad placement type in relation to SERP (1. Above; 2. Under; 3. Side) |
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) |
left_lines |
Number of remaining API queries |
Credits: the number of charged credits corresponds to the number of results obtained upon request.
Part of the API response, for which 1 credit is charged:
{
"keyword": "gmail.coṃ",
"keyword_length": 1,
"domain": "google.com",
"subdomain": "gsuite.google.com",
"url": "https://gsuite.google.com/intl/ru/products/gmail/",
"title": "Рабочая почта Gmail от Google | Работайте там, где вам удобно",
"text": "Надежная почта, онлайн хранение, календарь, видеочат.",
"position": 1,
"type": 1,
"cost": 0.05,
"concurrency": 7,
"found_results": 13,
"region_queries_count": 74000,
"region_queries_count_wide": 0,
"types": [
"pic",
"ads_top"
],
"geo_names": [
]
}
2.1.18. Domain top URLs V4 (SerpstatDomainProcedure.getTopUrls)
SerpstatDomainProcedure.getTopUrls - this method introduces domain’s top URLs due to the number of keywords in regional search engine results. In addition, it gives information about potential traffic and amount of shares on Facebook.
The given method can work for prolonged periods of time owing to particularity of data collection.
The results are sorted by the number of keywords in descending order by default.
Request parameters:
Parameter |
Description |
Type |
Optional |
Default value |
Value options |
domain |
Domain name |
string |
no |
- |
|
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) |
json object |
yes |
{"organic_keywords":"desc"} |
{"organic_keywords":"desc"} |
filters |
Filter conditions |
json object |
yes |
- |
{"url_prefix": "https://allo.ua/ru/products/"} {"url_contain": "style"} {"url_not_contain": "style"}
|
page |
Page number in response | int | yes | 1 | 5 |
size |
Number of results per page in response | int | yes | 100 | 50-1000 |
Parameter |
organic_keywords |
facebook_shares |
potential_traff |
Response metrics:
Metrics |
Description |
result |
Contains the answer |
total |
Total number of pages found in domain |
url |
URL |
organic_keywords |
Total number of keywords found ranking the page in Google top-100 or Yandex top-50 |
facebook_shares |
Number of Facebook shares |
potential_traff |
Number of visitors per month the page will get if it takes the first position for all keywords in top-20 Google or Yandex search results. This indicator is calculated based on the ratio of real and maximum possible traffic. |
left_lines |
Number of remaining API lines |
Limits: the number of charged limits corresponds to the number of results obtained upon request
2.1.19. Domain competitors in V4 PPC (SerpstatDomainProcedure.getAdsCompetitors)
SerpstatDomainProcedure.getAdsCompetitors — this method brings in the list of domain competitors from PPC.
Request parameters:
Parameter |
Description |
Optional |
Default value |
Value options |
domain |
Domain name |
no |
- |
|
se |
ID of the search base to be searched |
no |
- |
g_ua |
sort |
Sort order of the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending) |
yes |
{"relevance":"desc"} |
{"ads":"desc"} |
page |
Page number in response |
yes |
1 |
5 |
size |
Number of results per page in response |
yes |
100 |
50-1000 |
Parameter |
keywords
|
ads |
intersected |
relevance |
Response metrics:
Metrics |
Description |
result |
Contains the answer |
domain |
Domain |
keywords |
Number of keywords found in the chosen search engine |
ads | Number of ads |
intersected | Number of domain keywords that contain a target keyword |
left_lines | Number of remaining API lines |
Limits: the number of charged limits corresponds to the number of results obtained upon request.
Part of the API response, for which 1 credit is charged:
{
"domain": "eldorado.ua",
"keywords": 1155,
"ads": 1319,
"intersected": 207,
"missing_keywords": 948
},
2.1.20. Statistics on limits V4 (SerpstatLimitsProcedure.getStats)
SerpstatLimitsProcedure.getStats — method for checking the number of available and used daily API and Serpstat extension credits.
Credits for this method are not used.
Response metrics:
Parameter | Description | Value |
---|---|---|
max_lines |
Max number of API credits available per day | int |
used_lines |
Number of API credits used for the current day | int |
left_lines |
Number of available API credits for the current day | int |
user_info | API User Information | json object |
user_id |
User ID in Serpstat | int |
plugin_limits |
Serpstat extension API credits information | json object |
delayBetweenRequests |
Number of Serpstat extension API requests per second | int |
hasApiPlugin |
Availability of access to the Serpstat extension API: |
bool |
total | The number of credits per day for the Serpstat extension API | int |
used | The number of used credits for the current day to the extension API | int |
left | The number of remaining credits for the current day to the extension API | int |
2.1.20. Statistics on limits V4 (SerpstatLimitsProcedure.getStats)
SerpstatLimitsProcedure.getStats — method for checking the number of available and used daily API and Serpstat extension credits.
Credits for this method are not used.
Response metrics:
Parameter | Description | Value |
---|---|---|
max_lines |
Max number of API credits available per day | int |
used_lines |
Number of API credits used for the current day | int |
left_lines |
Number of available API credits for the current day | int |
user_info | API User Information | json object |
user_id |
User ID in Serpstat | int |
plugin_limits |
Serpstat extension API credits information | json object |
delayBetweenRequests |
Number of Serpstat extension API requests per second | int |
hasApiPlugin |
Availability of access to the Serpstat extension API: |
bool |
total | The number of credits per day for the Serpstat extension API | int |
used | The number of used credits for the current day to the extension API | int |
left | The number of remaining credits for the current day to the extension API | int |