NAVNavbar
Logo
cURL php NodeJS Python cSharp

OnPage API Force Stop

‌‌
This endpoint is designed to force stop the crawl process of websites you specified in a task. The execution of all the tasks associated with the IDs indicated in your request to this endpoint will be stopped. You will still be able to obtain the data on pages that have been scanned until the crawling process was stopped.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');

$post_array = array();
// simple way to get a result
$post_array[] = array(
   "id" => "08121600-1535-0216-0000-37b4c7a34453"
);
try {
   // POST /v3/on_page/force_stop
   // the full list of possible parameters is available in documentation
   $result = $client->post('/v3/on_page/force_stop', $post_array);
   print_r($result);
   // do something with post result
} catch (RestClientException $e) {
   echo "n";
   print "HTTP code: {$e->getHttpCode()}n";
   print "Error code: {$e->getCode()}n";
   print "Message: {$e->getMessage()}n";
   print  $e->getTraceAsString();
   echo "n";
}

$client = null;
?>

The above command returns JSON structured like this:

{
    "version": "0.1.20210805",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "0.1008 sec.",
    "cost": 0,
    "tasks_count": 2,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "08121600-1535-0216-0000-37b4c7a34453",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "0.0112 sec.",
            "cost": 0,
            "result_count": 0,
            "path": [
                "v3",
                "on_page",
                "force_stop"
            ],
            "data": {
                "api": "on_page",
                "function": "force_stop",
                "target": "em-autoteile.de",
                "max_crawl_pages": 10,
                "enable_javascript": true,
                "load_resources": true,
                "allow_subdomains": true
            },
            "result": null
        },
        {
            "id": "08121600-1535-0216-0000-d6a5000b6897",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "0.0227 sec.",
            "cost": 0,
            "result_count": 0,
            "path": [
                "v3",
                "on_page",
                "force_stop"
            ],
            "data": {
                "api": "on_page",
                "function": "force_stop",
                "target": "dataforseo.com",
                "max_crawl_pages": 10,
                "enable_javascript": true,
                "load_resources": true,
                "allow_subdomains": true
            },
            "result": null
        }
    ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array.

Description of the fields for setting a task:

Field name Type Description
id string ID of the task
required field
you can get this ID in the response of the Task POST endpoint
example:
“07131248-1535-0216-1000-17384017ad04”

note: you can set up to 1000 id values as separate objects in the POST array

‌‌‌‌‌‌
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code integer general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code integer status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of the response codes here
        status_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results

‌‌