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

# Extract Trustpilot Reviews

> Extracts reviews from Trustpilot efficiently.

To extract reviews from Trustpilot, follow these steps to set up the action:

<Steps>
  <Step title="Navigate to Trustpilot">
    Go to Trustpilot [https://www.trustpilot.com](https://www.trustpilot.com).
  </Step>

  <Step title="Search for the Brand">
    Search for the brand you wish to extract reviews from.
  </Step>

  <Step title="Input the URL">
    Paste the URL into the provided field. An example input should look like:
    [https://www.trustpilot.com/review/paul-rich.com/](https://www.trustpilot.com/review/paul-rich.com/).
  </Step>
</Steps>

## Inputs

<ParamField path="trustpilot_reviews_url" type="string" required={true} primary={true}>
  Input should contain a valid Trustpilot review URL, such as
  [https://www.trustpilot.com/review/](https://www.trustpilot.com/review/).
</ParamField>

## Parameters

<ParamField path="first_time" type="boolean" default={false} format="checkbox">
  If checked, the action will extract all reviews without any limitation.
</ParamField>

<ParamField path="max_date" type="string" default="" title="Earliest date">
  The earliest date to scrape reviews from.
</ParamField>

<ParamField path="number_days" type="string" default="" title="Maximum number of days">
  The maximum number of days since the reviews were published.
</ParamField>

<ParamField path="max_results" type="number" default={1000} minimum={0} maximum={50000}>
  The maximum number of reviews to extract.
</ParamField>

<ParamField path="stop_obsolete" type="boolean" default={false} format="checkbox">
  Stop at the first obsolete review filtered by one of the conditions.
</ParamField>

<ParamField path="excluded_publishers" type="string" default="" title="Ignored publishers">
  List of publishers to ignore, separated by semicolons.
</ParamField>

## Output Fields

The action returns the following fields:

<ResponseField>
  <Expandable title="properties">
    <ResponseField name="answer" type="string">
      The response to the review.
    </ResponseField>

    <ResponseField name="answer_date" type="string">
      The date the response was made.
    </ResponseField>

    <ResponseField name="author_first_name" type="string">
      The first name of the review author.
    </ResponseField>

    <ResponseField name="author_last_name" type="string">
      The last name of the review author.
    </ResponseField>

    <ResponseField name="author_name" type="string">
      The full name of the review author.
    </ResponseField>

    <ResponseField name="author_total_reviews" type="integer">
      Total number of reviews by the author.
    </ResponseField>

    <ResponseField name="content" type="string">
      The content of the review.
    </ResponseField>

    <ResponseField name="created_at" type="string">
      The creation date of the review.
    </ResponseField>

    <ResponseField name="experience_date" type="string">
      The date of the experience being reviewed.
    </ResponseField>

    <ResponseField name="global_trust_score" type="number">
      The global trust score of the review.
    </ResponseField>

    <ResponseField name="grade" type="integer">
      The grade given in the review.
    </ResponseField>

    <ResponseField name="order_ref" type="string">
      The order reference associated with the review.
    </ResponseField>

    <ResponseField name="review_date" type="string">
      The date the review was published.
    </ResponseField>

    <ResponseField name="review_name" type="string">
      The name of the review.
    </ResponseField>

    <ResponseField name="source" type="string">
      The source of the review.
    </ResponseField>

    <ResponseField name="start_url" type="string">
      The initial URL used for scraping.
    </ResponseField>

    <ResponseField name="title" type="string">
      The title of the review.
    </ResponseField>

    <ResponseField name="trustpilot_author_url" type="string">
      The URL of the author's Trustpilot profile.
    </ResponseField>

    <ResponseField name="trustpilot_review_id" type="string">
      The unique ID of the review on Trustpilot.
    </ResponseField>

    <ResponseField name="trustpilot_reviews_url" type="string">
      The URL of the Trustpilot reviews page.
    </ResponseField>
  </Expandable>
</ResponseField>

Below is the JSON schema for the output fields:

<Accordion title="Show JSON Output Schema">
  ```json
  {
      "answer": "string",
      "answer_date": "string",
      "author_first_name": "string",
      "author_last_name": "string",
      "author_name": "string",
      "author_total_reviews": "integer",
      "content": "string",
      "created_at": "string",
      "experience_date": "string",
      "global_trust_score": "number",
      "grade": "integer",
      "order_ref": "string",
      "review_date": "string",
      "review_name": "string",
      "source": "string",
      "start_url": "string",
      "title": "string",
      "trustpilot_author_url": "string",
      "trustpilot_review_id": "string",
      "trustpilot_reviews_url": "string"
  }
  ```
</Accordion>