/saramin/companies/reviews

POST /api/saramin/companies/reviews

Price: 5 credits

Get Saramin company employee-review statistics by company id

How to use it

Get the employee-review statistics for a company on Saramin by its id. Returns the company name, logo, industry, company type, employee count, years in business and CEO, the number of employees who took part, the employee-voted best workplace-culture tags, the share of employees who say the job helps their career, the review poll statistics (each a question with its total and former-employee response counts and the answer options with their percentages), and the reported welfare benefits with how often each was mentioned.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Saramin company id (csn token), or a company URL containing it (examples: "aTArMW5EbXVaUFRYcTNNdVQ1VFdJQT09", "https://www.saramin.co.kr/zf_user/company-review/view?csn=aTArMW5EbXVaUFRYcTNNdVQ1VFdJQT09"; minLength: 1)
• count integer required — Max number of review statistics to return (min: 1)

Response

• @type string (default: "SaraminCompanyReview")
• id string required
• name string required
• url string required
• image string nullable
• industry string nullable
• company_type string nullable
• employee_count integer nullable
• years_in_business integer nullable
• ceo string nullable
• participant_count integer nullable
• best_culture array (default: [])
• recommend_ratio number nullable
• statistics array (default: [])
  • @type string (default: "SaraminReviewStat")
  • question string required
  • total_count integer nullable
  • former_employee_count integer nullable
  • former_employee_ratio number nullable
  • answers array (default: [])
    • @type string (default: "SaraminReviewAnswer")
    • text string required
    • ratio number nullable
• welfare_stats array (default: [])
  • @type string (default: "SaraminReviewWelfare")
  • name string required
  • mention_count integer 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 — Company not found or has no reviews 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.