/sitejabber/businesses/reviews

POST /api/sitejabber/businesses/reviews

Price: 5 credits

Get Sitejabber (smartcustomer.com) customer reviews for a business by website domain

How to use it

Get customer reviews for a business on Sitejabber (smartcustomer.com) by its website domain (e.g. 'amazon.com'). Returns each review's title, text, rating, publish and experience dates, verified status, helpful/comment/view counts, per-dimension ratings with reasons, author profile, the official business reply (if any), attributes, reviewer location, products used, and attached photos.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• business string required — Business domain ('amazon.com') or full review page URL (examples: "amazon.com", "fashionnova.com"; minLength: 1; pattern: ^(?:https?://)?(?:www\.)?[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}(?:[/?#].*)?$)
• count integer required — Number of reviews to return (min: 1)

Response

• @type string (default: "SitejabberReview")
• id integer required
• review_no integer nullable
• text string nullable
• tip string nullable
• rating integer nullable
• published_at string nullable
• experience_date string nullable
• is_verified boolean (default: false)
• source string nullable
• positive_vote_count integer nullable
• negative_vote_count integer nullable
• comment_count integer nullable
• view_count integer nullable
• author object nullable
  • @type string (default: "SitejabberReviewAuthor")
  • id integer required
  • first_name string nullable
  • last_name string nullable
  • alias string nullable
  • review_count integer nullable
  • positive_vote_count integer nullable
  • image string nullable
  • is_identity_verified boolean (default: false)
• business_reply object nullable
  • @type string (default: "SitejabberBusinessReply")
  • id integer required
  • text string nullable
  • published_at string nullable
  • vote_count integer nullable
  • author object nullable
    • @type string (default: "SitejabberReviewAuthor")
    • id integer required
    • first_name string nullable
    • last_name string nullable
    • alias string nullable
    • review_count integer nullable
    • positive_vote_count integer nullable
    • image string nullable
    • is_identity_verified boolean (default: false)
• dimension_ratings array (default: [])
  • @type string (default: "SitejabberReviewDimensionRating")
  • name string required
  • value integer required
  • reason string nullable
• attributes array (default: [])
  • @type string (default: "SitejabberReviewAttribute")
  • id string required
  • label string nullable
  • value string nullable
• location object nullable
  • @type string (default: "SitejabberReviewLocation")
  • country_code string nullable
  • country string nullable
  • region string nullable
• products_used array (default: [])
• images array (default: [])

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 — Business 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.