API Playground

Test the ReviewData Lite API directly from your browser. This interactive playground allows you to make real API requests and see the responses in real-time.

Base URL

All API requests are made to: https://data.reviewdata.ai

Getting Started

Enter your API key in the field below each playground (a default test key is provided).
Test Request Reviews endpoint:
- Modify the business details in the request body
- Click "Send Request" to submit
- Initially returns "in_progress" status with task_id
- Webhook notification (optional) will be sent when complete
- Final response includes review data and pagination
Test Retrieve Data endpoint:
- Use the foreign_key and publisher_key from the request reviews payload
- Click "Send Request" to check status
- If complete, response includes:
  - Review data with author, rating, text etc.
  - Pagination details for large datasets
  - S3 URLs to download full review data

Monitor Progress:

In-progress response example:

{
 "task_id": "900e2ff4-2d25-4576-ab18-b9b8e73c0bd6",
 "foreign_key": "TEST_1751004113518_i6yxcl",
 "publisher_key": "maps.google.com",
 "response_message": [
   {
     "status": "in_progress",
     "message": "Task is currently being processed",
     "task_status": 101
   }
 ]

}

- Completed response includes full review data with pagination

Use Debug Tools:
- Click "Show Debug" to view request details
- Task ID and foreign key are tracked automatically
- Use "Reset" to start a new request

API Key Required

You'll need a valid API key to test the endpoints. Click here to request your API key.

Dynamic Foreign Keys & Task IDs

Request Reviews Endpoint: Generates a unique foreign key automatically every time the page loads (e.g., TEST_1703123456789_abc123)
Custom Foreign Keys: You can manually edit the foreign_key in the request body to use your own value - the debug panel will show exactly what was submitted
Data Retrieval Endpoint: Uses consistent default values including the same foreign_key (TEST_1751004113518_i6yxcl) - does not change on page reload
User Override: You can replace any field in the request body with your own values - if you have your own data for api_key, foreign_key, publisher_key, etc., simply edit the JSON and the request will proceed with your values
Response ID Tracking: The API returns different ID types depending on the endpoint:
- Request Reviews: Returns request_id (used for tracking submission)
- Task Status: Returns task_id (used for tracking processing status)
- The debug info clearly shows which type of ID is being displayed
Reset Functionality:
- Request Reviews: Click "Reset" to generate a new unique foreign key and restore defaults
- Data Retrieval: Click "Reset" to restore consistent default values (foreign_key remains the same)

Important Request Limitations

Each API request can only target ONE review platform at a time.

This means:

✅ Single request: Get reviews from Google Maps for McDonald's
❌ NOT allowed: Get reviews from Google Maps + Yelp + TripAdvisor for McDonald's in one request

For multiple platforms, submit separate requests:

Request 1: McDonald's reviews from Google Maps
Request 2: McDonald's reviews from Yelp
Request 3: McDonald's reviews from TripAdvisor

Example: If you want review data from 5 different platforms (Google Maps, Yelp, TripAdvisor, Facebook, etc.) for the same business location, you must submit 5 separate API requests.

Profile Key Cost Information

What is a Profile Key? The profile_key is the direct URL to your business on a review platform (e.g., your Google Maps listing URL, Yelp business page URL).

Cost Impact:

🟢 Provide the profile_key = Standard pricing (you pay only for review data extraction)
🔴 Don't provide profile_key = Standard pricing + extra business search fee

How it works:

✅ With profile_key: You give us the exact business URL → We extract reviews → You pay standard rate
❌ Without profile_key: You give us business name/address → We find your business URL → We extract reviews → You pay standard rate + search fee

💰 Save Money: Always include the profile_key in your requests and save it for future use to avoid the additional search costs.

Request Reviews

Submit a request to collect reviews from multiple review sites for a business.

Request Reviews

POST

Test this endpoint directly in your browser. Enter your API key and modify the request body as needed.

Retrieve Task

Retrieve task data and review content for a completed scraping task.

Sample Data Available

Use these pre-configured sample payloads to test the retrieve endpoint with real data:

Default Configuration: The retrieve endpoint will automatically load with these default values:

{
    "api_key": "YOUR_API_KEY_HERE",
    "page": 1,
    "page_size": 10,
    "task_id": "900e2ff4-2d25-4576-ab18-b9b8e73c0bd6",
    "foreign_key": "TEST_1751004113518_i6yxcl",
    "publisher_key": "maps.google.com",
}

TripAdvisor Sample:

{
    "api_key": "YOUR_API_KEY_HERE",
    "page": 1,
    "page_size": 10,
    "task_id": "67b75d9d-6139-42b7-8ef3-f8d3c8d18ccb",
    "foreign_key": "TEST_1751004113518_i6yxcl",
    "publisher_key": "tripadvisor.com",
}

Yelp Sample:

{
    "api_key": "YOUR_API_KEY_HERE",
    "page": 1,
    "page_size": 10,
    "task_id": "5950304f-ca5b-4274-a9e5-53c6494e85eb",
    "foreign_key": "TEST_1751004113518_i6yxcl",
    "publisher_key": "yelp.com",
}

Google Maps Sample:

{
    "api_key": "YOUR_API_KEY_HERE",
    "page": 1,
    "page_size": 10,
    "task_id": "900e2ff4-2d25-4576-ab18-b9b8e73c0bd6",
    "foreign_key": "TEST_1751004113518_i6yxcl",
    "publisher_key": "maps.google.com",
}

Note: The playground will automatically generate a unique foreign_key each time the page loads, but you can override any of these values with your own data as needed.

Copy any of these payloads into the request body below to test with real review data.

Retrieve Task

POST

Test this endpoint directly in your browser. Enter your API key and modify the request body as needed.

Configure Webhook

Set up webhook notifications for task status updates.

Configure Webhook

POST

Test this endpoint directly in your browser. Enter your API key and modify the request body as needed.

Example Responses

Successful Request Reviews Response

{
    "status": "success",
    "tasks_id": "900e2ff4-2d25-4576-ab18-b9b8e73c0bd6",
    "request_id": "9f9d2b5a-085c-4df3-bcca-20928f086925",
    "foreign_key": "TEST_1751004113518_i6yxcl",
    "publisher_key": "maps.google.com",
}

Response ID Fields

request_id: Unique identifier for the submission request
tasks_id: May also be returned as task_id in some responses
Both IDs can be used for tracking the request status

Successful Retrieve Task Response

{
    "foreign_key": "TEST_1751004113518_i6yxcl",
    "batch_id": "TEST_1751004113518_i6yxcl",
    "task_id": "900e2ff4-2d25-4576-ab18-b9b8e73c0bd6",
    "related_task_ids": [],
    "task_status": 200,
    "business": {
        "publisher": "maps.google.com",
        "profile_key": "https://www.google.com/maps/place/@40.7094789,-74.0126167,886m/data=!3m2!1e3!5s0x89c2592f4977ef97:0xf78d57398ac93494!4m7!3m6!1s0x89c25a177d4bf5db:0x84e51f23e8c0a75c!8m2!3d40.7094789!4d-74.0100364!10e1!16s%2Fg%2F1thtf190!5m1!1e1?entry=ttu&g_ep=EgoyMDI1MDY",
        "reviews_urls": [
            "https://prod-data-only-client.s3.amazonaws.com/Review_URLs/9f9d2b5a-085c-4df3-bcca-20928f086925/900e2ff4-2d25-4576-ab18-b9b8e73c0bd6_0.jl"
        ],
        "id": "restaurant_001",
        "name": "McDonald's",
        "tags": [
            "restaurant",
            "pizza",
            "italian",
            "casual"
        ],
        "phone": "+12123852066",
        "address": {
            "zip": "10038",
            "city": "New York",
            "state": "NY",
            "street": "160 Broadway",
            "country": "USA"
        },
        "description": "Classic, long-running fast-food chain known for its burgers & fries."
    },
    "reviews": [
        {
            "review_id": "Ci9DQUlRQUNvZENodHljRjlvT25wVFEzWkxPR1ZJYkdWS04zWjNlWEo2ZW01UVZGRRAB",
            "author_name": "Regimorais Raab",
            "author_id": null,
            "rating": 5,
            "text": "Rapidez incrível",
            "url": "https://www.google.com/maps/reviews/data=!4m8!14m7!1m6!2m5!1sCi9DQUlRQUNvZENodHljRjlvT25wVFEzWkxPR1ZJYkdWS04zWjNlWEo2ZW01UVZGRRAB!2m1!1s0x0:0x84e51f23e8c0a75c!3m1!1s2@1:CAIQACodChtycF9oOnpTQ3ZLOGVIbGVKN3Z3eXJ6em5QVFE%7C0cLUo1-b2qC%7C?hl=en",
            "posted_at": 1750727938010,
            "review_hash": "f2601fda3fb2e249204ff97d9710acd7",
            "language": "en"
        },
        {
            "review_id": "Ci9DQUlRQUNvZENodHljRjlvT2pFeFEzSXpjVW8zZUdkalFYQkRiR2hSV2xWdVIzYxAB",
            "author_name": "gloria schuweiler",
            "author_id": null,
            "rating": 3,
            "text": "Some  how they  been getting  my order wrong.",
            "url": "https://www.google.com/maps/reviews/data=!4m8!14m7!1m6!2m5!1sCi9DQUlRQUNvZENodHljRjlvT2pFeFEzSXpjVW8zZUdkalFYQkRiR2hSV2xWdVIzYxAB!2m1!1s0x0:0x84e51f23e8c0a75c!3m1!1s2@1:CAIQACodChtycF9oOjExQ3IzcUo3eGdjQXBDbGhRWlVuR3c%7C0cLP3KjBeBa%7C?hl=en",
            "posted_at": 1750704405791,
            "review_hash": "3de49930bb5221fce5bb352146649726",
            "language": "en"
        },
        {
            "review_id": "Ci9DQUlRQUNvZENodHljRjlvT2t0bVYyODNNRUo2VWxCMVVGcGhRVGxtYzBKNUxXYxAB",
            "author_name": "Zadran Akram khan",
            "author_id": null,
            "rating": 2,
            "text": "Happy Wellcomen New And Last Chef Akram Zadran",
            "url": "https://www.google.com/maps/reviews/data=!4m8!14m7!1m6!2m5!1sCi9DQUlRQUNvZENodHljRjlvT2t0bVYyODNNRUo2VWxCMVVGcGhRVGxtYzBKNUxXYxAB!2m1!1s0x0:0x84e51f23e8c0a75c!3m1!1s2@1:CAIQACodChtycF9oOktmV283MEJ6UlB1UFphQTlmc0J5LWc%7C0cKzlVRIta5%7C?hl=en",
            "posted_at": 1750596704474,
            "review_hash": "c11d5ca37c28d429beb161013fdd2c3d",
            "language": "en"
        },
        {
            "review_id": "ChZDSUhNMG9nS0VLUHNodGJuc18ycFR3EAE",
            "author_name": "Ivana Donev",
            "author_id": null,
            "rating": 4,
            "text": "",
            "url": "https://www.google.com/maps/reviews/data=!4m8!14m7!1m6!2m5!1sChZDSUhNMG9nS0VLUHNodGJuc18ycFR3EAE!2m1!1s0x0:0x84e51f23e8c0a75c!3m1!1s2@1:CIHM0ogKEKPshtbns_2pTw%7CCgwI8oq2wgYQsPr9wQE%7C?hl=en",
            "posted_at": 1749910898406,
            "review_hash": "d7f32bfcdd9e46b23f04b2d69e1fe373",
            "language": "en"
        },
        {
            "review_id": "Ci9DQUlRQUNvZENodHljRjlvT214TVVHTjNWMkZzVjFSMlQzQmhSMVoyYWtKZmRuYxAB",
            "author_name": "Ludovic Pagès",
            "author_id": null,
            "rating": 2,
            "text": "C'est déjà le bas du panier en France, ben ce n'est pas mieux sur Broadway à Wall Street. Je ne comprends pas pour quoi ça existe encore. Pour le reste ce resto a un service rapide et des toilettes propres.",
            "url": "https://www.google.com/maps/reviews/data=!4m8!14m7!1m6!2m5!1sCi9DQUlRQUNvZENodHljRjlvT214TVVHTjNWMkZzVjFSMlQzQmhSMVoyYWtKZmRuYxAB!2m1!1s0x0:0x84e51f23e8c0a75c!3m1!1s2@1:CAIQACodChtycF9oOmxMUGN3V2FsV1R2T3BhR1Z2akJfdnc%7C0cI7yCrlChX%7C?hl=en",
            "posted_at": 1749847949935,
            "review_hash": "56848456ebc3393b5aa98a3134242221",
            "language": "en"
        },
        {
            "review_id": "Ci9DQUlRQUNvZENodHljRjlvT20xS1UyWjRNR2hLTUdRd2RERmlVVXd4VDFOblgyYxAB",
            "author_name": "Aaron Moore",
            "author_id": null,
            "rating": 5,
            "text": "",
            "url": "https://www.google.com/maps/reviews/data=!4m8!14m7!1m6!2m5!1sCi9DQUlRQUNvZENodHljRjlvT20xS1UyWjRNR2hLTUdRd2RERmlVVXd4VDFOblgyYxAB!2m1!1s0x0:0x84e51f23e8c0a75c!3m1!1s2@1:CAIQACodChtycF9oOm1KU2Z4MGhKMGQwdDFiUUwxT1NnX2c%7C0cI4FOfmJHX%7C?hl=en",
            "posted_at": 1749832729734,
            "review_hash": "ce4e8f08dbe2fda5d996cf906b553450",
            "language": "en"
        },
        {
            "review_id": "ChZDSUhNMG9nS0VQX3FpdmVkMHBhSlNREAE",
            "author_name": "Cevdet S A",
            "author_id": null,
            "rating": 5,
            "text": "Like it.",
            "url": "https://www.google.com/maps/reviews/data=!4m8!14m7!1m6!2m5!1sChZDSUhNMG9nS0VQX3FpdmVkMHBhSlNREAE!2m1!1s0x0:0x84e51f23e8c0a75c!3m1!1s2@1:CIHM0ogKEP_qived0paJSQ%7CCgsI5p2pwgYQqMTXfA%7C?hl=en",
            "posted_at": 1749700326261,
            "review_hash": "433aa5e69074d92921cdac0b848ec3fd",
            "language": "en"
        },
        {
            "review_id": "Ci9DQUlRQUNvZENodHljRjlvT2pZelVUQTVVRkp3YVhGa1lUTlBVVk42VWxGcE9GRRAB",
            "author_name": "Vinod Sukhadia",
            "author_id": null,
            "rating": 5,
            "text": "",
            "url": "https://www.google.com/maps/reviews/data=!4m8!14m7!1m6!2m5!1sCi9DQUlRQUNvZENodHljRjlvT2pZelVUQTVVRkp3YVhGa1lUTlBVVk42VWxGcE9GRRAB!2m1!1s0x0:0x84e51f23e8c0a75c!3m1!1s2@1:CAIQACodChtycF9oOjYzUTA5UFJwaXFkYTNPUVN6UlFpOFE%7C0cHNU251Vof%7C?hl=en",
            "posted_at": 1749649347101,
            "review_hash": "aa0b25c137f7b386a6d392f91b54b5e0",
            "language": "en"
        },
        {
            "review_id": "ChZDSUhNMG9nS0VPM0E4N2k4a2V6SEJ3EAE",
            "author_name": "Husnain Ali",
            "author_id": null,
            "rating": 4,
            "text": "",
            "url": "https://www.google.com/maps/reviews/data=!4m8!14m7!1m6!2m5!1sChZDSUhNMG9nS0VPM0E4N2k4a2V6SEJ3EAE!2m1!1s0x0:0x84e51f23e8c0a75c!3m1!1s2@1:CIHM0ogKEO3A87i8kezHBw%7CCgwI4c2jwgYQ2Mjj1wE%7C?hl=en",
            "posted_at": 1749608161452,
            "review_hash": "b7e33c65de9262919ad22741f0554832",
            "language": "en"
        },
        {
            "review_id": "ChdDSUhNMG9nS0VJQ0FnSURwX3QtdHJBRRAB",
            "author_name": "Fred Alluso",
            "author_id": null,
            "rating": 4,
            "text": "Clean, noisy, crowded. Most importantly they didn't mess up my coffee order.",
            "url": "https://www.google.com/maps/reviews/data=!4m8!14m7!1m6!2m5!1sChdDSUhNMG9nS0VJQ0FnSURwX3QtdHJBRRAB!2m1!1s0x0:0x84e51f23e8c0a75c!3m1!1s2@1:CIHM0ogKEICAgIDp_t-trAE%7C0cMTWPpdFWz%7C?hl=en",
            "posted_at": 1692756313115,
            "review_hash": "924067883b209b62d4ffd556179d9634",
            "language": "en"
        }
    ],
    "pagination": {
        "total_reviews": 11820,
        "page": 1,
        "page_size": 10,
        "total_pages": 1182,
        "has_next": true,
        "has_previous": false
    }
}

Successful Webhook Configuration Response

{
  "webhook": "https://example.com/webhook",
  "status": "success"
}

Common Error Responses

Authentication Error (401)

{
  "error": "Invalid API key",
  "details": {
    "api_key": ["The provided API key is invalid or expired"]
  }
}

Validation Error (422)

{
  "error": "Invalid payload",
  "details": {
    "data": {
      "business": {
        "address": {
          "street": ["This field is required."]
        }
      }
    }
  }
}

Tips for Testing

1. Use Valid API Keys

Make sure your API key is valid and active
Contact support if you need a new API key

2. Test with Real Data

Use actual business URLs for profile_key fields
Ensure business addresses are accurate

3. Check Response Status

200-299: Success responses
400-499: Client errors (check your request)
500-599: Server errors (contact support)

4. Handle Pagination

Use page and page_size parameters for large datasets
Check pagination.has_next for more pages

5. Monitor Task Status

Tasks are processed asynchronously
Use webhooks for real-time notifications
Poll the retrieve endpoint for status updates

6. Workflow Testing

Submit Request: Use the Request Reviews playground to submit a new task
Note Task ID: The response will include a request_id or task_id
Retrieve Results: Use the Retrieve Task playground to check status and get results
Use Same Foreign Key: The playground automatically tracks and uses the same foreign key

Security Notes

API keys are not stored in your browser
Requests are sent directly to the API server
Responses are displayed in your browser only
No data is logged on this documentation site

Need Help?

If you encounter issues while testing:

Check the Error Codes documentation
Verify your API key is correct and active
Review the Examples for proper request format
Contact support at techsupport@shoutaboutus.com

Next Steps

Learn about Authentication
Explore Supported Review Sites
Check Webhook Examples for real-time notifications

API Playground

Base URL

Getting Started

Request Reviews

Request Reviews

Request Body (JSON)

Retrieve Task

Retrieve Task

Request Body (JSON)

Configure Webhook

Configure Webhook

Request Body (JSON)

Example Responses

Successful Request Reviews Response

Successful Retrieve Task Response

Successful Webhook Configuration Response

Common Error Responses

Authentication Error (401)

Validation Error (422)

Tips for Testing

1. Use Valid API Keys

2. Test with Real Data

3. Check Response Status

5. Monitor Task Status

6. Workflow Testing

Security Notes

Need Help?

Next Steps

Base URL​

Getting Started​

Request Reviews​

Request Reviews

Request Body (JSON)

Retrieve Task​

Retrieve Task

Request Body (JSON)

Configure Webhook​

Configure Webhook

Request Body (JSON)

Example Responses​

Successful Request Reviews Response​

Successful Retrieve Task Response​

Successful Webhook Configuration Response​

Common Error Responses​

Authentication Error (401)​

Validation Error (422)​

Tips for Testing​

1. Use Valid API Keys​

2. Test with Real Data​

3. Check Response Status​

4. Handle Pagination​

5. Monitor Task Status​

6. Workflow Testing​

Security Notes​

Need Help?​

Next Steps​

Base URL

Getting Started

Request Reviews

Retrieve Task

Configure Webhook

Example Responses

Successful Request Reviews Response

Successful Retrieve Task Response

Successful Webhook Configuration Response

Common Error Responses

Authentication Error (401)

Validation Error (422)

Tips for Testing

1. Use Valid API Keys

2. Test with Real Data

3. Check Response Status

4. Handle Pagination

5. Monitor Task Status

6. Workflow Testing

Security Notes

Need Help?

Next Steps