> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hobbo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Reviews.io WOL

> This endpoint is used to fetch reviews from Reviews.io Wall of Love pages.



## OpenAPI

````yaml POST /reviews-io/wol
openapi: 3.1.0
info:
  title: OpenAPI Plant Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.hobbo.ai
    description: Main API server
  - url: https://py-api.hobbo.ai
    description: Python API server for scraper endpoints
security:
  - ApiKeyAuth: []
paths:
  /reviews-io/wol:
    post:
      description: >-
        This endpoint is used to fetch reviews from Reviews.io Wall of Love
        pages.
      requestBody:
        description: Reviews.io wall-of-love scraping parameters
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReviewsIoWolRequest'
        required: true
      responses:
        '200':
          description: Reviews fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewsIoWolResponse'
              examples:
                validationError:
                  value:
                    all_reviews: []
                    extra_information: {}
                    message: <string>
        '400':
          description: Validation error or unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                validationError:
                  value:
                    error: <string>
      servers:
        - url: https://py-api.hobbo.ai
components:
  schemas:
    ReviewsIoWolRequest:
      type: object
      required:
        - query
      properties:
        query:
          type: string
          description: Provide the Reviews.io Wall-of-Love page URL.
        reviews_to_fetch:
          type:
            - number
            - 'null'
          description: >-
            Number of reviews to fetch (default: all reviews, or within
            30-second timeout).
        sort_type:
          type:
            - string
            - 'null'
          enum:
            - most_recent
            - highest_rated
          default: most_recent
          description: Order in which reviews should be sorted.
        filter_by:
          type:
            - string
            - integer
            - 'null'
          enum:
            - helpful
            - 5
            - 4
            - 3
            - 2
            - 1
            - null
          default: null
          description: Filter applied to the reviews (by helpful votes or rating).
        is_text_formatted:
          type: boolean
          description: Returns the review text with visual formatting preserved.
          default: true
        sync_date:
          type:
            - string
            - 'null'
          description: 'Fetches reviews posted on a specific date using format: YYYY-MM-DD.'
        pagination_data:
          type:
            - object
            - 'null'
          description: Pagination metadata returned by previous Reviews.io responses.
    ReviewsIoWolResponse:
      type: object
      properties:
        all_reviews:
          type: array
          description: Array of fetched reviews
          items:
            type: object
            properties:
              query:
                type:
                  - string
                  - 'null'
                description: Original query URL
              review_id:
                type:
                  - string
                  - 'null'
                description: Identifier of the review
              author_name:
                type:
                  - string
                  - 'null'
                description: Name of the review author
              author_profile_url:
                type:
                  - string
                  - 'null'
                description: URL to the review author's profile
              author_profile_image_url:
                type:
                  - string
                  - 'null'
                description: Profile image URL of the author
              author_profile_image_url_org:
                type:
                  - string
                  - 'null'
                description: Original/high-resolution profile image URL
              author_badge_src:
                type:
                  - string
                  - 'null'
                description: Badge image associated with the reviewer
              review_text:
                type:
                  - string
                  - 'null'
                description: Content of the review
              is_verified:
                type:
                  - boolean
                  - 'null'
                description: Whether the review is marked as verified
              review_date:
                type:
                  - string
                  - 'null'
                description: Date when the review was posted
              review_rating:
                type:
                  - number
                  - 'null'
                description: Rating given in the review
              review_media:
                type:
                  - array
                  - 'null'
                description: Media items attached to the review
                items:
                  type: object
                  properties:
                    review_media_type:
                      type:
                        - string
                        - 'null'
                      description: Type of the media (image or video)
                    review_media_url:
                      type:
                        - string
                        - 'null'
                      description: Display URL of the media item
                    review_media_url_org:
                      type:
                        - string
                        - 'null'
                      description: Original/full-size media URL
                    thumbnail_url:
                      type:
                        - string
                        - 'null'
                      description: Thumbnail URL for video media
        extra_information:
          type: object
          properties:
            extra_information:
              type: object
              description: Additional metadata about the Reviews.io profile
            total_review_count:
              type:
                - integer
                - 'null'
              description: Total number of reviews fetched
            total_review_count_list:
              type:
                - array
                - 'null'
              items:
                type: integer
              description: List of review counts per page
        message:
          type: string
          description: Status message about the review extraction
    Error:
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code
        data:
          type: object
          description: Empty object or additional error data
        success:
          type: boolean
          description: Indicates operation failed
          example: false
        message:
          type: string
          description: Error message describing what went wrong

````