/grubhub/restaurants/reviews

POST /api/grubhub/restaurants/reviews

Price: 5 credits

Get diner reviews for a Grubhub (grubhub.com) restaurant by numeric id (or restaurant page URL): review text, reviewer, star rating, sentiment, diner type, creation time and the menu items ordered.

How to use it

Fetch diner reviews for a Grubhub (grubhub.com) restaurant by its numeric id (e.g. '4255520') or a full restaurant page URL. Provide count. Optional: sort (most_recent/highest_rated). Each review has id, text, author, rating (1-5 stars), sentiment, diner_type, author_review_count, created_at, order_placed_at, items (the menu items ordered) and responses (any restaurant owner replies). Returns an empty list if the restaurant has no reviews.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• restaurant string required — Grubhub restaurant numeric id or a full restaurant page URL (examples: "4255520", "https://www.grubhub.com/restaurant/sunset-bagels/4255520"; minLength: 1)
• count integer required — Max number of reviews to return (min: 1)
• sort string — Sort order (default: "most_recent"; one of: "most_recent", "highest_rated")

Response

• @type string (default: "GrubhubReview")
• id string required
• text string nullable
• author string nullable
• rating integer nullable
• sentiment string nullable
• diner_type string nullable
• author_review_count integer nullable
• created_at integer nullable
• order_placed_at integer nullable
• items array (default: [])
• responses array (default: [])
  • @type string (default: "GrubhubReviewResponse")
  • text string nullable
  • source string nullable
  • responder_name string nullable
  • created_at string 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 — The entity was not found, or a precondition failed 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.