/caloo/hospitals/reviews

POST /api/caloo/hospitals/reviews

Price: 20 credits

Get patient reviews and postcard survey answers of a hospital on Caloo (病院口コミ検索カルー): full text, rating, author relation, age group and gender, specialty and disease tags, visit and posting period, wait time, fee, helpful votes, review photos and the hospital's replies

How to use it

Hospital ids come from caloo/hospitals/search. Reviews come first, then postcards; kind tells them apart, and posted_date is set only where Caloo publishes the posting day.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• hospital string required — Caloo hospital id or hospital URL (examples: "4130005266", "https://caloo.jp/hospitals/detail/4130005266"; minLength: 1)
• include_postcards boolean — Also return the hospital's postcard survey answers after its reviews (default: true)
• count integer required — Max number of results (min: 1; max: 2000)

Response

• @type string (default: "CalooReview")
• id string required
• kind string required (one of: "review", "postcard")
• hospital_id string required
• hospital_name string nullable
• hospital_area string nullable
• url string nullable
• text string nullable
• rating number nullable
• author_name string nullable
• author_relation string nullable
• author_age_group string nullable
• author_gender string nullable
• author_review_count integer nullable
• tags array (default: [])
  • @type string (default: "CalooTaxon")
  • code string required
  • name string nullable
  • group string nullable
• specialty_name string nullable
• disease_name string nullable
• visit_year integer nullable
• visit_month integer nullable
• posted_year integer nullable
• posted_month integer nullable
• posted_date integer nullable
• visit_type string nullable
• wait_time string nullable
• medicine string nullable
• fee string nullable
• fee_note string nullable
• treatment_category string nullable
• treatment_method string nullable
• helpful_count integer nullable
• vote_count integer nullable
• image string nullable
• images array (default: [])
• image_captions array (default: [])
• reply_text string nullable

Errors

• 422 — hospital is not a Caloo hospital 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 Caloo hospital 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.