project.onpage.issue

project.onpage.issue

Provides detailed results from the latest on-page crawl for the project, focusing on specific issues. The ISSUE parameter allows you to retrieve detailed information, including the locations of issues, error codes, and other relevant details. Possible values for the ISSUE parameter can be obtained using the project.onpage.crawl function. Historical results can be accessed using the DATE parameter.

Result

The result contains a detailed list of all identified issues for the specified issue in the selected crawl. Each issue includes information such as the "status_code," "url," and "link_from," among other details. The total number of found issues is provided under the key "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.
issue
STRING
Specifies the particular issue for which detailed information should be retrieved. Possible values for this parameter can be obtained using the project.onpage.crawl function.

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.
limit
INTEGER
Specifies the maximum number of issues 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.issue";

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

post = {



}

response = requests.post(baseUrl, post)

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


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

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

})