/hostelworld/properties/reviews/summary

POST /api/hostelworld/properties/reviews/summary

Price: 5 credits

Get the aggregated guest-review summary for a Hostelworld property by property id (or property URL): a concise editorial overview distilled from guest reviews highlighting what guests praise and what they flag, the number of guest reviews it is based on, and when the summary was produced.

How to use it

Fetch the aggregated guest-review summary for a single Hostelworld property by numeric property id or a property URL. Returns one item with id, url, summary (a short overview distilled from guest reviews), review_count (number of guest reviews the summary is based on) and generated_at (when the summary was produced). Only properties with enough guest reviews have a summary; others return not found.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• property string required — Hostelworld property id or a property URL containing it (examples: "88047", "https://www.hostelworld.com/hostels/p/88047/wombats-city-hostel-london/"; minLength: 1)

Response

• @type string (default: "HostelworldReviewSummary")
• id string required
• url string nullable
• summary string nullable
• review_count integer nullable
• generated_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 — No review summary available for this property (well-formed id with no generated summary, or a nonexistent property) 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.