project.onpage.crawl

project.onpage.crawl

Provides a summary of the most recent on-page crawl for the project, listing the types and counts of errors and warnings found. This function offers an overview of the issues detected, but does not include detailed information on individual errors. Historical crawl summaries can be accessed using the DATE parameter.

Result

The result contains a list of errors and warnings identified during the crawl for the specified date. Each issue includes its type (either error or warning) (type), the name of the error/warning (name), and the total number of occurrences for that specific error or warning (count).

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)

date
DATE
Specifies the date of the on-page crawl to retrieve historical results. The date should be in ISO 8601 (YYY-MM-DD) format. If the specified date does not have crawl data, the function will return an error. You can obtain available crawl dates using the project.onpage.overview function.
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.crawl";

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

post = {



}

response = requests.post(baseUrl, post)

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


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

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

})