Docs

ReviewX Documentation

Everything you need to get started with ReviewX — from creating your first property profile to querying the API programmatically.

Quick Start

Go from zero to your first review dataset in under five minutes.

01

Sign up at reviewx.io

Create your free account in seconds. No credit card required to get started.

02

Create a property profile

Link your property by pasting its URL from any supported platform: Booking.com, Agoda, Expedia, OpenTable, Trip.com, Google.

03

Run your first crawl

Trigger a review crawl from your dashboard or via the API. Results arrive in 30–180 seconds.

04

Explore your reviews in the dashboard

Filter, search, analyse sentiment, and export your review data from one unified interface.

Authentication

All API endpoints require a JWT Bearer token. Obtain your token by calling POST /login with your credentials. Include the token in every subsequent request as an Authorization header.

Header format

Authorization: Bearer {your_token}

A successful response returns a token field and a full user object. Store the token securely — it expires based on your plan settings.

Base URL

BASEhttp://localhost:3001/raybags/v1/review-crawler

Next Steps