Felo API PlatformFelo API Platform

数据 API / DataForSEO / Business 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.

参数

没有路径、查询或请求头参数。

请求体

  • domainstring必填

    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

  • sort_bystring可选

    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

  • priorityinteger可选

    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.

  • depthinteger可选

    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.

  • tagstring可选

    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

  • postback_urlstring可选

    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

  • pingback_urlstring可选

    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

请求示例

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/business_data/trustpilot/reviews/task_post" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "domain": "<string>",
  "sort_by": "<string>",
  "priority": 0,
  "depth": 0,
  "tag": "<string>",
  "postback_url": "<string>",
  "pingback_url": "<string>"
}'

响应

响应字段

  • versionstring可选

    the current version of the API

  • status_codeinteger可选

    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_messagestring可选

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

  • timestring可选

    execution time, seconds

  • costnumber可选

    total tasks cost, USD

  • tasks_countinteger可选

    *the number of tasks in the tasksarray*

  • tasks_errorinteger可选

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

  • tasksstring[]可选

    array of tasks

  • idstring可选

    unique task identifier in our system in the Universally unique identifier (UUID) format

  • status_codeinteger可选

    status code of the task generated by DataForSEO; can be within the following range: 10000-60000

  • status_messagestring可选

    informational message of the task

  • timestring可选

    execution time, seconds

  • costnumber可选

    cost of the task, USD

  • result_countinteger可选

    number of elements in the result array

  • pathstring[]可选

    URL path

  • dataobject可选

    contains the same parameters that you specified in the POST request

  • resultstring[]可选

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