The marketplace.serp.history function returns all known products for the specified keyword. Historical results, as well as results from a specific time period, can also be requested. Additionally, detailed information about individual products can be displayed.
Result
The result contains a list of SERPs for the given keyword. Each SERP includes the date (date) when the SERP was found, the position of the SERP (position), an indication of whether the position is organic (organic_position) or sponsored (product_position), and the product ASIN (asin).GET-Parameters
Parameters (Mandatory)
api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.
kw
STRING
The keyword parameter specifies the search term for which the serp history will be returned.
Parameters (Optional)
from
DATE
Sets the earliest month for which data can be retrieved in the format YYYY-MM.
to
DATE
Sets the latest month for which data will be retrieved in the format YYYY-MM.
num_dates
INTEGER
Specifies the number of different dates for which SERPs will be displayed. If this parameter is not provided, the default value will be 1.
details
BOOLEAN
If set to true, the product title and brand name will be included for each displayed product.
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/marketplace.serp.history";
$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/marketplace.serp.history'
post = {
}
response = requests.post(baseUrl, post)
data = response.textcurl https://api.sistrix.com/marketplace.serp.history \
let baseUrl = 'https://api.sistrix.com/marketplace.serp.history';
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
})
