/flamp/firms/reviews

POST /api/flamp/firms/reviews

Price: 1 credit

Get reviews of a Flamp organization (firm) by its id

How to use it

Get reviews written about a Flamp organization by firm id. Each review has the text, star rating, author id, creation and edit dates, like and comment counts, and flags for whether the review carries photos or an official company answer.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• firm string required — Flamp firm id (the numeric id from the firm URL flamp.ru/firm/{slug}-{id}, or the full URL) (examples: "70000001057729636"; minLength: 1)
• count integer required — Max number of reviews to return (min: 1)
• sort string — Review ordering (default: "rating"; one of: "rating", "date_created")

Response

• @type string (default: "FlampReview")
• id string required
• text string required
• rating integer nullable
• is_recommended boolean (default: false)
• created_at string nullable
• edited_at string nullable
• like_count integer (default: 0)
• comment_count integer (default: 0)
• share_count integer (default: 0)
• source string nullable
• is_expert boolean (default: false)
• user_id string nullable
• filial_id string nullable
• author_review_count_about_filial integer (default: 0)
• has_photos boolean (default: false)
• has_official_answer boolean (default: false)
• url 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 — Firm not found for the given 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.