Provides a list of keyword opportunities for the given DOMAIN, HOST, PATH, or URL. These keywords are ones where the domain does not currently rank on the first page of Google search results but could potentially achieve that position with effective optimization. The number and position of results can be adjusted using the limit and offset parameters. Additionally, you can modify the country and device settings using the country and mobile parameters.
Result
The results contain a list of keywords, each showing the domain for which it represents an opportunity (domain). The gain (gain) indicates which keywords offer the best chance of generating traffic with minimal optimization effort, on a scale from 0 to 100. Additionally, you receive the ranking position of each keyword for the given domain, host, path, or URL (position), the corresponding URL that is ranking (url), and the competition level for that keyword (competition).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
STRING
Defines the domain, host, path, or URL 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.
mobile
BOOLEAN
Defines whether mobile or desktop data should be returned. By default, this parameter is set to TRUE, meaning mobile data will be returned. If set to FALSE, only desktop data will be returned.
limit
INTEGER
Specifies the maximum number of keyword opportunities to be returned. By default, this is set to 100. Adjusting this parameter changes the number of results displayed.
offset
INTEGER
Specifies the starting point in the list of keyword opportunities. This allows you to skip a certain number of results and retrieve the next set of data. For example, setting offset to 10 will start returning results from the 11th position onward.
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.opportunities";
$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.opportunities'
post = {
}
response = requests.post(baseUrl, post)
data = response.textcurl https://api.sistrix.com/domain.opportunities \
let baseUrl = 'https://api.sistrix.com/domain.opportunities';
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
})
