project.ranking

project.ranking

Lists the rankings registered in the specified project, including their positions, traffic, and key metrics. The output can be limited using the LIMIT parameter. You can control where the list starts by using the OFFSET parameter. To filter the results to display only rankings associated with a specific tag, use the TAG parameter.

Result

The result contains the total number of rankings within the given project (count) and includes a list of these rankings. Each ranking provides details such as the keyword (keyword), its position (position), the URL (url), associated tags (tags), the device used (device), the country (country), the traffic generated by the keyword (traffic), and the search engine (searchengine) used.

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.

Parameters (Optional)

limit
INTEGER
Specifies the maximum number of rankings to be displayed in the result. By default, this parameter is set to 100, limiting the number of rankings returned by the function.
offset
INTEGER
Defines the starting position for the displayed results. This parameter allows you to skip a specified number of results and begin the list from a different position. For example, an offset of 10 starts the list at the 11th result.
tag
STRING
Filters the rankings based on one or more tags. When specifying multiple tags, separate them with a "|".
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.ranking";

$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.ranking'

post = {



}

response = requests.post(baseUrl, post)

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


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

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

})