Felo API PlatformFelo API Platform
All DataForSEO endpoints
v0.2.0-beta
OpenAPI 3.1.0

Setting Google Dataset Search Tasks

Server:https://openapi.felo.ai
Client Libraries

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

Setting Google Dataset Search Tasks

​

Queues datasets matching a query in Google Dataset Search on Google, returning a task id in tasks[0].id. 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.

Pricing reference

  • Metering: Reported response cost.
  • Reference request estimate: USD 0.02.
  • Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.

Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.

Body
application/json
  • Type: array (object | null)[]
    • depth
      Type: integer | null

      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: string | null

      device type

      optional field

      return results for a specific device type

      possible value: desktop

    • file_formats
      Type: array string[] | null

      file formats of the dataset

      optional field

      possible values: other, archive, text, image, document, tabular

    • is_free
      Type: boolean | null

      indicates whether displayed datasets are free

      optional field

      possible values: true, false

    • keyword
      Type: string

      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

    • language_code
      Type: string | null

      search engine language code

      optional field

      possible value:

      en

    • language_name
      Type: string | null

      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_updated
      Type: string | null

      last time the dataset was updated

      optional field

      possible values: 1m, 1y, 3y

    • os
      Type: string | null

      device operating system

      optional field

      possible values: windows, macos

      default value: windows

    • pingback_url
      Type: string | null

      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_data
      Type: string

      postback_url datatype

      required field if you specify postback_url

      corresponds to the datatype that will be sent to your server

      only value: advanced

    • postback_url
      Type: string | null

      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

    • priority
      Type: integer | null

      task priority

      optional field

      can take the following values:

      1 – normal execution priority (set by default)

      2 – high execution priority


      You will be additionally charged for the tasks with high execution priority.

      The cost can be calculated on the Pricing page.

    • tag
      Type: string | null

      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

    • topics
      Type: array string[] | null

      dataset topics

      optional field

      possible values: humanities, social_sciences, life_sciences, agriculture, natural_sciences, geo, computer, architecture_and_urban_planning, engineering

    • usage_rights
      Type: string | null

      usage rights of the dataset

      optional field

      possible values: commercial, noncommercial

Responses
  • 200
    Type: object | null · Response36Afe1097B20_SerpGoogleDatasetSearchTaskPostResponseInfo
    • cost
      Type: number | null Format: double

      total tasks cost, USD

    • status_code
      Type: integer | null

      general status code you can find the full list of the response codes here

    • status_message
      Type: string | null

      general informational message you can find the full list of general informational messages here

    • tasks
      Type: array (object | null)[] | null

      array of tasks

      • Type: object | null · Response36Afe1097B20_SerpGoogleDatasetSearchTaskPostTaskInfo
        • cost
          Type: number | null Format: double

          total tasks cost, USD

        • data
          Type: object | null

          contains the same parameters that you specified in the POST request

          • propertyName
            Type: object | null
        • id
          Type: string | null

          task identifier unique task identifier in our system in the UUID format

        • path
          Type: array (string | null)[] | null

          URL path

        • result
          Type: object | null

          array of results
          in this case, the value will be null

        • result_count
          Type: integer | null Format: int64

          number of elements in the result array

        • status_code
          Type: integer | null

          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
          Type: string | null

          informational message of the task you can find the full list of general informational messages here

        • time
          Type: string | null

          execution time, seconds

    • tasks_count
      Type: integer | null Format: int64

      the number of tasks in the tasks array

    • tasks_error
      Type: integer | null Format: int64

      the number of tasks in the tasks array returned with an error

    • time
      Type: string | null

      total execution time, seconds

    • version
      Type: string | null

      the current version of the API

    application/json
  • 400

    The request could not be processed. Check the request parameters.

  • 401

    A valid Felo API key is required.

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    A request or spending limit has been reached.

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    Error response; upstream passthrough responses may use provider formats

    application/json
Request Example for post/v1/beta/dataforseo/serp/google/dataset_search/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/serp/google/dataset_search/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "keyword": "water quality",
    "last_updated": "1m",
    "file_formats": [
      "archive",
      "image"
    ],
    "usage_rights": "noncommercial",
    "is_free": true,
    "topics": [
      "natural_sciences",
      "geo"
    ]
  }
]'
{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": null
    }
  ]
}
Setting Google Dataset Search Tasks

Need help?