Domain analysis
2.1. Domain Summary
The SerpstatDomainProcedure.getDomainsInfo method provides with the summary information for an array of domains.
General request parameters and instructions for using Serpstat API
Search databases available
| Request parameters | |||
| Parameter | Description | Optional | Value options |
| id | A request id: the response contains the same id. Enter any number (number) or text (string) value | no | 1, test |
| method | API method name | no | SerpstatDomainProcedure.getDomainsInfo |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no | |
| domains | Array of domains | no | ["nike.com", "adidas.com" ] |
| se | ID of the search base to be searched (there is Google database available, for example: g_us). | no | g_us |
| filters | Filter conditions | yes | "visible": 35 "traff": 1000 |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| domain | Analyzed domain |
| visible | Site visibility |
| keywords | Number of keywords found in the chosen search engine |
| traff | Estimated search traffic based on keyword positions and search volume |
| visible_dynamic | Change in visibility since the last monitoring |
| keywords_dynamic | Change in the number of keywords since the last monitoring |
| traff_dynamic | Traffic change since the last monitoring |
| ads_dynamic | Dynamics of changes in PPC Ads |
| new_keywords | Number of new keywords for the domain since the last monitoring |
| out_keywords | Number of keywords lost by a domain since the last monitoring |
| rised_keywords | Number of domain keywords for which positions have improved since the last monitoring |
| down_keywords | Number of domain keywords for which positions have dropped since the last monitoring |
| ad_keywords | Number of keywords in PPC |
| ads | Number of PPC Ads |
| prev_date | Previous verification date |
| summary_info | Object with data |
| page | Page number |
| left_lines | API credits remaining |
Credits: for each domain for which information is received, 5 credits is charged. Part of the API response, for which 5 credits is charged:
{
"domain": "adidas.com",
"visible": 38.226520000000001,
"keywords": 1360672,
"traff": 54388418,
"visible_dynamic": 0.47296000000000049,
"keywords_dynamic": -5503,
"traff_dynamic": -370839,
"ads_dynamic": 66,
"new_keywords": 21333,
"out_keywords": 26836,
"rised_keywords": 33457,
"down_keywords": 31140,
"ad_keywords": 203,
"ads": 199,
"prev_date": "2021-05-13"
}2.10. Domain history
The SerpstatDomainProcedure.getDomainsHistory method provides you with the historical data on a domain’s number of keywords and visibility.
General request parameters and instructions for using Serpstat API
| Request parameters | |||||
| Parameter | Description | Type | Optional | Default value | Value options |
| id | A request id: the response contains the same id. Enter any number (number) or text (string) value | int/string | no | Text or number value. For example: 1, test | |
| method | API method name | string | no | SerpstatDomainProcedure.getDomainsHistory | |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no | |||
| domain | Domain name | string | no | Text value of the analyzed domain. for example: nike.com | |
| se | ID of the search base to be searched. | string | no | g_us, g_ca databases list | |
| sort | Order of sorting the results in the format: {{{field}}: {{order}}} field — field to sort by order — sort direction | object | yes | field: "keywords" | |
| page | Page number in response | int | yes | 1 | "page": 1 (any number value) |
| size | Number of results per page in response | int | yes | 100 | "size": 10 (any number value) |
| filters | Filter conditions | object | yes | "visible": 30 "traff": 1000 | |
| during_all_time | History period | boolean | yes | false | true – get information on All time |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| domain | Analyzed domain |
| keywords | Number of keywords found in the chosen search engine |
| traff | Estimated search traffic based on keyword positions and search volume |
| visible | Site visibility |
| visible_static | Change in visibility since the last monitoring |
| new_keywords | Number of new keywords since the last N-days monitoring |
| out_keywords | Number of lost keywords since the last N-days monitoring |
| rised_keywords | Number of keywords which positions of the domain have improved over the last N-days |
| down_keywords | Number of keywords which positions of the domain have dropped over the last N-days |
| ad_keywords | Number of keywords in PPC |
| ads | Number of ads in PPC |
| date | Verification date of a particular array element |
| summary_info | Object with data |
| page | Page number |
| total | Number of results for request |
| 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": "nike.com",
"keywords": 2603734,
"traff": 240307722,
"visible": 212.81692,
"visible_static": 212.81692,
"new_keywords": 32499,
"out_keywords": 37326,
"rised_keywords": 40518,
"down_keywords": 43717,
"ad_keywords": 1197,
"ads": 929,
"date": "2021-04-29"
},2.2. Domain keywords
The SerpstatDomainProcedure.getDomainKeywords method keywords which the analyzed domain ranks for in Google top-100 search results. The data set is similar to the Domain analysis — SEO research — Keywords report. You can get up to 60 000 results in this report.
General request parameters and instructions for using Serpstat API
Search databases available
| Request parameters | ||||
| Parameter | Description | Optional | Default value | Value options |
| id | A request id: the response contains the same id. Enter any number (number) or text (string) value | no | 1, test | |
| method | API method name | no |
| SerpstatDomainProcedure. |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no |
|
|
| domain | Domain name | no |
| nike.com |
| se | ID of the search base to be searched. | no |
| g_us |
| withSubdomains | Search type: with/without subdomains | yes | true | true | false |
| url | Link to refine your search | yes | null | https://www.nike.com/soccer |
| keywords | Array of keywords to search for | yes | [] | ["shop", "nike"] |
| minusKeywords | Negative keyword array | yes | [] | ["nikes", "nke"] |
| filters | Filter conditions | yes |
| {"right_spelling": true} {"right_spelling": false} {"position_dynamic": "new"} {"position_dynamic": "rise"} {"position_dynamic": "down"} |
| sort | Order of sorting the results in the format: {{{field}}: {{order}}} field — field to sort by: * region_queries_count * types * cost * keyword_length * concurrency * geo_names * traff * region_queries_count_wide * dynamic * position * found_results order — sort direction (asc — ascending, desc — descending) | yes | {"position": "asc", "region_queries_count":"desc"} | {"cost": "asc"} |
| page | Page number in response | yes | 1 | "page": "5" |
| size | Number of results per page in response | yes | 100 | "size": "10" min: 1, max: 1000 |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| domain | Analyzed domain |
| subdomain | Subdomain appeared in search results for a given keyword |
| keyword | Keyword which the domain ranks for |
| keyword_length | Number of words divided by space in a keyword |
| url | URL appeared in the search result for the query |
| position | Domain's position for a keyword |
| types | List of special elements shown in SERP (for example, video, carousel or map) |
| found_results | Number of results found for the keyword |
| cost | Cost per click, $ |
| concurrency | Keyword competition in the PPC (0-100%) |
| region_queries_count | Search volume in a selected region |
| region_queries_count_wide | Search volume in selected search engine database in broad match |
| geo_names | List of toponyms in the array (if toponyms are present in the keywords) |
| traff | Approximate traffic by keyword depending on its volume and position |
| difficulty | The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 0 to 100%) |
| right_spelling | Recommended correction of a misspelled keyword |
| dynamic | Position change for the keyword |
| summary_info | Object with data |
| page | Page number |
| total | Number of keywords which the domain ranks for in top of search results |
| left_lines | API credits remaining |
Part of the API response, for which 1 credit is charged:
{
"domain": "nike.com",
"subdomain": "www.nike.com",
"keyword": "nike socer",
"keyword_length": 2,
"url": "https://www.nike.com/soccer",
"position": 1,
"types": [
"shopping_rhs",
"ads_top",
"snip_breadcrumbs"
],
"found_results": 90,
"cost": 0.48,
"concurrency": 100,
"region_queries_count": 9900,
"region_queries_count_wide": 0,
"geo_names": [],
"traff": 1484,
"difficulty": 20.35,
"right_spelling": "nike soccer",
"dynamic": 0
},2.3. Competitors in paid search results
The SerpstatKeywordProcedure.getAdsCompetitors method performs list of competitors in PPC for the given keyword. The data set is similar to the Competitors report in PPC research of the keywords.
General request parameters and instructions for using Serpstat API
Search databases available
| Request parameters | |||||
| Parameter | Description | Type | Optional | Default value | Value Options |
| id | A request id: the response contains the same id. Enter any number (number) or text (string) value | int/string | no | 1, test | |
| method | API method name | string | no | SerpstatKeywordProcedure.getAdsCompetitors | |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | array | no | ||
| query | Keyword by which competitors will be searched | string | no | iphone | |
| se | Search engine ID. | string | no | g_us | |
| page | Page number in response | int | yes | 1 | "page": "5" |
| pageSize | Number of results per page in response | int | yes | 100 | "pageSize": "100" min: 100, max: 1000 |
| sort | Sort order of the results in the format: {{{field}}: {{order}}} field - field to sort by: * ads * all * common order - sort direction (asc - ascending, desc - descending) | json object | yes | {"common": "desc"} | |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| domain | Competitor's domain |
| ads | Number of ads for a domain |
| all | Number of keywords for a domain in PPC |
| common | Common keywords in PPC |
| summary_info | Object with data |
| page | Page number |
| left_lines | API credits remaining |
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:
{
"domain": "verizon.com",
"ads": 8953,
"all": 30855,
"common": 1437
},2.4. Top pages
The SerpstatDomainProcedure.getTopUrls method returns website pages in hierarchical order. Also, it shows the number of keywords from Google top-100 for each URL, approximate traffic of the page and Facebook shares. The data set is similar to the Top pages report of the Domain Analysis.
General request parameters and instructions for using Serpstat API
Search databases available
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 | Optional | Default value | Value options |
| id | A request id: the response contains the same id. Enter any number (number) or text (string) value | no |
| 1, test |
| method | API method name | no |
| SerpstatDomainProcedure.getTopUrls |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no |
|
|
| domain | Domain name | no |
| nike.com |
| se | ID of the search base to be searched. | no |
| g_us |
| sort | Sort order of the results in the format: field - field to sort by: order - sort direction (asc - ascending, desc - descending) | yes | {"organic_keywords":"desc"} | {"organic_keywords":"asc"} |
| filters | Filter conditions | yes |
| "url_prefix": "https://www.apple.com/shop/buy-ipad" "url_contain": "buy-ipad" "url_not_contain": "buy-watch" "url": "https://www.apple.com/shop/watch/accessories" "minus_url": "https://www.apple.com/shop/iphone/accessories" "pm_url": "https://www.apple.com/" |
| page | Page number in response | yes | 1 | "page": "1" |
| size | Number of results per page in response | yes | 100 | "size": "50" min: 50, max: 1000 |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| url | URL of the domain |
| organic_keywords | The number of keywords the URL ranks for in Google top-100 results |
| facebook_shares | The number of Facebook shares of the researched domain's page |
| potential_traff | The approximate traffic of the page by keywords depending on its volume and position |
| summary_info | Object with data |
| page | Page number |
| total | Total number of found results |
| left_lines | API credits remaining |
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:
{
"url": "https://www.nike.com/id/w/nike-by-you-running-shoes-37v7jz6ealhzy7ok",
"organic_keywords": 39,
"facebook_shares": 0,
"potencial_traff": 540
},2.5. Domain vs Domain
The SerpstatDomainProcedure.getDomainsIntersection method returns common keywords of up to 3 domains. The data set is similar to the Domain vs domain report.
General request parameters and instructions for using Serpstat API
Search databases available
| Request parameters | ||||
| Parameter | Description | Optional | Default value | Value options |
| id | A request id: the response contains the same id. Enter any number (number) or text (string) value | no | 1, test | |
| method | API method name | no |
| SerpstatDomainProcedure.getDomainsIntersection |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no |
|
|
| domains | Array of domains (min2, max3) | no | - | ["starbucks.com", "apple.com"] |
| se | ID of the search base to be searched. | no | - | g_us |
| page | Page number in response | yes | 1 | "page": "5" |
| size | Number of results per page in response | yes | 100 | "size": "10" |
| filters | Filter conditions | yes | true;false | "right_spelling": true "misspelled": false "cost": 15 "concurrency": 50 "difficulty": 3 "region_queries_count": 10000 "region_queries_count_wide": 10000 "keyword_length": 1 "traff": 3000 "position": 1 "keywords": [ "iphone", "iphone x"] "minus_keywords": [ "ipad", "iphone xr"]
|
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| region_queries_count | Search volume in selected region |
| types | List of special elements shown in SERP (for example, video, carousel or map) |
| cost | Cost per click, $ |
| keyword_length | Number of words divided by space in a keyword |
| concurrency | Keyword competition in the PPC (0-100%) |
| geo_names | List of toponyms in the array (if toponyms are present in the keywords) |
| traff | Estimated search traffic based on keyword positions and search volume |
| region_queries_count_wide | Search volume (broad match) |
| keyword | Keyword ranking the given website |
| found_results | Number of results found for the keyword |
| domain 1,2,3 | Domain which ranks for the keyword (1,2,3) |
| subdomain 1,2,3 | Subdomain which ranks for the keyword (1,2,3) |
| url 1,2,3 | URL of a page which appears in SERP for the keyword (1,2,3) |
| position 1,2,3 | Positions of the compared domains for a given keyword (1,2,3) |
| dynamic 1,2,3 | How the position of the domain (1,2,3) by this keyword has changed |
| summary_info | Object with data |
| page | Номер страницы |
| total | Number of found common keywords |
| left_lines | API credits remaining |
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:
{
"region_queries_count": 1,
"types": [
"video",
"related_search",
"also_asks",
"snip_breadcrumbs"
],
"cost": 0,
"keyword_length": 6,
"concurrency": 0,
"geo_names": [],
"traff": 0,
"region_queries_count_wide": 0,
"keyword": "shoes youth size 8 on sale",
"found_results": 688000000,
"domain3": "puma.com",
"subdomain3": "us.puma.com",
"url3": "https://us.puma.com/en/us/kids",
"position3": 35,
"dynamic3": -17,
"domain1": "nike.com",
"subdomain1": "www.nike.com",
"url1": "https://www.nike.com/w/boys-sale-shoes-1onraz3yaepzy7ok",
"position1": 18,
"dynamic1": null,
"domain2": "adidas.com",
"subdomain2": "www.adidas.com",
"url2": "https://www.adidas.com/us/kids-youth-shoes",
"position2": 28,
"dynamic2": -10
},2.6. Domains' unique keywords
The SerpstatDomainProcedure.getDomainsUniqKeywords method returns unique keywords of two domains that the third domain does not rank for. The data set is similar to the Domain vs domain report.
General request parameters and instructions for using Serpstat API
Search databases available
| Request parameters | ||||
| Parameter | Description | Optional | Default value | Value Options |
| id | A request id: the response contains the same id. Enter any number (number) or text (string) value | no | 1, test | |
| method | API method name | no | SerpstatDomainProcedure.getDomainsUniqKeywords | |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no | ||
| domains | Array of domains (min 1, max 2) | no | ["nike.com", "adidas.com"] | |
| minusDomain | Domain with keywords which must not intersect domains parameters | no | puma.com | |
| se | ID of the search base to be searched. | no | g_us | |
| filters | Filter conditions | no |
| "right_spelling": false "misspelled": false "keywords": [ "red", "iphone"] "minus_keywords": ["blackberry", "nokia"] "queries": 400 "cost": 40 "concurrency": 30 "difficulty": 20 "region_queries_count": 10 "region_queries_count_wide": 100 "keyword_length": 1 "traff": 100 "position": 1 |
| page | Page number in response | yes | 1 | "page": "5" |
| size | Number of results per page in response | yes | 100 | "size": "10" |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| date | Search result issue date |
| region_queries_count | Search volume in selected region |
| types | List of special elements shown in SERP (for example, video, carousel or map) |
| cost | Cost per click, $ |
| keyword_length | Number of words divided by space in a keyword |
| url | URLs displayed in SERP by the given keyword |
| concurrency | Keyword competition in PPC (0-100%) |
| difficulty | The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 0 to 100%) |
| geo_names | List of toponyms in the array (if toponyms are present in the keywords) |
| right_spelling | Recommended correction of a misspelled keyword |
| traff | Approximate traffic by keyword depending on its volume and position |
| region_queries_count_wide | Search volume (broad match) |
| domain | Analyzed domain |
| subdomain | Subdomain displayed in search result by the given keyword |
| dynamic | Position change for the keyword |
| position | Domain's position for a keyword |
| keyword | Keyword which the domain ranks for |
| found_results | Number of results found for keyword |
| domain.com | Positions of the analyzed domains for a keyword |
| summary_info | Object with data |
| page | Page number |
| total | Number of found keywords |
| left_lines | API credits remaining |
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:
{
"date": "2020-05-01",
"region_queries_count": 3600,
"types": [
"kn_graph_carousel_list",
"pic",
"related_search",
"snip_breadcrumbs"
],
"cost": 0.53000000000000003,
"keyword_length": 1,
"url": "https://www.nike.com/w/womens-hoodies-pullovers-5e1x6z6rive",
"concurrency": 100,
"difficulty": 19.431026858090227,
"geo_names": [],
"right_spelling": "long hoodie",
"traff": 0,
"region_queries_count_wide": 0,
"domain": "nike.com",
"subdomain": "www.nike.com",
"dynamic": null,
"position": 55,
"keyword": "longhoodie",
"found_results": 628000000,
"adidas.com": 11,
"nike.com": 55
},2.7. Сompetitors in organic search results
The SerpstatDomainProcedure.getCompetitors method brings in the list of domain competitors in top 20 Google search results. The data set is similar to the Competitors report of the domain.
General request parameters and instructions for using Serpstat API
Search databases available
| Request parameters | ||||
| Parameter | Description | Optional | Default value | Value options |
| id | A request id: the response contains the same id. Enter any number (number) or text (string) value | no | 1, test | |
| method | API method name | no | SerpstatDomainProcedure.getCompetitors | |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no |
|
|
| domain | Domain name | no | - | nike.com |
| se | ID of the search base to be searched. | no | - | g_us |
| sort | Order of sorting the results in the format: {{{field}}: {{order}}} | yes | {"relevance":"desc"} | {"ads":"desc"} |
| page | Page number in response | yes | 1 | "page": "1" |
| size | Number of results per page in response | yes | 100 | "size": "50" |
| filters | Filter conditions | yes |
| "visible": 35 "traff": 1000 "minus_domains": ["domain.com". "domain2.com] "exluded_competitors": ["domain.com". "domain2.com] "keywords": 1000 relevance : 10 |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| visible | Site visibility |
| domain | Domain |
| keywords | Number of keywords found in the chosen search engine |
| traff | Approximate traffic by keyword depending on its volume and position |
| visible_dynamic | Dynamics of visibility since the last update |
| keywords_dynamic | Dynamics of the number of keywords since the last update |
| traff_dynamic | Dynamics of estimate traffic since the last update |
| ads_dynamic | Dynamics of changes in PPC Ads |
| new_keywords | Number of new keywords for the domain since the last monitoring |
| out_keywords | Number of keywords lost by a domain since the last monitoring |
| rised_keywords | Number of domain keywords for which positions have improved since the last monitoring |
| down_keywords | Number of domain keywords for which positions have dropped since the last monitoring |
| ad_keywords | Number of keywords in the PPC |
| ads | Number of ads |
| intersected | Keywords domains have in common |
| not_intersected | Number of missed keywords of the domain that the competing domain ranks for |
| relevance | Relevance - calculates the percentage of similar keywords domains share (0-100%) |
| summary_info | Object with data |
| page | Page number |
| left_lines | API credits remaining |
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:
{
"domain": "thesolesupplier.co.uk",
"visible": 1.57363,
"keywords": 273939,
"traff": 987621,
"visible_dynamic": 0.21043000000000012,
"keywords_dynamic": 2761,
"traff_dynamic": 82601,
"ads_dynamic": 0,
"new_keywords": 6341,
"out_keywords": 3580,
"rised_keywords": 11264,
"down_keywords": 6878,
"ad_keywords": 0,
"ads": 0,
"intersected": 192486,
"not_intersected": 81453,
"relevance": 70.27,
"new_relevance": 7.04,
"our_relevance": 7.26
},2.8. Domain ads
The SerpstatDomainProcedure.getAdKeywords method returns paid keywords and ads copies that pop up for the queried domain in paid search results. The data set is similar to the Domain analysis — PPC research — Keywords report.
General request parameters and instructions for using Serpstat API
Search databases available
| Request parameters | ||||
| Parameter | Value | Optional | Default value | Value Options |
| id | A request id: the response contains the same id. Enter any number (number) or text (string) value | no | 1, test | |
| method | API method name | no | SerpstatDomainProcedure.getAdKeywords | |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no | ||
| domain | Domain name | no | nike.com | |
| se | ID of the search base to be searched. | no | g_us | |
| url | Link to refine your search | yes |
| https://www.nike.com/nike-by-you |
| keywords | Array of keywords to search for | yes | [] | ["nike", "id"] |
| minusKeywords | Negative keyword array | yes | [] | ["nikeid"] |
| filters | Filter conditions | yes |
| { "concurrency_from": "0", "concurrency_to": "1" } |
| sort | Order of sorting the results in the format: 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 | "page": "1" |
| size | Number of results per page in response | yes | 100 | "size": "50" |
| filters | Filter conditions | yes |
| "position": 1 "queries": 5; "region_queries_count": "1000"; "region_queries_count_wide": "1000"; "cost": "10"; "concurrency": "7"; "difficulty": 3; "minus_url": https://www.apple.com/airpods-2nd-generation/ "pm_url": https://www.apple.com/airpods/ "right_spelling": true$ "right_spelling": false "misspelled": true$ "misspelled": false |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| keyword | Keyword the analyzed domain bids on in Google Ads |
| keyword_length | Number of words divided by space in a keyword |
| domain | Analyzed domain |
| subdomain | Subdomain of the analyzed domain |
| url | URL where the ad leads |
| title | Ad Title |
| text | Ad text |
| position | Ad position |
| type | Ad placement type in relation to SERP (1 - above; 2 - under; 3 - side) |
| cost | |
| concurrency | Competition in Google Ads (0-100%) |
| found_results | Number of results found for the |
| region_queries_count | Search volume in selected search engine database |
| 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) |
| difficulty | The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 0 to 100%) |
| summary_info | Object with data |
| page | Page number |
| total | Number of found results |
| left_lines | API credits remaining |
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": "customize id nike",
"keyword_length": 3,
"domain": "nike.com",
"subdomain": "www.nike.com",
"url": "https://www.nike.com/nike-by-you",
"title": "Custom Nike Shoes - Nike By You Shoe Customizer",
"text": "Pick From Your Favorite Nike Styles & Color Them To Reflect Your Unique Personality.",
"position": 1,
"type": "1",
"cost": 2.54,
"concurrency": 59,
"found_results": 24800000,
"region_queries_count": 320,
"region_queries_count_wide": 0,
"types": [
"ads_top",
"also_asks"
],
"geo_names": [],
"difficulty": 60.572786294554405
},2.9. List of domain URLs
The SerpstatDomainProcedure.getDomainUrls method returns the list of URLs within the analyzed domain and the number of keywords for each URL. The data set is similar to the Top pages report of the Domain Analysis, excluding the information about traffic and number of Facebook shares.
General request parameters and instructions for using Serpstat API
Search databases available
| Request parameters | ||||
| Parameter | Description | Optional | Default value | Value options |
| id | A request id: the response contains the same id. Enter any number (number) or text (string) value | no | 1, test | |
| method | API method name | no |
| SerpstatDomainProcedure. |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no |
| |
| domain | Domain name | no | - | nike.com |
| se | ID of the search base to be searched. | no | - | g_us |
| sort | Order of sorting the results in the format: {{{field}}: {{order}}} | yes | {"keywords":"desc"} | {"keywords":"asc"} |
| page | Page number in response | yes | 1 | "page": "5" |
| size | Number of results per page in response | yes | 100 | "size": "3" |
| filters | Filter conditions | yes |
| {"url_prefix": "https://www.apple.com/ipad/"} {"url_contain": "/ipad/"} {"url_not_contain": "/mac/"} |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| url | Domain's URL |
| keywords | Number of keywords which the URL ranks for |
| summary_info | Object with data |
| page | Page number |
| total | Number of found URLs |
| left_lines | API credits remaining |
Part of the API response, for which 1 credit is charged:
{
"url": "https://www.nike.com/",
"keywords": 64785
},2.92. Domain traffic in Serpstat databases
The SerpstatDomainProcedure.getAllRegionsTraffic method returns an array with information about the amount of traffic by domain in Serpstat databases. Databases with a number of keywords equal to zero are not shown in the response.
General request parameters and instructions for using Serpstat API
Search databases available
| Request parameters | |||||
| Parameter | Description | Type | Optional | Default value | Value options |
| id | A request id: the response contains the same id. | int/string | no | Any number or string | |
| method | API method name | string | no | SerpstatDomainProcedure.getAllRegionsTraffic | |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no | |||
| domain | Domain name | string | no | binance.com | |
| sort | Sort by data (ascending and descending) | array | yes | "traff" | "traff" - The amount of traffic in the database "region" - region name (example: ua, us, uk, pl etc.) "country_name_en" - The name of the country of the search engine "google_domain" - The domain name of the search engine (example: google.com.ua) |
| order | sort direction | string | yes | "desc" | "order": "desc" / "asc" — sort direction (asc — ascending, desc — descending) |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| country_name_en | Name of the database's country |
| region | Domain's region |
| traffic | The amount of traffic in the database |
| google_domain | The domain name of a search engine |
| summary_info | Object with data |
| analysed_domain | Analyzed domain |
| sort | Order of sorting the results |
| order | Sorting direction (asc - ascending, desc - descending) |
| regions_db_count | Number of the database's in the search result |
| total_keywords | Sum of the keywords in all databases |
| left_lines | API credits remaining |
Credits: the number of credits corresponds to the number of databases received in response to the request (at least 1 credit per request). Part of the API response for which you spend 1 credit:
"g_sc": {
"country_name_en": "Seychelles",
"region": "sc",
"traff": 97,
"google_domain": "google.sc"
},2.93. Number of domain keywords within regional Serpstat databases
The SerpstatDomainProcedure.getRegionsCount returns an array with information about the number of keys per domain in Serpstat databases. Databases with a number of keys equal to zero are not shown in the response.
General request parameters and instructions for using Serpstat API
Search databases available
| Request parameters | |||||
| Parameter | Description | Type | Optional | Default value | Value options |
| id | A request id: the response contains the same id. | int / str | no | Any number or string | |
| method | API method name | string | no | SerpstatDomainProcedure.getRegionsCount | |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no | |||
| domain | Domain name | string | no | ebay.com (Any domain name) | |
| sort | Sort by data (ascending and descending) | string | yes | "keywords_count" | "keywords_count" — Number of keywords in the database "db_name" — Name of the database "country_name_en" — Name of the database's country "google_domain" — Search engine domain name |
| order | Sort direction (asc — ascending, desc — descending) | array | yes | "desc" | "order": "desc" / "asc" |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| country_name_en | Name of the database's country |
| db_name | Name of the database |
| domain | Analyzed domain name |
| keywords_count | Number of keywords in the database |
| summary_info | Object with data |
| analysed_domain | Analyzed domain |
| sort | Order of sorting the results |
| order | Sorting direction (asc - ascending, desc - descending) |
| regions_db_count | Number of the database's in the search result |
| total_keywords | Sum of the keywords in all databases |
| left_lines | API credits remaining |
1 API credit is spent per 1 database. Part of the API response for which you spend 1 credit:
{
"country_name_en": "France",
"db_name": "g_fr",
"domain": "google.fr",
"keywords_count": 1329046
},