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

Setting Business Data Google Extended Reviews Tasks

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

DataForSEO

​

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

Setting Business Data Google Extended Reviews Tasks

​

Queues the full Google review history for a business, past the first page the standard endpoint returns, returning a task id. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Retrieve with get_dataforseo_business_google_extended_reviews_fetch; the shorter version is post_dataforseo_business_google_reviews_submit.

Pricing reference

  • Metering: Reported response cost.
  • Reference request estimate: USD 0.2428.
  • 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)[]
    • cid
      Type: string

      unique, google-defined id of the business entity
      required field if you don't specify keyword or place_id
      example:
      194604053573767737
      learn more about the identifier in this help center article

      Note: if you use this field, your account will be charged two times the standard rate for tasks involving the Google Reviews API

    • depth
      Type: integer | null

      parsing depth
      optional field
      number of reviews in SERP
      we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row
      default value: 20
      maximum value: 1000

      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;
      The cost can be calculated on the Pricing page.

    • keyword
      Type: string

      keyword
      required field if you don't specify cid or place_id
      the keyword you specify should indicate the name of the local establishment;
      you can specify up to 700 characters in the keyword filed;
      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 this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5
      Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error

      learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article

      Note: if you use this field, your account will be charged three times the standard rate for tasks involving the Google Reviews API

    • language_code
      Type: string

      search engine language code
      required field if you don't specify language_name
      if you use this field, you don't need to specify language_name
      you can receive the list of available languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages
      example:
      enn

    • language_name
      Type: string

      full name of search engine language
      required field if you don't specify language_code
      if you use this field, you don't need to specify language_code
      you can receive the list of available languages with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages
      example:
      English

    • location_code
      Type: integer

      search engine location code
      required field if you don't specify location_name_or location_coordinate
      if you use this field, you don't need to specify location_name or location_coordinate
      you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
      example:
      2840n

    • location_coordinate
      Type: string

      GPS coordinates of a location
      required field if you don't specify location_name_or location_code
      if you use this field, you don't need to specify location_name or location_code
      location_coordinate parameter should be specified in the "latitude,longitude,radius" format
      the maximum number of decimal digits for "latitude" and "longitude": 7
      the minimum value for "radius": 199.9
      example:
      53.476225,-2.243572,200n

    • location_name
      Type: string

      full name of search engine location
      required field if you don't specify location_code or location_coordinate
      if you use this field, you don't need to specify location_code or location_coordinate
      you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
      example:
      London,England,United Kingdom

    • 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

    • place_id
      Type: string

      identifier of the business entity in Google Maps
      required field if you don't specify keyword or cid
      example:
      GhIJQWDl0CIeQUARxks3icF8U8A
      learn more about the identifier in this help center article

      Note: if you use this field, your account will be charged two times the standard rate for tasks involving the Google Reviews API

    • 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 priorityYou 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

Responses
  • 200
    Type: object | null · Response36Afe1097B20_BusinessDataGoogleExtendedReviewsTaskPostResponseInfo
    • 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_BusinessDataGoogleExtendedReviewsTaskPostTaskInfo
        • 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/business_data/google/extended_reviews/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/business_data/google/extended_reviews/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "location_name": "London,England,United Kingdom",
    "language_name": "english",
    "cid": "17626775537598922320"
  }
]'
{
  "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 Business Data Google Extended Reviews Tasks

Need help?