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

# Update Settings

> Configure the Yelp Reviews Export scraper settings

Configure your Yelp Reviews Export squid settings. Filter reviews by rating, sort order, language, or keyword, and use `fetch_since` to collect only recent reviews.

## Headers

<ParamField header="Authorization" type="string" required>
  Your API authentication token. Value: `Token YOUR_API_KEY`
</ParamField>

<ParamField header="Content-Type" type="string" required>
  Request body format. Value: `application/json`
</ParamField>

## Scraper Parameters

Set these parameters in the `params` object:

| Parameter                          | Type    | Default       | Description                                                                                                                                                                                        |
| ---------------------------------- | ------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **max\_results**                   | integer | unlimited     | Maximum number of reviews to collect per business URL                                                                                                                                              |
| **max\_unique\_results\_per\_run** | integer | unlimited     | Maximum unique reviews across all tasks in the run                                                                                                                                                 |
| **sort**                           | string  | `Yelp Sort`   | Sort order: `Yelp Sort`, `Newest First`, `Oldest First`, `Highest Rated`, `Lowest Rated`, `Elites`                                                                                                 |
| **rating**                         | string  | `All Ratings` | Filter by star rating: `All Ratings`, `5 Stars`, `4 Stars`, `3 Stars`, `2 Stars`, `1 Star`                                                                                                         |
| **language**                       | string  | —             | Filter reviews by language (ISO 639-1 code, e.g. `en`, `fr`, `de`). Leave empty to collect all languages.                                                                                          |
| **fetch\_since**                   | string  | —             | Stop scraping when reviews older than this threshold are reached. Use a relative duration (`24h`, `7d`, `2w`) or an absolute date (`YYYY-MM-DD HH:MM:SS`). Works best with `sort: "Newest First"`. |
| **term**                           | string  | —             | Keyword to search inside review text (e.g. `great service`). When set, `sort` and `rating` filters are ignored.                                                                                    |

## Squid Settings

Configure general squid settings:

| Setting                     | Type    | Description                                      |
| --------------------------- | ------- | ------------------------------------------------ |
| **name**                    | string  | Display name for your squid configuration        |
| **concurrency**             | integer | Number of parallel scraping threads (default: 1) |
| **export\_unique\_results** | boolean | Export only unique results (deduplicated)        |
| **to\_complete**            | boolean | Run until all tasks complete                     |
| **no\_line\_breaks**        | boolean | Remove line breaks from results                  |

<Tip>
  Use `rating: "1 Star"` combined with `sort: "Newest First"` to monitor recent negative reviews for reputation management.
</Tip>

<Note>
  When `term` is set, Yelp overrides the sort and rating parameters server-side — they will be ignored.
</Note>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://api.lobstr.io/v1/squids/YOUR_SQUID_HASH" \
    -H "Authorization: Token YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Yelp Reviews Export (1)",
      "concurrency": 1,
      "export_unique_results": true,
      "to_complete": false,
      "no_line_breaks": true,
      "params": {
        "max_results": 500,
        "sort": "Newest First",
        "rating": "All Ratings"
      }
    }'
  ```

  ```python Python theme={null}
  import requests

  API_KEY = "YOUR_API_KEY"
  BASE_URL = "https://api.lobstr.io/v1"
  headers = {"Authorization": f"Token {API_KEY}"}

  squid_id = "YOUR_SQUID_HASH"

  response = requests.post(f"{BASE_URL}/squids/{squid_id}",
      headers=headers,
      json={
          "name": "Yelp Reviews Export (1)",
          "concurrency": 1,
          "export_unique_results": True,
          "to_complete": False,
          "no_line_breaks": True,
          "params": {
              "max_results": 500,
              "sort": "Newest First",
              "rating": "All Ratings"
          }
      }
  )

  data = response.json()
  print(f"Settings updated: {data['name']}")
  ```
</CodeGroup>

## Response

```json 201 theme={null}
{
  "name": "Yelp Reviews Export (1)",
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "max_results": 500,
    "sort": "Newest First",
    "rating": "All Ratings"
  }
}
```