/byoinnavi/clinics/reviews

POST /api/byoinnavi/clinics/reviews

Price: 20 credits

Get patient reviews of a clinic or hospital on Byoinnavi (病院なび): title, full text per category with scores, overall rating, author nickname, patient relation, gender and age group, visit period, posting date and the facility's replies

How to use it

Clinic ids come from byoinnavi/clinics/search; byoinnavi/clinics carries the clinic's rating.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• clinic string required — Byoinnavi clinic or pharmacy id or URL (examples: "16878", "https://byoinnavi.jp/clinic/16878", "https://byoinnavi.jp/pharm/205642"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 1000)

Response

• @type string (default: "ByoinnaviReview")
• id string required
• clinic_id string required
• url string required
• text string nullable
• rating integer nullable
• notes array (default: [])
  • @type string (default: "ByoinnaviReviewNote")
  • category string required
  • label string nullable
  • score integer nullable
  • text string nullable
• author_name string nullable
• patient_relation string nullable
• patient_gender string nullable
• patient_age_group string nullable
• visit_year integer nullable
• visit_month integer nullable
• visit_count string nullable
• time_at_clinic string nullable
• posted_date integer nullable
• replies array (default: [])
  • @type string (default: "ByoinnaviReply")
  • author_role string nullable
  • text string nullable
  • created_at integer nullable

Errors

• 422 — clinic is not a Byoinnavi clinic or pharmacy 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 Byoinnavi facility 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.