NAVNavbar
Logo
cURL php NodeJS Python cSharp

Get Search By Image SERP Completed Tasks


The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.

Learn more about task completion and obtaining a list of completed tasks in this help center article.

Note: due to the peculiarities of our architecture the queue of completed tasks is updated with a small delay, which can be an issue for high-volume users. If your system requires collecting over 1000 tasks a minute, we recommend using pingbacks/postbacks instead, and applying the Tasks Ready endpoint only to obtain the IDs of failed postback tasks.

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/';
try {
	// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
	$client = new RestClient($api_url, null, 'login', 'password');
} 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";
	exit();
}
try {
	// using this method you can get a list of completed tasks
	// GET /v3/serp/google/search_by_image/tasks_ready
	// in addition to 'google' and 'search_by_image' you can also set other search engine and type parameters
	// the full list of possible parameters is available in documentation
	$result = $client->get('/v3/serp/google/search_by_image/tasks_ready');
	print_r($result);
	// do something with 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.20200923",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.2642 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "10011344-1535-0087-0000-e6ae77da861f",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.1079 sec.",
      "cost": 0,
      "result_count": 3,
      "path": [
        "v3",
        "serp",
        "google",
        "search_by_image",
        "tasks_ready"
      ],
      "data": {
        "api": "serp",
        "function": "tasks_ready",
        "se": "google",
        "se_type": "search_by_image"
      },
      "result": [
        {
          "id": "09291644-1535-0066-0000-c326e67681f4",
          "se": "google",
          "se_type": "search_by_image",
          "date_posted": "2020-09-29 13:44:04 +00:00",
          "tag": "",
          "endpoint_regular": null,
          "endpoint_advanced": "/v3/serp/google/search_by_image/task_get/advanced/09291644-1535-0066-0000-c326e67681f4",
          "endpoint_html": null
        },
        {
          "id": "09291646-1535-0066-0000-14211f2e9b2e",
          "se": "google",
          "se_type": "search_by_image",
          "date_posted": "2020-09-29 13:46:56 +00:00",
          "tag": "",
          "endpoint_regular": null,
          "endpoint_advanced": "/v3/serp/google/search_by_image/task_get/advanced/09291646-1535-0066-0000-14211f2e9b2e",
          "endpoint_html": null
        },
        {
          "id": "09291647-1535-0066-1000-638d3dcef484",
          "se": "google",
          "se_type": "search_by_image",
          "date_posted": "2020-09-29 13:47:58 +00:00",
          "tag": "",
          "endpoint_regular": null,
          "endpoint_advanced": "/v3/serp/google/search_by_image/task_get/advanced/09291647-1535-0066-1000-638d3dcef484",
          "endpoint_html": null
        }
      ]
    }
  ]
}

Each separate task will remain on the list until it is collected. You can make up to 20 API calls per minute. With each API call, you can get 1000 tasks completed within three previous days. The list will not contain the tasks which have already been collected and the tasks that were not collected within three days after completion.

Please note that if you specify the postback_url, the task will not be in the list of completed tasks. The task can only be found in the list if the request to your server failed, and your server returned HTTP code response less than 200 or higher than 300.

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 parameters passed in the request’s URL
        result array array of results
            id string task identifier of the completed task
unique task identifier in our system in the UUID format
            se string search engine specified when setting the task
            se_type string type of search engine
can take the following values: search_by_image
            date_posted string date when the task was posted (in the UTC format)
            tag string user-defined task identifier
            endpoint_regular string URL for collecting the results of the SERP Regular task
if SERP Regular is not supported in the specified endpoint, the value will be null
            endpoint_advanced string URL for collecting the results of the SERP Advanced task
if SERP Advanced is not supported in the specified endpoint, the value will be null
            endpoint_html string URL for collecting the results of the SERP HTML task
if SERP HTML is not supported in the specified endpoint, the value will be null

‌‌