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_traff | Sum of the traffic 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"
},
{
"id": 1,
"method": "SerpstatDomainProcedure.getAllRegionsTraffic",
"params": {
"domain": "serpstat.com",
"sort": "region",
"order": "asc"
}
}
"id": "1",
"result": {
"data": {
"g_ae": {
"country_name_en": "United Arab Emirates",
"region": "ae",
"traff": 152,
"google_domain": "google.ae"
},
"g_af": {
"country_name_en": "Afghanistan",
"region": "af",
"traff": 2,
"google_domain": "google.com.af"
},
"g_al": {
"country_name_en": "Albania",
"region": "al",
"traff": 22,
"google_domain": "google.al"
},
"g_sc": {
"country_name_en": "Seychelles",
"region": "sc",
"traff": 97,
"google_domain": "google.sc"
},
"g_gi": {
"country_name_en": "Gibraltar",
"region": "gi",
"traff": 106,
"google_domain": "google.com.gi"
},
},
"summary_info": {
"analysed_domain": "binance.com",
"sort": "traff",
"order": "asc",
"regions_count": 91,
"total_traff": 12700438,
"left_lines": 993607
}
}
}