Displays the AdWords rankings, including position, competition, and traffic information for the specified DOMAIN, HOST, PATH, or URL. Use the DATE parameter to retrieve data for a specific week. Adjust the number of keywords returned with the LIMIT parameter and filter by specific terms using the SEARCH parameter. For mobile or desktop data, set the MOBILE parameter. To select the country, use the COUNTRY parameter.
Result
The result contains a list of AdWord rankings for the given domain, path, host, or URL. Each AdWord ranking includes the keyword (kw), the position of the ranking (position), the competition level of the keyword (competition), and the keyword's traffic (traffic).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.
date
DATE
Specifies the week in which the keyword data should be retrieved, based on the provided date. The function will return the AdWord rankings for the week of the specified date. If no data is available for that week, the function will return an error.
limit
INTEGER
Specifies the maximum number of AdWords for the given DOMAIN to be displayed in the result. By default, this parameter is set to 10.000, limiting the number of AdWords returned by the function.
offset
INTEGER
Defines the starting position for the AdWords. This parameter allows you to skip a specified number of AdWords and begin the list from a different position. For example, an offset of 10 starts the list at the 11th keyword.
search
STRING
Allows you to filter the AdWords by a specific term. When a SEARCH term is provided, only the keywords containing this term will be returned. For example, if you set SEARCH to "shoes", the function will return only the AdWords that include "shoes".
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/keyword.domain.sem";
$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/keyword.domain.sem'
post = {
}
response = requests.post(baseUrl, post)
data = response.text
curl https://api.sistrix.com/keyword.domain.sem \
let baseUrl = 'https://api.sistrix.com/keyword.domain.sem';
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
})