/opentable/restaurants/reviews

POST /api/opentable/restaurants/reviews

Price: 20 credits

Get diner reviews of an OpenTable restaurant by its id: text, overall, food, service, ambience and value ratings, noise level, dining and submission dates, reviewer, photos and the restaurant's reply

How to use it

Fetch the reviews of one OpenTable restaurant by the numeric id that search, autocomplete and the restaurant profile return. newest and oldest order reviews by dining date. since_review_id or submitted_after with sort=newest return reviews submitted after that review or time, scanning dining dates back to a year before it; since_review_id must be one of the restaurant's 10,000 most recently dined reviews, otherwise pass submitted_after.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• restaurant_id integer required — OpenTable restaurant id (examples: 1029757, 2; min: 1)
• count integer required — Max number of reviews to return (min: 1)
• sort string — Review ordering (default: "newest"; one of: "newest", "oldest", "highest_rating", "lowest_rating")
• min_party_size integer nullable — Only reviews from parties of at least this size (min: 1; max: 20)
• keyword string nullable — Only reviews mentioning this word (examples: "pasta"; minLength: 1)
• since_review_id string nullable — Return only reviews submitted after this review (examples: "OT-19873-2110822437-120051685852"; minLength: 1)
• submitted_after integer nullable — Return only reviews submitted after this unix time, in seconds (min: 0)

Response

• @type string (default: "OpentableReview")
• id string required
• restaurant_id integer required
• text string nullable
• rating_overall integer nullable
• rating_food integer nullable
• rating_service integer nullable
• rating_ambience integer nullable
• rating_value integer nullable
• noise_level string nullable
• submitted_at integer nullable
• dined_at integer nullable
• review_type string nullable
• is_from_previous_concept boolean nullable
• helpful_count integer nullable
• unhelpful_count integer nullable
• helpfulness_score number nullable
• reviewer object nullable
  • @type string (default: "OpentableReviewAuthor")
  • nickname string nullable
  • initials string nullable
  • metro string nullable
  • metro_id integer nullable
  • review_count integer nullable
  • is_vip boolean nullable
  • image string nullable
• photos array (default: [])
  • @type string (default: "OpentableReviewPhoto")
  • id string required
  • image string required
  • caption string nullable
• restaurant_reply object nullable
  • @type string (default: "OpentableRestaurantReply")
  • text string required
  • replied_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No OpenTable restaurant has this id, or since_review_id is not among its 10,000 most recently dined reviews. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.