/sitejabber/businesses/search

POST /api/sitejabber/businesses/search

Price: 5 credits

Search businesses on Sitejabber (smartcustomer.com) by keyword

How to use it

Search businesses on Sitejabber (smartcustomer.com) by keyword (brand name or website). Returns matching businesses with domain, name, description, AI summary, overall rating, review count, per-dimension ratings, categories, and latest review snippet.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search keyword for businesses (examples: "nike", "online shopping"; minLength: 1)
• count integer required — Number of businesses to return (min: 1; max: 1000)

Response

• @type string (default: "SitejabberBusiness")
• id integer required
• domain string required
• name string nullable
• website_url string nullable
• description string nullable
• ai_summary string nullable
• subindustry string nullable
• founded integer nullable
• image string nullable
• rating number nullable
• review_count integer nullable
• positive_review_count integer nullable
• view_count integer nullable
• question_count integer nullable
• sj_score number nullable
• confidence_score number nullable
• warning_type string nullable
• warning_date string nullable
• is_closed boolean (default: false)
• is_claimable boolean nullable
• is_prohibited boolean (default: false)
• is_review_solicitor boolean (default: false)
• latest_review_text string nullable
• popular_review_terms array (default: [])
• platform_ranks object nullable
  • @type string (default: "SitejabberPlatformRanks")
  • alexa_global_rank integer nullable
  • alexa_us_rank integer nullable
• top_category object nullable
  • @type string (default: "SitejabberTopCategory")
  • name string required
  • display_name string nullable
  • position integer nullable
• fashion_attributes object nullable
• brand_images array (default: [])
• category_ratings object nullable
  • @type string (default: "SitejabberCategoryRatings")
  • service object nullable
    • @type string (default: "SitejabberDimensionRating")
    • average number nullable
    • vote_count integer nullable
  • value object nullable
    • @type string (default: "SitejabberDimensionRating")
    • average number nullable
    • vote_count integer nullable
  • shipping object nullable
    • @type string (default: "SitejabberDimensionRating")
    • average number nullable
    • vote_count integer nullable
  • returns object nullable
    • @type string (default: "SitejabberDimensionRating")
    • average number nullable
    • vote_count integer nullable
  • quality object nullable
    • @type string (default: "SitejabberDimensionRating")
    • average number nullable
    • vote_count integer nullable
• rating_methods array (default: [])
  • @type string (default: "SitejabberRatingMethod")
  • method string required
  • vote_count integer nullable
  • average number nullable
• rating_distribution object nullable
  • @type string (default: "SitejabberRatingDistribution")
  • positive integer nullable
  • neutral integer nullable
  • negative integer nullable
• socials object nullable
  • @type string (default: "SitejabberSocials")
  • facebook string nullable
  • twitter string nullable
  • linkedin string nullable
  • youtube string nullable
  • instagram string nullable
  • tiktok string nullable
  • pinterest string nullable
  • crunchbase string nullable
  • wikipedia string nullable
• locations array (default: [])
  • @type string (default: "SitejabberLocation")
  • email string nullable
  • phone string nullable
  • phone_country string nullable
  • street_address string nullable
  • street_address_2 string nullable
  • city string nullable
  • state string nullable
  • postal_code string nullable
  • country_code string nullable
  • country string nullable
  • is_primary boolean (default: false)
• contacts array (default: [])
  • @type string (default: "SitejabberContact")
  • type string required
  • name string nullable
  • contact string required
• categories array (default: [])
  • @type string (default: "SitejabberCategory")
  • id integer required
  • name string required
  • display_name string nullable
  • icon string nullable
  • review_count integer nullable
  • business_count integer nullable
• breadcrumbs array (default: [])
  • @type string (default: "SitejabberCategory")
  • id integer required
  • name string required
  • display_name string nullable
  • icon string nullable
  • review_count integer nullable
  • business_count integer 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 — The entity was not found, or a precondition failed 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.