Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Setting Business Data Trustpilot Reviews Tasks

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

DataForSEO

​

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

Setting Business Data Trustpilot Reviews Tasks

​

Queues Trustpilot reviews for one business, 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_trustpilot_reviews_fetch; the Tripadvisor equivalent is post_dataforseo_business_tripadvisor_reviews_submit.

Body
required
application/json
  • Type: array object[]
    • domain
      Type: string
      required

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

    • depth
      Type: integer

      parsing depth optional field number of reviews to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row default value: 20 maximum value: 200 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.

    • pingback_url
      Type: string

      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 %23learn more on our Help Center

    • postback_url
      Type: string

      return 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 %23learn more on our Help Center

    • priority
      Type: integer

      task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.

    • sort_by
      Type: string

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

    • tag
      Type: string

      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

    Successful response

    • result
      Type: array string[]

      array of results in this case, the value will be null

    • 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

      unique task identifier in our system in the Universally unique identifier (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

    • tasks.status_message
      Type: string

      informational message of the task

    • 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 returned with 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.

Request Example for post/v1/beta/dataforseo/business_data/trustpilot/reviews/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/business_data/trustpilot/reviews/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "domain": "",
    "sort_by": "",
    "priority": 1,
    "depth": 1,
    "tag": "",
    "postback_url": "",
    "pingback_url": ""
  }
]'
{
  "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"
  ]
}
Setting Business Data Trustpilot Reviews Tasks