Data API / DataForSEO / Business Data
Setting Business Data Trustpilot Search Tasks
Queues Trustpilot businesses matching a query - how to find the id the reviews endpoint needs, 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_search_fetch; reviews come from post_dataforseo_business_trustpilot_reviews_submit.
Параметры
Параметров пути, запроса и заголовков нет.
Тело запроса
keywordstringОбязательныйkeyword required field the keyword you specify should indicate a business category or company name; you can specify up to 700 characters in the
keywordfiled; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for yourkeyword, please specify it as “%25” learn more about rules and limitations ofkeywordandkeywordsfields in DataForSEO APIs in this Help Center articlepriorityintegerНеобязательный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 search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row; default value:
10; maximum value:140Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 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
tagvalue in thedataobject of the responsepostback_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
gzipformat to thepostback_urlyou specified you can use the ‘$id’ string as a$idvariable and ‘$tag’ as urlencoded$tagvariable. We will set the necessary values before sending the request. example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagNote: special characters inpostback_urlwill be urlencoded; i.a., the#character will be encoded into%23learn more on our Help Centerpingback_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
$idvariable and ‘$tag’ as urlencoded$tagvariable. We will set the necessary values before sending the request. example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagNote: special characters inpingback_urlwill 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/search/task_post" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"keyword": "<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
tasksarray 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
resultarraypathstring[]Необязательный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