BusinessData

‌‌ This endpoint provides reviews published on the Trustpilot platform for the local establishment specified in the domain field.

post/v3/business_data/trustpilot/reviews/task_post

Request

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

Request body

domainstring

<em>domain of the local establishment</em><br><strong>required field</strong><br>domain of the local establishment on Trustpilot;<br>you can find the domain in the URL of every business listed on Trustpilot<br>example:<br><code>www.thepearlsource.com</code><br><code>https://www.trustpilot.com/review/<strong>www.thepearlsource.com</strong></code>

sort_bystring nullable

<em>results sorting parameter</em><br>optional field<br>you can use this field to sort the results;<br>possible sorting parameters:<br><code>recency</code> — most recent reviews first;<br><code>relevance</code> — most relevant reviews first;<br>default value: <code>relevance</code>

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/business-data-api-trustpilot-reviews-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.

depthinteger nullable

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

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

[
  {
    "domain": "www.thepearlsource.com",
    "depth": 40
  }
]

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

    • info

      api operation id BusinessDataTrustpilotReviewsTaskPost removed and replaced with TrustpilotReviewsTaskPost

    • info

      api operation id TrustpilotReviewsTaskPost removed and replaced with BusinessDataTrustpilotReviewsTaskPost