project.onpage.urls

project.onpage.urls

Provides a comprehensive list of all HTML pages crawled within the project. For each URL, details such as file size, title tag, and other relevant attributes are included. You can control the number of results returned using the LIMIT parameter and specify the starting point in the list with the OFFSET parameter.

Result

The results contain basic information about the crawled project, including the project hash (hash), the project name (name), and the total number of crawled URLs (count). Additionally, it provides a list of crawled URLs, with each URL including various details such as the URL score, title, size (in bytes), and more.

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 crawled pages to be displayed in the result. By default, this parameter is set to 100, limiting the number of results 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.
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.onpage.urls";

$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.onpage.urls'

post = {



}

response = requests.post(baseUrl, post)

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


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

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

})