BusinessData

‌‌ This endpoint provides results from the “Reviews” element of Google SERPs. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters.

post/v3/business_data/google/reviews/task_post

Request

  • Base URL: https://api.dataforseo.com
  • URL: https://api.dataforseo.com/v3/business_data/google/reviews/task_post
  • Auth: HTTP basic

Request body

keywordstring

<em>keyword</em><br><strong>required field if you don't specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<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>

cidstring

<i>unique, google-defined id of the business entity</i><br><strong>required field if you don't specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>

place_idstring

<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>

priorityinteger nullable

<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/google-reviews-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.

location_namestring

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

location_codeinteger

<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>

location_coordinatestring

<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>

language_namestring

<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>

language_codestring

<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>

depthinteger nullable

<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row<br>default value: <code>10</code><br>maximum value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/google-reviews-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.

sort_bystring nullable

<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>newest</code> – sort by newest first<br><code>highest_rating</code> – sort by highest rating<br><code>lowest_rating</code> – sort by lowest rating<br><code>relevant</code> – sort by relevance<br>default value: <code>relevant</code>

tagstring nullable

<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response

postback_urlstring nullable

<em>URL for sending task results</em><br>optional field<br>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<br>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.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><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>

pingback_urlstring nullable

<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>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.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><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>

Example request

[
  {
    "location_name": "London,England,United Kingdom",
    "language_name": "English",
    "keyword": "hedonism wines",
    "depth": 50,
    "sort_by": "highest_rating"
  }
]

Response

Successful operation

versionstring nullable

the current version of the API

status_codeinteger nullable

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

status_messagestring nullable

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

timestring nullable

total execution time, seconds

costnumber double nullable

total tasks cost, USD

tasks_countinteger nullable

the number of tasks in the tasks array

tasks_errorinteger nullable

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

Changes

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • info

      api operation id BusinessDataGoogleReviewsTaskPost removed and replaced with GoogleReviewsTaskPost