> ## 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.

# Trustpilot Reviews

> This endpoint is used to fetch reviews from Trustpilot for a specified business.



## OpenAPI

````yaml POST /trust-pilot/reviews
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:
  /trust-pilot/reviews:
    post:
      description: >-
        This endpoint is used to fetch reviews from Trustpilot for a specified
        business.
      requestBody:
        description: Trustpilot review scraping parameters
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrustPilotReviewsRequest'
        required: true
      responses:
        '200':
          description: Reviews fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrustPilotReviewsResponse'
              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:
    TrustPilotReviewsRequest:
      type: object
      required:
        - query
      properties:
        query:
          type: string
          description: Provide a proper Trustpilot URL or Company Slug.
        sort_type:
          type: string
          description: Order in which reviews should be sorted
          enum:
            - relevance
            - recency
          default: relevance
        reviews_to_fetch:
          type: number
          description: >-
            Number of reviews to fetch (default: all reviews, or within
            30-second timeout)
        is_text_formatted:
          type: boolean
          description: 'returns the review text with visual formatting preserved '
        sync_date:
          type: string
          description: 'Fetches reviews posted on a specific date using format: YYYY-MM-DD'
    TrustPilotReviewsResponse:
      type: object
      properties:
        all_reviews:
          type: array
          description: Array of fetched reviews
          items:
            type: object
            properties:
              author_details:
                type: object
                description: Detailed information about the review author
                properties:
                  countryCode:
                    type: string
                    description: Country code of the author
                  displayName:
                    type: string
                    description: Display name of the author
                  hasImage:
                    type: boolean
                    description: Whether the author has a profile image
                  id:
                    type: string
                    description: Unique identifier for the author
                  imageUrl:
                    type: string
                    description: URL to the author's profile image
                  isVerified:
                    type: boolean
                    description: Whether the author is verified
                  numberOfReviews:
                    type: integer
                    description: Number of reviews written by the author
              author_profile_link:
                type: string
                description: URL to the author's profile
              is_filtered:
                type: boolean
                description: Whether the review is filtered
              is_pending:
                type: boolean
                description: Whether the review is pending
              productReviews:
                type: array
                description: Product-specific reviews if available
              query:
                type: string
                description: Original query URL
              reply:
                type:
                  - object
                  - 'null'
                description: Reply to the review if available
              review_date:
                type: string
                description: Date when the review was posted
              review_dates:
                type: object
                description: Various dates related to the review
                properties:
                  experiencedDate:
                    type: string
                    description: Date when the experience occurred
                  publishedDate:
                    type: string
                    description: Date when the review was published
                  submittedDate:
                    type:
                      - string
                      - 'null'
                    description: Date when the review was submitted if available
                  updatedDate:
                    type:
                      - string
                      - 'null'
                    description: Date when the review was last updated if available
              review_id:
                type: string
                description: ID of the review
              review_labels:
                type: object
                description: Labels associated with the review
                properties:
                  merged:
                    type:
                      - object
                      - 'null'
                    description: Merged information if available
                  verification:
                    type: object
                    description: Verification information
                    properties:
                      createdDateTime:
                        type: string
                        description: Date and time when the verification was created
                      hasDachExclusion:
                        type: boolean
                        description: Whether the review has DACH exclusion
                      isVerified:
                        type: boolean
                        description: Whether the review is verified
                      reviewSourceName:
                        type: string
                        description: Source of the review
                      verificationLevel:
                        type: string
                        description: Level of verification
                      verificationSource:
                        type: string
                        description: Source of verification
              review_language:
                type: string
                description: Language of the review
              review_text:
                type: string
                description: Content of the review
              review_title:
                type: string
                description: Title of the review
              review_url:
                type: string
                description: URL to the review
              source:
                type: string
                description: Source of the review
        extra_information:
          type: object
          properties:
            extra_information:
              type: object
              description: Additional metadata about the business
            total_review_count:
              type: integer
              description: Total number of reviews fetched
            total_review_count_list:
              type: array
              items:
                type: integer
              description: List of review counts
        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

````