Outscraper icon

Outscraper

Interact with Outscraper API

Actions49

Overview

This node integrates with the Outscraper API to retrieve Yelp reviews based on user queries. It is designed to fetch detailed review data for businesses listed on Yelp, supporting pagination and sorting options. This node is beneficial when you want to automate the extraction of Yelp reviews for sentiment analysis, reputation monitoring, or market research.

Practical examples:

  • Automatically gather recent customer reviews for a specific restaurant or store to analyze customer satisfaction trends.
  • Collect Yelp reviews sorted by rating or date to feed into a CRM or analytics platform.
  • Use asynchronous requests with webhooks to handle large datasets without blocking workflows.

Properties

Name Meaning
Query Search links or business URLs/IDs from Yelp to specify which business's reviews to retrieve.
Async Request Whether to make the request asynchronously (true/false). Useful for long-running tasks.
Webhook URL to receive a POST callback once an asynchronous task finishes.
Cursor Pagination cursor to fetch the next page of reviews.
Sort Sort order for reviews. Options: Date (Ascending), Date (Descending), Elites (Descending), Rating (Ascending), Rating (Descending), Relevance (Descending).
Cutoff Oldest timestamp value for reviews to filter out older reviews.
Additional Fields Collection of optional parameters:
- Fields Specific fields to return in the response (comma-separated).
- Enrichment Additional data enrichments to include (only applicable for search operation, not reviews).
- UI Whether to execute the request as a UI task (boolean).

Output

The node outputs JSON data containing the Yelp reviews matching the query and parameters. The structure typically includes:

  • Review details such as text, rating, date, reviewer information.
  • Pagination info if more results are available (cursor).
  • Metadata about the request and response status.

If asynchronous mode is enabled, the output may initially contain task status information, and the final data will be sent to the specified webhook URL.

No binary data output is indicated.

Dependencies

  • Requires an active Outscraper API key credential configured in n8n.
  • Internet access to call the Outscraper API endpoint.
  • Optional webhook URL for asynchronous operations.

Troubleshooting

  • Common issues:

    • Invalid or missing API key: Ensure the API key credential is correctly set up.
    • Incorrect query format: The "Query" property must be a valid Yelp business URL or ID.
    • Pagination errors: Using an invalid or expired cursor may cause no results or errors.
    • Asynchronous requests require a reachable webhook URL; otherwise, callbacks will fail.
  • Error messages:

    • Authentication errors: Check API key validity and permissions.
    • Rate limiting: Outscraper API may limit requests; consider using async mode or reducing request frequency.
    • Invalid parameter errors: Verify that all required properties are provided and correctly formatted.

Links and References

Discussion