DataForSEO Labs Google Available History
By calling this endpoint, you will find obtain a list of dates available for setting in the first_date
and second_date
fields of the Domain Metrics by Categories endpoint.
By calling this endpoint, you will find obtain a list of dates available for setting in the first_date
and second_date
fields of the Domain Metrics by Categories endpoint.
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 the list of dates supported in the Domain Metrics by Categories endpoint // GET /v3/dataforseo_labs/google/available_history $result = $client->get('/v3/dataforseo_labs/google/available_history'); 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.20220720", "status_code": 20000, "status_message": "Ok.", "time": "0.0577 sec.", "cost": 0, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "08111855-1535-0462-0000-edf04c21718d", "status_code": 20000, "status_message": "Ok.", "time": "0 sec.", "cost": 0, "result_count": 22, "path": [ "v3", "dataforseo_labs", "google", "available_history" ], "data": { "api": "dataforseo_labs", "function": "available_history", "se": "google" }, "result": [ { "date": "2022-07-01" }, { "date": "2022-06-01" }, { "date": "2022-05-01" }, { "date": "2022-04-01" }, { "date": "2022-03-01" }, { "date": "2022-02-01" }, { "date": "2022-01-01" }, { "date": "2021-12-01" }, { "date": "2021-11-01" }, { "date": "2021-10-01" }, { "date": "2021-09-01" }, { "date": "2021-08-01" }, { "date": "2021-07-01" }, { "date": "2021-06-01" }, { "date": "2021-05-01" }, { "date": "2021-04-01" }, { "date": "2021-03-01" }, { "date": "2021-02-01" }, { "date": "2021-01-01" }, { "date": "2020-12-01" }, { "date": "2020-11-01" }, { "date": "2020-10-01" } ] } ] }
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.
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 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 | the data specified in the API call |
result |
array | array of objects containing results |
date |
string | available date indicates the date of the range available for setting in the Domain Metrics by Categories endpoint example: 2022-05-16 |