Felo API PlatformFelo API Platform

Data API / DataForSEO / Business Data

Get Business Data Trustpilot Reviews Results by id

Retrieves queued Trustpilot reviews for one business by id. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. ⚠️ Size scales with the depth set at submit and cannot be narrowed here.

Parameters

path

  • idstringRequired

    DataForSEO task ID.

Example request

curl -X GET "https://openapi.felo.ai/v1/beta/dataforseo/business_data/trustpilot/reviews/task_get/{id}" \
  -H "Authorization: Bearer $FELO_API_KEY"

Response

Response fields

  • versionstringOptional

    the current version of the API

  • status_codeintegerOptional

    general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions

  • status_messagestringOptional

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

  • timestringOptional

    execution time, seconds

  • costnumberOptional

    *total tasks cost, USD*

  • tasks_countintegerOptional

    *the number of tasks in the tasks array*

  • tasks_errorintegerOptional

    *the number of tasks in the tasks array that were returned an error*

  • tasksstring[]Optional

    array of tasks

  • idstringOptional

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

  • status_codeintegerOptional

    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_messagestringOptional

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

  • timestringOptional

    execution time, seconds

  • costnumberOptional

    cost of the task, USD

  • result_countintegerOptional

    number of elements in the result array

  • pathstring[]Optional

    URL path

  • dataobjectOptional

    contains the same parameters that you specified in the POST request

  • resultstring[]Optional

    array of results

  • domainstringOptional

    domain of the business entity

  • typestringOptional

    search engine type in a POST array

  • se_domainstringOptional

    search engine domain in a POST array

  • check_urlstringOptional

    direct URL to search engine results you can use it to make sure that we provided accurate results

  • datetimestringOptional

    date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

  • titlestringOptional

    title of the ‘reviews’ element on Trustpilot the name of the business entity for which the reviews are collected

  • locationstringOptional

    location of the business entity as specified on Trustpilot address of the business entity for which the reviews are collected

  • reviews_countintegerOptional

    the total number of reviews

  • ratingobjectOptional

    rating of the corresponding business entity popularity rate based on reviews and displayed in SERP

  • rating_typestringOptional

    type of rating here you can find the following elements: Max5, Percents, CustomMax

  • valuenumberOptional

    the average rating based on all reviews

  • votes_countintegerOptional

    the number of votes

  • rating_maxintegerOptional

    the maximum value for a rating_type

  • items_countintegerOptional

    the number of items in the results array you can get more results by using the depth parameter when setting a task

  • itemsstring[]Optional

    found reviews you can get more results by using the depth parameter when setting a task

  • typestringOptional

    the review’s type possible review types: "trustpilot_review_search"

  • rank_groupintegerOptional

    position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group

  • rank_absoluteintegerOptional

    absolute rank among all the listed reviews absolute position among all reviews on the list

  • positionstringOptional

    the alignment of the review in SERP can take the following values: right

  • urlstringOptional

    URL to the reviewer’s profile

  • ratingobjectOptional

    the rating score submitted by the reviewer

  • rating_typestringOptional

    the type of the rating can take the following values: Max5

  • valuenumberOptional

    the value of the rating

  • votes_countintegerOptional

    the amount of feedback indicated the number of votes the review obtained

  • rating_maxintegerOptional

    the maximum value for a rating_type the maximum value for Max5 is 5

  • verifiedbooleanOptional

    indicates whether the review has the “Verified” mark

  • languagebooleanOptional

    the language of the review

  • timestampstringOptional

    date and time when the response was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

  • titlestringOptional

    title of the owner’s response

  • review_textstringOptional

    the content of the review

  • review_imagesstring[]Optional

    images submitted by the reviewer displays URLs to the images provided by the author of the review; please note that Trustpilot doesn’t allow adding images to reviews, so the review_images parameter will always equal null

  • user_profileobjectOptional

    user profile of the reviewer

  • namestringOptional

    the name of the reviewer

  • image_urlstringOptional

    URL to the reviewer’s profile picture

  • locationstringOptional

    country of the reviewer

  • reviews_countintegerOptional

    total number of reviews submitted by the reviewer

  • responsesstring[]Optional

    owner’s response to the submitted review

  • textstringOptional

    text of the owner’s response