v0.1.0-beta

OpenAPI 3.1.0

Get Business Data Trustpilot Reviews Results by id

Felo API Support

MIT

Server

https://openapi.felo.ai

Client Libraries

Shell Curl

DataForSEO

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

DataForSEO Operations

get/v1/beta/dataforseo/business_data/trustpilot/reviews/task_get/{id}

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.

Path Parameters

id
Type: string
required

DataForSEO task ID.

Responses

200
Type: object

Successful response
items
Type: array string[]

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

items.image_url
Type: string

URL to the reviewer’s profile picture

items.language
Type: boolean

the language of the review

items.location
Type: string

country of the reviewer

items.name
Type: string

the name of the reviewer

items.position
Type: string

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

items.rank_absolute
Type: integer

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

items.rank_group
Type: integer

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

items.rating
Type: object

the rating score submitted by the reviewer

items.rating_max
Type: integer

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

items.rating_type
Type: string

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

items.responses
Type: array string[]

owner’s response to the submitted review

items.review_images
Type: array string[]

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

items.review_text
Type: string

the content of the review

items.reviews_count
Type: integer

total number of reviews submitted by the reviewer

items.text
Type: string

text of the owner’s response

items.timestamp
Type: string

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

items.title
Type: string

title of the owner’s response

items.type
Type: string

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

items.url
Type: string

URL to the reviewer’s profile

items.user_profile
Type: object

user profile of the reviewer

items.value
Type: number

the value of the rating

items.verified
Type: boolean

indicates whether the review has the “Verified” mark

items.votes_count
Type: integer

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

result
Type: array string[]

array of results

result.check_url
Type: string

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

result.datetime
Type: string

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

result.domain
Type: string

domain of the business entity

result.items_count
Type: integer

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

result.location
Type: string

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

result.rating
Type: object

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

result.rating_max
Type: integer

the maximum value for a rating_type

result.rating_type
Type: string

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

result.reviews_count
Type: integer

the total number of reviews

result.se_domain
Type: string

search engine domain in a POST array

result.title
Type: string

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

result.type
Type: string

search engine type in a POST array

result.value
Type: number

the average rating based on all reviews

result.votes_count
Type: integer

the number of votes

tasks
Type: array string[]

array of tasks

tasks.cost
Type: number

cost of the task, USD

tasks.data
Type: object

contains the same parameters that you specified in the POST request

tasks.id
Type: string

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

tasks.path
Type: array string[]

URL path

tasks.result_count
Type: integer

number of elements in the result array

tasks.status_code
Type: integer

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

tasks.status_message
Type: string

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

tasks.time
Type: string

execution time, seconds

version
Type: string

the current version of the API

version.cost
Type: number

total tasks cost, USD

version.status_code
Type: integer

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

version.status_message
Type: string

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

version.tasks_count
Type: integer

the number of tasks in the tasks array

version.tasks_error
Type: integer

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

version.time
Type: string

execution time, seconds
application/json
400

Bad request
401

Unauthorized
402

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

The account is not permitted to perform this operation.
429

Rate limit exceeded
500

Internal server error
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

The operation failed. Keep the response request ID when contacting Felo support.

get/v1/beta/dataforseo/business_data/trustpilot/reviews/task_get/{id}

curl 'https://openapi.felo.ai/v1/beta/dataforseo/business_data/trustpilot/reviews/task_get/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "version": "string",
  "version.status_code": 1,
  "version.status_message": "string",
  "version.time": "string",
  "version.cost": 1,
  "version.tasks_count": 1,
  "version.tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "result": [
    "string"
  ],
  "result.domain": "string",
  "result.type": "string",
  "result.se_domain": "string",
  "result.check_url": "string",
  "result.datetime": "string",
  "result.title": "string",
  "result.location": "string",
  "result.reviews_count": 1,
  "result.rating": {},
  "result.rating_type": "string",
  "result.value": 1,
  "result.votes_count": 1,
  "result.rating_max": 1,
  "result.items_count": 1,
  "items": [
    "string"
  ],
  "items.type": "string",
  "items.rank_group": 1,
  "items.rank_absolute": 1,
  "items.position": "string",
  "items.url": "string",
  "items.rating": {},
  "items.rating_type": "string",
  "items.value": 1,
  "items.votes_count": 1,
  "items.rating_max": 1,
  "items.verified": true,
  "items.language": true,
  "items.timestamp": "string",
  "items.title": "string",
  "items.review_text": "string",
  "items.review_images": [
    "string"
  ],
  "items.user_profile": {},
  "items.name": "string",
  "items.image_url": "string",
  "items.location": "string",
  "items.reviews_count": 1,
  "items.responses": [
    "string"
  ],
  "items.text": "string"
}

Successful response

Get Business Data Trustpilot Reviews Results by id

AuthenticationRequired

DataForSEO

Get Business Data Trustpilot Reviews Results by id