keywordHotel_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"
},
"keyword": {
"type": "string",
"description": "keywordurl_pathkeyword filed;keyword, please specify it as “%25”"
},
"location_name": {
"type": "string",
"description": "full name of search engine locationlocation_code or url_pathlocation_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locationsLondon,England,United Kingdom"
},
"location_code": {
"type": "integer",
"description": "search engine location codelocation_name or url_pathlocation_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations1003854"
},
"priority": {
"type": [
"integer",
"null"
],
"description": "task prioritylanguage_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/languagesEnglishlanguage_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/languagesen10;4490excellent, very_good, average, poor, terriblefamilies, couples, solo, business, friendsjanuary, february, march, april, may, april, june, july, august, september, october, november, decembermost_recentdetailed_reviews"
},
"translate_reviews": {
"type": [
"boolean",
"null"
],
"description": "translate reviews according to the URL pathtrue, returned reviews will be translated to the language matching the specified url_path;url_path contains tripadvisor.it and translate_reviews is true, reviews will be translated to the Italian language;truetag value in the data object of the response"
},
"postback_url": {
"type": [
"string",
"null"
],
"description": "URL for sending task resultsgzip format to the postback_url you specified$id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagpostback_url will be urlencoded;# character will be encoded into %23learn more on our Help Center"
},
"pingback_url": {
"type": [
"string",
"null"
],
"description": "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"
}
},
"example": [
{
"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"
}
]
}
]
},
"example": [
{
"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"
}
]
}
```
## Responses
### 200 — Successful operation
Headers:
- `X-Request-Id` (string) — Request identifier to include when contacting Felo support.
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDataTripadvisorReviewsTaskPostResponseInfo"
}
]
}
```
### 400 — The request could not be processed. Check the request parameters.
### 401 — A valid Felo API key is required.
### 402 — The request cannot proceed because a billing requirement is not met.
### 403 — The account is not permitted to perform this operation.
### 429 — A request or spending limit has been reached.
### 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 — Error response; upstream passthrough responses may use provider formats
**application/json**
Schema:
```json
{}
```
## Schema definitions
### Response36Afe1097B20_BaseResponseInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`
```json
{
"properties": {
"version": {
"type": [
"string",
"null"
],
"description": "the current version of the API"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "general status code\nyou can find the full list of the response codes here"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "general informational message\nyou can find the full list of general informational messages here"
},
"time": {
"type": [
"string",
"null"
],
"description": "total execution time, seconds"
},
"cost": {
"type": [
"number",
"null"
],
"description": "total tasks cost, USD",
"format": "double"
},
"tasks_count": {
"type": [
"integer",
"null"
],
"description": "the number of tasks in the tasks array",
"format": "int64"
},
"tasks_error": {
"type": [
"integer",
"null"
],
"description": "the number of tasks in the tasks array returned with an error",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_BaseResponseTaskInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`
```json
{
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "task identifier\nunique task identifier in our system in the UUID format"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "informational message of the task\nyou can find the full list of general informational messages here"
},
"time": {
"type": [
"string",
"null"
],
"description": "execution time, seconds"
},
"cost": {
"type": [
"number",
"null"
],
"description": "total tasks cost, USD",
"format": "double"
},
"result_count": {
"type": [
"integer",
"null"
],
"description": "number of elements in the result array",
"format": "int64"
},
"path": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "URL path"
},
"data": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "contains the same parameters that you specified in the POST request"
}
}
}
```
### Response36Afe1097B20_BusinessDataTripadvisorReviewsTaskPostResponseInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataTripadvisorReviewsTaskPostResponseInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDataTripadvisorReviewsTaskPostTaskInfo"
}
]
},
"description": "array of tasks"
}
}
}
]
}
```
### Response36Afe1097B20_BusinessDataTripadvisorReviewsTaskPostTaskInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataTripadvisorReviewsTaskPostTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"object",
"null"
],
"description": "array of results
in this case, the value will be null"
}
}
}
]
}
```