serp/google/dataset_info/live/advanced

Live Google Dataset Info Advanced

‌
Live Google Dataset Info provides real-time data on the dataset you specify in the request. You will get data from a page of the dataset displayed separately from the SERP. It contains information about dataset content, authors, licenses, and description on the SERP.

POST

Your account will be charged for each request.
The cost can be calculated on the Pricing page.

All POST data should be sent in the JSON format (UTF-8 encoding). When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute, each Live SERP API call can contain only one task.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name	Type	Description
`dataset_id`	string	ID of the dataset required field you can find dataset ID in the dataset URL or `dataset` item of Google Dataset Search result example: `L2cvMTFqbl85ZHN6MQ==`
`language_name`	string	full name of search engine language optional field if you use this field, you don’t need to specify `language_code` possible value: `English`
`language_code`	string	search engine language code optional field if you use this field, you don’t need to specify `language_name` possible value: `en`
`device`	string	device type optional field possible value: `desktop`
`os`	string	device operating system optional field possible values: `windows`, `macos` default value: `windows`
`tag`	string	user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response

‌‌‌
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
`keyword`	string	keyword received in a POST array the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)
`se_domain`	string	search engine domain in a POST array
`language_code`	string	language code in a POST array
`check_url`	string	direct URL to search engine results you can use it to make sure that we provided accurate results
`datetime`	string	date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00`
`spell`	object	autocorrection of the search engine if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection
`refinement_chips`	object	search refinement chips
`item_types`	array	types of search results in SERP contains types of search results (`items`) found in SERP. possible item type: `dataset`
`se_results_count`	integer	total number of results in SERP
`items_count`	integer	the number of results returned in the `items`* array*
`items`	array	elements of search results found in SERP
`type`	string	type of element = ‘dataset’
`rank_group`	integer	group rank in SERP position within a group of elements with identical `type` values positions of elements with different `type` values are omitted from `rank_group`
`rank_absolute`	integer	absolute rank in SERP absolute position among all the elements in SERP
`position`	string	the alignment of the element in SERP can take the following values: `left`, `right`
`xpath`	string	the XPath of the element
`dataset_id`	string	ID of the dataset
`title`	string	title of the result in SERP
`image_url`	string	URL of the image the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
`scholarly_citations_count`	integer	count of articles that refer to the dataset
`links`	array	sitelinks the links shown below some of Google Dataset’s search results if there are none, equals `null`
`type`	string	type of element = ‘link_element‘
`title`	string	title of the result in SERP
`description`	string	description of the results element in SERP
`url`	string	sitelink URL
`domain`	string	domain in SERP
`dataset_providers`	array	the list of institutions that provided the dataset
`type`	string	type of element = ‘dataset_providers_element‘
`title`	string	name of the dataset provider
`url`	string	site URL of the dataset provider
`domain`	string	site domain of the dataset provider
`formats`	array	the list of file formats of the dataset
`type`	string	type of element = ‘formats_element‘
`format`	string	type of file format of the dataset foe example: `zip`, `html`, `csv`
`size`	string	file size in bytes
`authors`	array	the list of authors of the dataset
`type`	string	type of element = ‘authors_element‘
`name`	string	name of the dataset author
`url`	string	author’s link URL
`domain`	string	author’s link domain
`licenses`	array	the list of licenses issued to the dataset
`type`	string	type of element = ‘licenses_element‘
`title`	string	name of the license
`url`	string	license URL
`domain`	string	domain where an URL points
`updated_date`	string	date and time when the result was last updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2022-11-27 02:00:00 +00:00`
`area_covered`	array	the list of areas covered in the dataset for example: `Africa`, `Global`
`period_covered`	object	period covered in the dataset
`start_date`	string	date and time when the period starts in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2020-03-02 02:00:00 +00:00`
`end_date`	string	date and time when the period ends in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2022-12-09 02:00:00 +00:00`
`displayed_date`	string	period displayed in SERP example: `Mar 2, 2020 - Dec 9, 2022`
`dataset_description`	object	description of the dataset
`text`	string	text of the description
`links`	array	links featured in the ‘dataset_description’
`type`	string	type of element = ‘link_element‘
`title`	string	link anchor text
`description`	string	description of the results element in SERP
`url`	string	URL link
`domain`	string	domain in SERP

‌‌

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

# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access 
login="login" 
password="password" 
cred="$(printf ${login}:${password} | base64)" 
curl --location --request POST "https://api.dataforseo.com/v3/serp/google/dataset_info/live/advanced" 
--header "Authorization: Basic ${cred}"  
--header "Content-Type: application/json" 
--data-raw "[
    {
        "dataset_id": "L2cvMTFqbl85ZHN6MQ=="
    }
]"

<?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-access
    $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();
}
$post_array = array();
// You can set only one task at a time
$post_array[] = array(
    "dataset_id" => "L2cvMTFqbl85ZHN6MQ=="
);
try {
    // POST /v3/serp/google/dataset_info/live/advanced
    // in addition to 'google' and 'dataset_info' you can also set other search engine and type parameters
    // the full list of possible parameters is available in documentation
    $result = $client->post('/v3/serp/google/dataset_info/live/advanced', $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;
?>

const axios = require('axios');

axios({
    method: 'post',
    url: 'https://api.dataforseo.com/v3/serp/google/dataset_info/live/advanced',
    auth: {
        username: 'login',
        password: 'password'
    },
    data: [{
        "dataset_id" => "L2cvMTFqbl85ZHN6MQ=="
    }],
    headers: {
        'content-type': 'application/json'
    }
}).then(function (response) {
    var result = response['data']['tasks'];
    // Result data
    console.log(result);
}).catch(function (error) {
    console.log(error);
});

from client import RestClient
# You can download this file from here https://cdn.dataforseo.com/v3/examples/python/python_Client.zip
client = RestClient("login", "password")
post_data = dict()
# You can set only one task at a time
post_data[len(post_data)] = dict(
dataset_id="L2cvMTFqbl85ZHN6MQ=="
)
# POST /v3/serp/google/dataset_info/live/advanced
# in addition to 'google' and 'dataset_info' you can also set other search engine and type parameters
# the full list of possible parameters is available in documentation
response = client.post("/v3/serp/google/dataset_info/live/advanced", post_data)
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response["status_code"] == 20000:
print(response)
# do something with result
else:
print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading.Tasks;

namespace DataForSeoDemos
{
    public static partial class Demos
    {
        public static async Task serp_live_advanced()
        {
            var httpClient = new HttpClient
            {
                BaseAddress = new Uri("https://api.dataforseo.com/"),
                // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
                //DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
            };
            var postData = new List<object>();
            // You can set only one task at a time
            postData.Add(new
            {
                dataset_id="L2cvMTFqbl85ZHN6MQ=="
            });
            // POST /v3/serp/google/dataset_info/live/advanced
            // in addition to 'google' and 'dataset_info' you can also set other search engine and type parameters
            // the full list of possible parameters is available in documentation
            var taskPostResponse = await httpClient.PostAsync("/v3/serp/google/dataset_info/live/advanced", new StringContent(JsonConvert.SerializeObject(postData)));
            var result = JsonConvert.DeserializeObject<dynamic>(await taskPostResponse.Content.ReadAsStringAsync());
            // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
            if (result.status_code == 20000)
            {
                // do something with result
                Console.WriteLine(result);
            }
            else
                Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
        }
    }
}

The above command returns JSON structured like this:

{
  "version": "0.1.20221214",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "12.0954 sec.",
  "cost": 0.002,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "01161747-1535-0139-0000-08e4f80efe02",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "12.0367 sec.",
      "cost": 0.002,
      "result_count": 1,
      "path": [
        "v3",
        "serp",
        "google",
        "dataset_info",
        "live",
        "advanced"
      ],
      "data": {
        "api": "serp",
        "function": "live",
        "se": "google",
        "se_type": "dataset_info",
        "dataset_id": "L2cvMTFqbl85ZHN6MQ==",
        "device": "desktop",
        "os": "windows"
      },
      "result": [
        {
          "keyword": "L2cvMTFqbl85ZHN6MQ==",
          "se_domain": "datasetsearch.research.google.com",
          "language_code": "en",
          "check_url": "https://datasetsearch.research.google.com/search?docid=L2cvMTFqbl85ZHN6MQ%3D%3D&hl=en",
          "datetime": "2023-01-16 15:48:06 +00:00",
          "spell": null,
          "refinement_chips": null,
          "item_types": [
            "dataset"
          ],
          "se_results_count": 1,
          "items_count": 1,
          "items": [
            {
              "type": "dataset",
              "rank_group": 1,
              "rank_absolute": 1,
              "position": "left",
              "xpath": null,
              "dataset_id": "L2cvMTFqbl85ZHN6MQ==",
              "title": "Water quality in Canadian rivers – Federal data files",
              "image_url": "https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcRSk0xXK2Wz-UFr7EbQBu8SrSbLPM82jfh3zL_BybsBwBiVnIzF",
              "scholarly_citations_count": 1,
              "links": [
                {
                  "type": "link_element",
                  "title": "canada.ca",
                  "description": null,
                  "url": "http://open.canada.ca/",
                  "domain": "open.canada.ca"
                }
              ],
              "dataset_providers": [
                {
                  "type": "dataset_providers_element",
                  "title": "Environment and Climate Change Canada",
                  "url": "http://www.ec.gc.ca/",
                  "domain": "www.ec.gc.ca"
                }
              ],
              "formats": [
                {
                  "type": "formats_element",
                  "format": "html",
                  "size": null
                },
                {
                  "type": "formats_element",
                  "format": "csv",
                  "size": null
                }
              ],
              "authors": null,
              "licenses": [
                {
                  "type": "licenses_element",
                  "title": "Open Government Licence - Canada 2.0",
                  "url": "https://open.canada.ca/en/open-government-licence-canada",
                  "domain": "open.canada.ca"
                }
              ],
              "updated_date": "2019-06-24 03:00:00 +00:00",
              "area_covered": null,
              "period_covered": {
                "start_date": "2002-01-01 02:00:00 +00:00",
                "end_date": "2017-12-31 02:00:00 +00:00",
                "displayed_date": "Jan 1, 2002 - Dec 31, 2017"
              },
              "dataset_description": {
                "text": "The Canadian Environmental Sustainability Indicators (CESI) program provides data and information to track Canada's performance on key environmental sustainability issues. The Water quality in Canadian rivers indicators provide a measure of the ability of river water across Canada to support plants and animals. At each monitoring site, water quality data are compared to water quality guidelines to create a rating for the site. If measured water quality is below the guidelines, it can maintain a healthy ecosystem. Water quality at a monitoring site is considered excellent when parameters in a river very rarely exceed their guidelines. Conversely, water quality is rated poor when parameters usually exceed their guidelines, sometimes by a wide margin. These indicators provide information about the state of surface water quality and its change through time, to support water resource management. Information is provided to Canadians in a number of formats including: static and interactive maps, charts and graphs, HTML and CSV data tables and downloadable reports. See the supplementary documentation for the data sources and details on how the data were collected and how the indicator was calculated. Supplemental Information Canadian Environmental Sustainability Indicators - Home page: https://www.canada.ca/environmental-indicatorsn",
                "links": [
                  {
                    "type": "link_element",
                    "title": "https://www.canada.ca/environmental-indicators",
                    "description": null,
                    "url": "https://www.google.com/url?q=https%3A%2F%2Fwww.canada.ca%2Fenvironmental-indicators&source=datasetsearch",
                    "domain": null
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}