Creates a list of the top 100 ranking paths for the given DOMAIN, HOST. For each result, the number of TOP10 and TOP100 keywords is displayed together with the share (%) of the visibility index of the entire domain or host. The number of displayed paths can be adjusted using the limit parameter, and the offset parameter allows you to change the starting rank of the displayed paths. The country for which the paths are ranked can be modified using the country parameter.
Result
The results contain a list of paths (path), including the count of top 10 ranking keywords (top10), the count of top 100 ranking keywords (top100), and the percentage of the overall visibility index for each corresponding path within the given domain or path.GET-Parameters
Parameters (Mandatory)
api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.
address_object (domain/host)
STRING
Defines the domain or host to which the method is applied, depending on the key value provided.
Parameters (Optional)
country
STRING / countrycode
Defines the country for which the method will be executed. You can find a list of available country codes here. If no Country parameter is provided, the default country associated with the Toolbox account will be used.
limit
INTEGER
Specifies the maximum number of paths to be displayed in the result. By default, this parameter is set to 100, limiting the number of top-ranking paths returned by the function.
offset
INTEGER
Defines the starting rank for the displayed paths. This parameter allows you to skip a specified number of top-ranking paths and begin the list from a different rank. For example, an offset of 10 starts the list at the 11th highest-ranking path.
format
STRING
Specifies whether the response will be returned in XML or JSON format. By default, the result will be in XML format.
To be able to use the API documentation with real data, you have to create an API key in your account.
EXAMPLE
$baseUrl = "https://api.sistrix.com/domain.paths";
$post = [
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);import requests
baseUrl = 'https://api.sistrix.com/domain.paths'
post = {
}
response = requests.post(baseUrl, post)
data = response.textcurl https://api.sistrix.com/domain.paths \
let baseUrl = 'https://api.sistrix.com/domain.paths';
let form = new FormData();
fetch(baseUrl, {
method: 'POST',
body: form
}).then(function(response){
return response.text();
}).then(function(data){
//data contains the results of the request
})
