/ekiten/shops/reviews

POST /api/ekiten/shops/reviews

Price: 10 credits

Get user reviews of a shop on Ekiten (エキテン): title, full text, rating, posting date, likes, photos and the shop's reply

How to use it

Shop ids come from ekiten/shops/search; ekiten/shops carries the shop's rating and review count.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• shop string required — Ekiten shop id or shop URL (examples: "7084758", "https://www.ekiten.jp/shop_7084758/"; minLength: 1)
• sort string — Result order (default: "recommended"; one of: "recommended", "newest", "oldest", "highest_rated")
• count integer required — Max number of results (min: 1; max: 1000)

Response

• @type string (default: "EkitenReview")
• id string required
• shop_id string required
• shop_url string required
• text string nullable
• rating number nullable
• author_name string nullable
• author_url string nullable
• created_date integer nullable
• visit_date integer nullable
• budget string nullable
• like_count integer nullable
• reply_text string nullable
• reply_date integer nullable
• photo_urls array (default: [])

Errors

• 422 — shop is not an Ekiten shop 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 Ekiten shop 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.