Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html",
"location_code": 1003854,
"pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
"tag": "some_string_123"
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"location_code": 1003854,
"pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
"tag": "some_string_123",
"url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post"
payload = [
{
"location_code": 1003854,
"pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
"tag": "some_string_123",
"url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
location_code: 1003854,
pingback_url: 'https://your-server.com/pingback.php?id=$id&tag=$tag',
tag: 'some_string_123',
url_path: 'Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html'
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'location_code' => 1003854,
'pingback_url' => 'https://your-server.com/pingback.php?id=$id&tag=$tag',
'tag' => 'some_string_123',
'url_path' => 'Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post"
payload := strings.NewReader("[\n {\n \"location_code\": 1003854,\n \"pingback_url\": \"https://your-server.com/pingback.php?id=$id&tag=$tag\",\n \"tag\": \"some_string_123\",\n \"url_path\": \"Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"location_code\": 1003854,\n \"pingback_url\": \"https://your-server.com/pingback.php?id=$id&tag=$tag\",\n \"tag\": \"some_string_123\",\n \"url_path\": \"Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"location_code\": 1003854,\n \"pingback_url\": \"https://your-server.com/pingback.php?id=$id&tag=$tag\",\n \"tag\": \"some_string_123\",\n \"url_path\": \"Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html\"\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": {}
}
]
}Tripadvisor
Setting Business Data Tripadvisor Reviews Tasks
Queues Tripadvisor reviews for one property, returning a task id.
POST
https://api.aisa.one
/
apis
/
v1
/
dataforseo
/
business_data
/
tripadvisor
/
reviews
/
task_post
Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html",
"location_code": 1003854,
"pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
"tag": "some_string_123"
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"location_code": 1003854,
"pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
"tag": "some_string_123",
"url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post"
payload = [
{
"location_code": 1003854,
"pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
"tag": "some_string_123",
"url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
location_code: 1003854,
pingback_url: 'https://your-server.com/pingback.php?id=$id&tag=$tag',
tag: 'some_string_123',
url_path: 'Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html'
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'location_code' => 1003854,
'pingback_url' => 'https://your-server.com/pingback.php?id=$id&tag=$tag',
'tag' => 'some_string_123',
'url_path' => 'Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post"
payload := strings.NewReader("[\n {\n \"location_code\": 1003854,\n \"pingback_url\": \"https://your-server.com/pingback.php?id=$id&tag=$tag\",\n \"tag\": \"some_string_123\",\n \"url_path\": \"Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"location_code\": 1003854,\n \"pingback_url\": \"https://your-server.com/pingback.php?id=$id&tag=$tag\",\n \"tag\": \"some_string_123\",\n \"url_path\": \"Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"location_code\": 1003854,\n \"pingback_url\": \"https://your-server.com/pingback.php?id=$id&tag=$tag\",\n \"tag\": \"some_string_123\",\n \"url_path\": \"Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html\"\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": {}
}
]
}Queues Tripadvisor reviews for one property, returning a task
Set this endpoint up in your agent →
id. Asynchronous: submit returns a task id in tasks[0].id, fetch returns the result once ready, and the charge lands on the submit - fetching is free, including re-fetching. 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_tripadvisor_reviews_fetch; the Trustpilot equivalent is post_dataforseo_business_trustpilot_reviews_submit.
Example
curl -X POST "https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '[{"url_path": "...", "keyword": "...", "location_name": "..."}]'
// Copy this whole block into Claude Code, Codex, Cursor or any coding agent.
// It carries everything needed to connect, authorize and run this example —
// no key to paste, one click of Allow in the browser.
{
"calls": [
{
"call_id": "1",
"tool": "post_dataforseo_business_tripadvisor_reviews_submit",
"arguments": {}
}
]
}
// ── for the agent ─────────────────────────────────────────────────────────
// Register the AIsa MCP server, then call its `batch_quote` tool with the JSON above.
// name aisa
// endpoint https://mcp.aisa.one/mcp
// transport streamable-http
// auth OAuth. The server publishes RFC 9728 metadata, so open a
// browser and the user clicks Allow once — nothing to paste.
// If AISA_API_KEY is set, send it as a bearer header instead.
// Use your own MCP mechanism, not a hand-edited config file:
// Codex codex mcp add aisa --url https://mcp.aisa.one/mcp
// Claude Code claude mcp add --transport http -s user aisa https://mcp.aisa.one/mcp
// Cursor / VS Code a "url" entry for https://mcp.aisa.one/mcp in the MCP config
// The server reaches https://mcp.aisa.one/servers worth of APIs through a few meta
// tools: search, list_categories, get_details, batch_quote, batch_use.
// search, get_details and batch_quote are free; batch_use is billed per
// call. This operation's full contract — every argument, the response
// shape, the price and the pitfalls — is at
// https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-business-data-tripadvisor-reviews-task-post.md
// Show me the quoted cost. Once I approve, run the same calls with
// batch_use and show me the result.
First time? Point any MCP client at
https://mcp.aisa.one/mcp — Claude
Code, Codex, Cursor, VS Code and the rest. Authorization is OAuth: the client
opens a browser, you click Allow once, and there is no key to paste. Your
agent then reaches every endpoint through a few meta tools: search,
list_categories, get_details and batch_quote are free, batch_use is
billed per call. Setup per client is in
Connect via MCP; the live tool list and what each call
costs are on aisa.one/mcp.Request contract
- Method and path: POST /apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post - Runtime facts: 6ab8fec17df1d5dcdff2e036dd1eb40587752b774ec040ab4eb0cc6946c3dd3c
{
"operationId": "post_dataforseo_business_tripadvisor_reviews_submit",
"method": "POST",
"path": "/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": [
{
"location_code": 1003854,
"pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
"tag": "some_string_123",
"url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
}
],
"items": {
"oneOf": [
{
"properties": {
"depth": {
"description": "<em>parsing depth</em><br>optional field<br>number of reviews in SERP;<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;<br>default value: <code>10</code>;<br>max value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "<em>keyword</em><br><strong>required field if you do not specify <code>url_path</code></strong><br>the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”",
"type": "string"
},
"language_code": {
"description": "<em>search engine language code</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<em><br></em><code class=\"long-string\">en</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<br><code class=\"long-string\">English</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "<em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">1003854</code>",
"type": "integer"
},
"location_name": {
"description": "<em>full name of search engine location</em><br><strong>required field if you don't specify <code>location_code</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
"type": "string"
},
"months": {
"description": "<em>filter by months when a traveler made a visit</em><br>optional field<br>possible values: <code>january</code>, <code>february</code>, <code>march</code>, <code>april</code>, <code>may</code>, <code>april</code>, <code>june</code>, <code>july</code>, <code>august</code>, <code>september</code>, <code>october</code>, <code>november</code>, <code>december</code><br>you can specify several values at once",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"pingback_url": {
"description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
"type": [
"string",
"null"
]
},
"postback_url": {
"description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
"type": [
"string",
"null"
]
},
"priority": {
"description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
"type": [
"integer",
"null"
]
},
"ratings": {
"description": "<em>Tripadvisor traveler rating for a place of interest</em><br>optional field<br>rating based on the written reviews by a traveler after they visited a place.<br>possible values: <code>excellent</code>, <code>very_good</code>, <code>average</code>, <code>poor</code>, <code>terrible</code><br>you can specify several values at once",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"sort_by": {
"description": "<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code><br><code>detailed_reviews</code>",
"type": [
"string",
"null"
]
},
"tag": {
"description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
"type": [
"string",
"null"
]
},
"translate_reviews": {
"description": "<em>translate reviews according to the URL path</em><br>optional field<br>if set to <code>true</code>, returned reviews will be translated to the language matching the specified <code>url_path</code>;<br>for example, if <code>url_path</code> contains <code>tripadvisor.it</code> and <code>translate_reviews</code> is <code>true</code>, reviews will be translated to the Italian language;<br>default value: <code>true</code><br>you can learn more about how reviews are translated in <a href=\"https://dataforseo.com/help-center/how-to-translate-reviews-in-tripadvisor-business-data-api\" rel=\"noopener noreferrer\" target=\"_blank\">this Help Center article</a>",
"type": [
"boolean",
"null"
]
},
"url_path": {
"description": "<em>URL path of the business entity</em><br><strong>required field if you do not specify <code>keyword</code></strong><br>URL path to the Tripadvisor page of the business entity;<br>examples:<br><code>Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code><br><code>https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code>",
"type": "string"
},
"visit_type": {
"description": "<em>filter by type of travelers who left a review</em><br>optional field<br>possible values: <code>families</code>, <code>couples</code>, <code>solo</code>, <code>business</code>, <code>friends</code><br>you can specify several values at once",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.2428,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.- Default request reference estimate (USD): 0.2428
- Cost contract: response_usd
- Published reference multiplier: 1.0
- Settlement evidence source: response_body
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
parsing depth
optional field
number of reviews in SERP;
we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;
default value: 10;
max value: 4490
Your 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.
keyword
required field if you do not specify url_path
the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;
you can specify up to 700 characters in the keyword filed;
all %## will be decoded (plus character ‘+’ will be decoded to a space character);
if you need to use the “%” character for your keyword, please specify it as “%25”
search engine language code
optional field
if you use this field, your account will be charged for one extra request
you can receive the list of available languages with language_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/languages
example:en
You will be additionally charged for setting a language parameter in this endpoint.
The cost can be calculated on the Pricing page.
full name of search engine language
optional field
if you use this field, your account will be charged for one extra request
you can receive the list of available languages with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/languages
example:English
You will be additionally charged for setting a language parameter in this endpoint.
The cost can be calculated on the Pricing page.
search engine location code
required field if you don't specify location_name or url_path
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations
example:1003854
full name of search engine location
required field if you don't specify location_code or url_path
you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations
example:London,England,United Kingdom
filter by months when a traveler made a visit
optional field
possible values: january, february, march, april, may, april, june, july, august, september, october, november, december
you can specify several values at once
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=$idhttp://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 %23
learn more on our Help Center
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=$idhttp://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 %23
learn more on our Help Center
Tripadvisor traveler rating for a place of interest
optional field
rating based on the written reviews by a traveler after they visited a place.
possible values: excellent, very_good, average, poor, terrible
you can specify several values at once
results sorting parameters
optional field
you can use this field to sort the results;
possible types of sorting:most_recentdetailed_reviews
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
translate reviews according to the URL path
optional field
if set to true, returned reviews will be translated to the language matching the specified url_path;
for example, if url_path contains tripadvisor.it and translate_reviews is true, reviews will be translated to the Italian language;
default value: true
you can learn more about how reviews are translated in this Help Center article
URL path of the business entity
required field if you do not specify keyword
URL path to the Tripadvisor page of the business entity;
examples:Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.htmlhttps://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html
filter by type of travelers who left a review
optional field
possible values: families, couples, solo, business, friends
you can specify several values at once
Example:
[
{
"location_code": 1003854,
"pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
"tag": "some_string_123",
"url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html"
}
]
Response
object | null
Successful operation
total tasks cost, USD
general status code you can find the full list of the response codes here
general informational message you can find the full list of general informational messages here
the number of tasks in the tasks array
the number of tasks in the tasks array returned with an error
total execution time, seconds
the current version of the API
array of tasks
Show child attributes
Show child attributes