On-Page Tasks Ready
The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks, which results haven’t been collected yet.
The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks, which results haven’t been collected yet.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
<?php // You can download this file from here https://api.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-access $client = new RestClient($api_url, null, 'login', 'password'); try { $result = array(); // #1 - using this method you can get a list of completed tasks // GET /v3/on_page/tasks_ready $tasks_ready = $client->get('/v3/on_page/tasks_ready'); // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors if (isset($tasks_ready['status_code']) AND $tasks_ready['status_code'] === 20000) { foreach ($tasks_ready['tasks'] as $task) { if (isset($task['result'])) { foreach ($task['result'] as $task_ready) { // #2 - using this method you can get results of each completed task // GET /v3/on_page/summary/$id if (isset($task_ready['id'])) { $result[] = $client->get('/v3/on_page/summary/' . $task_ready['id']); } } } } } 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.20200805", "status_code": 20000, "status_message": "Ok.", "time": "0.2772 sec.", "cost": 0, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "08071727-1535-0217-0000-1958f65eebb9", "status_code": 20000, "status_message": "Ok.", "time": "0.1982 sec.", "cost": 0, "result_count": 106, "path": [ "v3", "on_page", "tasks_ready" ], "data": { "api": "on_page", "function": "tasks_ready" }, "result": [ { "id": "08041601-1535-0216-0000-fc052fccbb0f", "target": "dataforseo.com", "date_posted": "2020-08-04 13:01:21 +00:00", "tag": "" }, { "id": "08041601-1535-0216-0000-fc052fccbb0f", "target": "dataforseo.com", "date_posted": "2020-08-04 13:01:21 +00:00", "tag": "" }, { "id": "08041601-1535-0216-0000-fc052fccbb0f", "target": "dataforseo.com", "date_posted": "2020-08-04 13:01:21 +00:00", "tag": "" }, { "id": "08041601-1535-0216-0000-fc052fccbb0f", "target": "dataforseo.com", "date_posted": "2020-08-04 13:01:21 +00:00", "tag": "" }, { "id": "08041601-1535-0216-0000-fc052fccbb0f", "target": "dataforseo.com", "date_posted": "2020-08-04 13:01:21 +00:00", "tag": "" }, { "id": "08041601-1535-0216-0000-fc052fccbb0f", "target": "dataforseo.com", "date_posted": "2020-08-04 13:01:21 +00:00", "tag": "" } ] } ] }
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.
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 for setting a task:
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 |
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 |
array | 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 |
target |
string | target website specified when setting a task |
date_posted |
string | date when the task was posted (in the UTC format) |
tag |
string | user-defined task identifier |