Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"keyword": "water quality",
"last_updated": "1m",
"file_formats": [
"archive",
"image"
],
"usage_rights": "noncommercial",
"is_free": true,
"topics": [
"natural_sciences",
"geo"
]
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"file_formats": [
"archive",
"image"
],
"is_free": true,
"keyword": "water quality",
"last_updated": "1m",
"topics": [
"natural_sciences",
"geo"
],
"usage_rights": "noncommercial"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post"
payload = [
{
"file_formats": ["archive", "image"],
"is_free": True,
"keyword": "water quality",
"last_updated": "1m",
"topics": ["natural_sciences", "geo"],
"usage_rights": "noncommercial"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
file_formats: ['archive', 'image'],
is_free: true,
keyword: 'water quality',
last_updated: '1m',
topics: ['natural_sciences', 'geo'],
usage_rights: 'noncommercial'
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'file_formats' => [
'archive',
'image'
],
'is_free' => true,
'keyword' => 'water quality',
'last_updated' => '1m',
'topics' => [
'natural_sciences',
'geo'
],
'usage_rights' => 'noncommercial'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post"
payload := strings.NewReader("[\n {\n \"file_formats\": [\n \"archive\",\n \"image\"\n ],\n \"is_free\": true,\n \"keyword\": \"water quality\",\n \"last_updated\": \"1m\",\n \"topics\": [\n \"natural_sciences\",\n \"geo\"\n ],\n \"usage_rights\": \"noncommercial\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"file_formats\": [\n \"archive\",\n \"image\"\n ],\n \"is_free\": true,\n \"keyword\": \"water quality\",\n \"last_updated\": \"1m\",\n \"topics\": [\n \"natural_sciences\",\n \"geo\"\n ],\n \"usage_rights\": \"noncommercial\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"file_formats\": [\n \"archive\",\n \"image\"\n ],\n \"is_free\": true,\n \"keyword\": \"water quality\",\n \"last_updated\": \"1m\",\n \"topics\": [\n \"natural_sciences\",\n \"geo\"\n ],\n \"usage_rights\": \"noncommercial\"\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": {}
}
]
}Dataset Search
Setting Google Dataset Search Tasks
Queues datasets matching a query in Google Dataset Search on Google, returning a task id in tasks[0].
POST
https://api.aisa.one
/
apis
/
v1
/
dataforseo
/
serp
/
google
/
dataset_search
/
task_post
Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"keyword": "water quality",
"last_updated": "1m",
"file_formats": [
"archive",
"image"
],
"usage_rights": "noncommercial",
"is_free": true,
"topics": [
"natural_sciences",
"geo"
]
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"file_formats": [
"archive",
"image"
],
"is_free": true,
"keyword": "water quality",
"last_updated": "1m",
"topics": [
"natural_sciences",
"geo"
],
"usage_rights": "noncommercial"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post"
payload = [
{
"file_formats": ["archive", "image"],
"is_free": True,
"keyword": "water quality",
"last_updated": "1m",
"topics": ["natural_sciences", "geo"],
"usage_rights": "noncommercial"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
file_formats: ['archive', 'image'],
is_free: true,
keyword: 'water quality',
last_updated: '1m',
topics: ['natural_sciences', 'geo'],
usage_rights: 'noncommercial'
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'file_formats' => [
'archive',
'image'
],
'is_free' => true,
'keyword' => 'water quality',
'last_updated' => '1m',
'topics' => [
'natural_sciences',
'geo'
],
'usage_rights' => 'noncommercial'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post"
payload := strings.NewReader("[\n {\n \"file_formats\": [\n \"archive\",\n \"image\"\n ],\n \"is_free\": true,\n \"keyword\": \"water quality\",\n \"last_updated\": \"1m\",\n \"topics\": [\n \"natural_sciences\",\n \"geo\"\n ],\n \"usage_rights\": \"noncommercial\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"file_formats\": [\n \"archive\",\n \"image\"\n ],\n \"is_free\": true,\n \"keyword\": \"water quality\",\n \"last_updated\": \"1m\",\n \"topics\": [\n \"natural_sciences\",\n \"geo\"\n ],\n \"usage_rights\": \"noncommercial\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"file_formats\": [\n \"archive\",\n \"image\"\n ],\n \"is_free\": true,\n \"keyword\": \"water quality\",\n \"last_updated\": \"1m\",\n \"topics\": [\n \"natural_sciences\",\n \"geo\"\n ],\n \"usage_rights\": \"noncommercial\"\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": {}
}
]
}Queues datasets matching a query in Google Dataset Search on Google, returning a task
Your account will be billed per each SERP containing up to 20 results;
id in tasks[0].id. The charge lands here; fetching is free, including re-fetching. Wrapped in DataForSEO’s envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The live twin answers immediately and is simpler for a single query; queue when the batch would outlast a tool call.
Example
curl -X POST "https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '[{"keyword": "...", "language_name": "...", "language_code": "..."}]'
Request contract
- Method and path: POST /apis/v1/dataforseo/serp/google/dataset_search/task_post
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post - Runtime facts: 6ab8fec17df1d5dcdff2e036dd1eb40587752b774ec040ab4eb0cc6946c3dd3c
{
"operationId": "post_dataforseo_serp_google_dataset_search_submit",
"method": "POST",
"path": "/apis/v1/dataforseo/serp/google/dataset_search/task_post",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": [
{
"file_formats": [
"archive",
"image"
],
"is_free": true,
"keyword": "water quality",
"last_updated": "1m",
"topics": [
"natural_sciences",
"geo"
],
"usage_rights": "noncommercial"
}
],
"items": {
"oneOf": [
{
"properties": {
"depth": {
"description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>20</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong><p>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;",
"type": [
"integer",
"null"
]
},
"device": {
"description": "<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>",
"type": [
"string",
"null"
]
},
"file_formats": {
"description": "<p><em>file formats of the dataset</em><p>optional field<p>possible values: <code>other</code>, <code>archive</code>, <code>text</code>, <code>image</code>, <code>document</code>, <code>tabular</code></p>",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"is_free": {
"description": "<p><em>indicates whether displayed datasets are free</em><p>optional field<p>possible values: <code>true</code>, <code>false</code></p>",
"type": [
"boolean",
"null"
]
},
"keyword": {
"description": "<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”.</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a></p>",
"type": "string"
},
"language_code": {
"description": "<p><em>search engine language code</em><p>optional field<p>possible value:<p><code class=\"long-string\">en</code></p>",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don't need to specify <code>language_code</code><p>possible value:<p><code class=\"long-string\">English</code></p>",
"type": [
"string",
"null"
]
},
"last_updated": {
"description": "<p><em>last time the dataset was updated</em><p>optional field<p>possible values: <code>1m</code>, <code>1y</code>, <code>3y</code></p>",
"type": [
"string",
"null"
]
},
"os": {
"description": "<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a></p>",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>only value: <code>advanced</code></p>",
"type": "string"
},
"postback_url": {
"description": "<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a></p>",
"type": [
"string",
"null"
]
},
"priority": {
"description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-dataset-search-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>",
"type": [
"string",
"null"
]
},
"topics": {
"description": "<p><em>dataset topics</em><p>optional field<p>possible values: <code>humanities</code>, <code>social_sciences</code>, <code>life_sciences</code>, <code>agriculture</code>, <code>natural_sciences</code>, <code>geo</code>, <code>computer</code>, <code>architecture_and_urban_planning</code>, <code>engineering</code></p>",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"usage_rights": {
"description": "<p><em>usage rights of the dataset</em><p>optional field<p>possible values: <code>commercial</code>, <code>noncommercial</code></p>",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.02,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.- Default request reference estimate (USD): 0.02
- Cost contract: response_usd
- Published reference multiplier: 1.0
- Settlement evidence source: response_body
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
parsing depth
optional field
number of results in SERP
default value: 20
max value: 700
Your account will be billed per each SERP containing up to 20 results;
Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;
If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;
device type
optional field
return results for a specific device type
possible value: desktop
file formats of the dataset
optional field
possible values: other, archive, text, image, document, tabular
indicates whether displayed datasets are free
optional field
possible values: true, false
keyword
required field
you can specify up to 700 characters in the keyword field
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for your keyword, please specify it as “%25”;
if you need to use the “+” character for your keyword, please specify it as “%2B”.
learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
search engine language code
optional field
possible value:
en
full name of search engine language
optional field
if you use this field, you don't need to specify language_code
possible value:
English
last time the dataset was updated
optional field
possible values: 1m, 1y, 3y
device operating system
optional field
possible values: windows, macos
default value: windows
notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
example:
http://your-server.com/pingscript?id=$id
http://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center
postback_url datatype
required field if you specify postback_url
corresponds to the datatype that will be sent to your server
only value: advanced
URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
example:
http://your-server.com/postbackscript?id=$id
http://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center
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
dataset topics
optional field
possible values: humanities, social_sciences, life_sciences, agriculture, natural_sciences, geo, computer, architecture_and_urban_planning, engineering
usage rights of the dataset
optional field
possible values: commercial, noncommercial
Example:
[
{
"file_formats": ["archive", "image"],
"is_free": true,
"keyword": "water quality",
"last_updated": "1m",
"topics": ["natural_sciences", "geo"],
"usage_rights": "noncommercial"
}
]
Response
object | null
Successful operation
total tasks cost, USD
general status code you can find the full list of the response codes here
general informational message you can find the full list of general informational messages here
the number of tasks in the tasks array
the number of tasks in the tasks array returned with an error
total execution time, seconds
the current version of the API
array of tasks
Show child attributes
Show child attributes