project.onpage.overview

Returns a overview of on-page crawl data for the project. This overview includes a list of completed crawls, with each entry providing the timestamp, the total number of pages crawled, and a summary of errors, warnings, or notes detected during that specific crawl.

Result

The result contains a list of on-page crawls for the given project. Each crawl includes its crawl date (time), the number of crawled pages (pages), and the amount of detected errors (error), warnings (warnings), and notices (notice).

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)

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.

api_key

project

format (Optional)

STRING

EXAMPLE

$baseUrl = "https://api.sistrix.com/project.onpage.overview";

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

post = {



}

response = requests.post(baseUrl, post)

data = response.text

curl https://api.sistrix.com/project.onpage.overview \

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

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

})