/retty/reviews

POST /api/retty/reviews

Price: 1 credit

Get one review from Retty (retty.me): title, full text, score, meal, visit and posting dates, likes, photos, tags, the restaurant, the reviewer and the replies

How to use it

Review ids come from retty/restaurants/reviews, retty/users/reviews and retty/reviews/latest.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• review string required — Retty review id or review URL (examples: "61541041", "https://retty.me/area/PRE13/ARE1/SUB101/100000037961/61541041/"; minLength: 1)

Response

• @type string (default: "RettyReview")
• id string required
• url string nullable
• restaurant_id string nullable
• text string nullable
• score string nullable
• scene string nullable
• best_of_year integer nullable
• is_just_visited boolean nullable
• created_at integer nullable
• visit_date integer nullable
• like_count integer nullable
• want_to_go_count integer nullable
• photos array (default: [])
  • @type string (default: "RettyPhoto")
  • url string required
  • id string nullable
  • kind string nullable
• tags array (default: [])
  • @type string (default: "RettyTag")
  • id string required
  • text string nullable
• author object nullable
  • @type string (default: "RettyReviewer")
  • id string required
  • url string required
  • name string nullable
  • review_count integer nullable
  • author_status string nullable
  • specialities array (default: [])
  • is_pro boolean nullable
• restaurant object nullable
  • @type string (default: "RettyReviewRestaurant")
  • id string required
  • url string nullable
  • name string nullable
  • categories array (default: [])
  • nearest_station string nullable
• replies array (default: [])
  • @type string (default: "RettyReply")
  • id string required
  • text string nullable
  • created_at integer nullable
  • user_id string nullable
  • user_name string nullable

Errors

• 422 — review is not a Retty review id or URL 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 Retty review under that id 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.