v0.1.0-beta

OpenAPI 3.1.0

Get Google Hotel Searches Results by id

Felo API Support

MIT

Server

https://openapi.felo.ai

Client Libraries

Shell Curl

DataForSEO

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

DataForSEO Operations

get/v1/beta/dataforseo/business_data/google/hotel_searches/task_get/{id}

Get Google Hotel Searches Results by id

Retrieves a queued Google Hotels search by id. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. ⚠️ The response size was fixed by the depth or limit set at submit time and cannot be narrowed here; if it is too large, resubmit smaller rather than paging.

Path Parameters

id
Type: string
required

DataForSEO task ID.

Responses

200
Type: object

Successful response
items
Type: array string[]

encountered item types types of search engine results encountered in the items array; possible item types: hotel_search_item

items.check_in
Type: string

check-in date and time in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

items.check_out
Type: string

check-out date and time in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

items.currency
Type: string

price currency USD is applied by default, unless specified in the POST array

items.discount_text
Type: string

text about a discount applied

items.hotel_identifier
Type: string

unique identifier of a hotel entity in Google search example: CgoI-KWyzenM_MV3EAE

items.is_paid
Type: boolean

indicates a paid hotel listing if true, related hotel_search_item is a paid ad if false, related hotel_search_item is an organic hotel listing

items.items
Type: array string[]

array of items note: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint

items.latitude
Type: number

latitude coordinate of the hotel in google maps example: "latitude": 51.584091

items.location
Type: object

GPS coordinates of the hotel’s location

items.longitude
Type: number

longitude coordinate of the hotel in google maps example: "longitude": -0.31365919999999997

items.mentions
Type: array string[]

hotel mentions note: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint

items.other_sites_reviews
Type: array string[]

reviews on third-party sites note: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint

items.overview_images
Type: array string[]

featured images for a hotel

items.price
Type: integer

price per night

items.price_without_discount
Type: integer

full price per night without a discount applied

items.prices
Type: object

hotel price

items.rating_distribution
Type: object

rating distribution by votes note: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint

items.reviews
Type: object

hotel reviews and rating information

items.stars
Type: integer

hotel class rating class rating that ranges between 1-5 stars

items.title
Type: string

title of the hotel

items.type
Type: string

type of element = ‘hotel_search_item’

items.value
Type: number

the average rating based on all reviews

items.visitors
Type: integer

number of hotel visitors for this price

items.votes_count
Type: integer

the number of votes

result
Type: array string[]

array of results

result.check_url
Type: string

direct URL to search engine results you can use it to make sure that we provided accurate results

result.datetime
Type: string

date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

result.items_count
Type: integer

item types the number of items in the items array

result.keyword
Type: string

keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character); in order to obtain accurate search results, the location name is appended to the keyword automatically

result.language_code
Type: string

language code in a POST array

result.location_code
Type: integer

location code in a POST array

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

task identifier unique task identifier in our system in the 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 you can find the full list of the response codes here

tasks.status_message
Type: string

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

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 that were returned 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.

get/v1/beta/dataforseo/business_data/google/hotel_searches/task_get/{id}

curl 'https://openapi.felo.ai/v1/beta/dataforseo/business_data/google/hotel_searches/task_get/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "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"
  ],
  "result.keyword": "string",
  "result.location_code": 1,
  "result.language_code": "string",
  "result.check_url": "string",
  "result.datetime": "string",
  "result.items_count": 1,
  "items": [
    "string"
  ],
  "items.type": "string",
  "items.hotel_identifier": "string",
  "items.title": "string",
  "items.stars": 1,
  "items.is_paid": true,
  "items.location": {},
  "items.latitude": 1,
  "items.longitude": 1,
  "items.reviews": {},
  "items.value": 1,
  "items.votes_count": 1,
  "items.mentions": [
    "string"
  ],
  "items.rating_distribution": {},
  "items.other_sites_reviews": [
    "string"
  ],
  "items.overview_images": [
    "string"
  ],
  "items.prices": {},
  "items.price": 1,
  "items.price_without_discount": 1,
  "items.currency": "string",
  "items.discount_text": "string",
  "items.check_in": "string",
  "items.check_out": "string",
  "items.visitors": 1,
  "items.items": [
    "string"
  ]
}

Successful response

Get Google Hotel Searches Results by id

AuthenticationRequired

DataForSEO

Get Google Hotel Searches Results by id