project.start.onpage.check

Starts an on-page crawl for the given project. The costs for the URLs used in this crawl will be deducted from your SISTRIX account.

Result

The crawl is initiated successfully if no error message is returned. The result includes the project name (name) and the hash (hash) of the project for which the crawl was started

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.start.onpage.check";

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

post = {



}

response = requests.post(baseUrl, post)

data = response.text

curl https://api.sistrix.com/project.start.onpage.check \

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

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

})

Testing is not supported for this function.