project.keyword.serps

project.keyword.serps

This function returns a list of SERPs for the specified keyword within the project. You can filter the results by using parameters such as country, city, device, search engine, and date.

Result

The result contains a list of keyword SERPs for the given keyword saved in the project. Each SERP includes its ranking position for the keyword (pos) and the corresponding target URL (url).

GET-Parameters

Parameters (Mandatory)

api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.
project
STRING
Specifies the unique hash used to identify a specific project. This hash can be obtained through the project.overview method.
kw
STRING
Defines the keyword to which the method is applied.

Parameters (Optional)

country
STRING
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.
city
STRING
Filters the SERPs based on the specified city.
device
STRING
Filters the SERPs based on the specified device.
searchengine
STRING
Filters the SERPs based on the specified search engine. If no search engine is provided, the default is set to Google.
date
DATE
Specifies the date for the SERPs to retrieve historical results. The date should be provided in ISO 8601 format (YYYY-MM-DD). If no SERP data is available for the specified date, the function will return an error.
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/project.keyword.serps";

$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/project.keyword.serps'

post = {



}

response = requests.post(baseUrl, post)

data = response.text
curl https://api.sistrix.com/project.keyword.serps \


let baseUrl = 'https://api.sistrix.com/project.keyword.serps';

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

})