/otzovik/objects/reviews

POST /api/otzovik/objects/reviews

Price: 20 credits

Get Otzovik (otzovik.com) reviews for an object by alias or review page URL

How to use it

Get reviews for an Otzovik object (product, service, place, company, etc.) by its alias (e.g. 'smartphone_apple_iphone_15'). Each review carries the title, summary text, rating, pros and cons, publish date, helpful and comment counts, attached photos, and the author (alias, reputation, location). Reviews can be ordered (most useful, newest, oldest) and filtered by sentiment or star rating.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• object string required — Object alias ('smartphone_apple_iphone_15') or full review page URL (examples: "smartphone_apple_iphone_15"; minLength: 1; pattern: ^(?:https?://[^\s]+|//[^\s]+|/?(?:reviews/)?[A-Za-z0-9][A-Za-z0-9_\-/]*)$)
• count integer required — Number of reviews to return (min: 1)
• order string — Review ordering (default: "useful"; one of: "useful", "newest", "oldest")
• ratio string — Filter reviews by sentiment or star rating (default: "all"; one of: "all", "positive", "negative", "star5", "star4", "star3", "star2", "star1")

Response

• @type string (default: "OtzovikReviewTeaser")
• id integer required
• text string nullable
• rating integer nullable
• pros string nullable
• cons string nullable
• published_at string nullable
• helpful_count integer nullable
• comment_count integer nullable
• images array (default: [])
• author object nullable
  • @type string (default: "OtzovikReviewTeaserAuthor")
  • alias string required
  • karma integer nullable
  • location string nullable
  • image string nullable
  • url string nullable
• 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 — Object not found 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.