Skip to main content
PATCH
/
v1
/
scrapers
/
{retailerCode}
/
config
Update scraper configuration
curl --request PATCH \
  --url http://localhost:3000/v1/scrapers/{retailerCode}/config \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_enabled": true,
  "schedule_cron": "<string>",
  "schedule_description": "<string>",
  "location_ids": [
    "<string>"
  ],
  "max_workers": 25,
  "batch_size": 255,
  "rate_limit_delay": 5.25,
  "alert_on_failure": true,
  "alert_on_error_rate": true,
  "error_rate_threshold": 50
}
'
import requests

url = "http://localhost:3000/v1/scrapers/{retailerCode}/config"

payload = {
"is_enabled": True,
"schedule_cron": "<string>",
"schedule_description": "<string>",
"location_ids": ["<string>"],
"max_workers": 25,
"batch_size": 255,
"rate_limit_delay": 5.25,
"alert_on_failure": True,
"alert_on_error_rate": True,
"error_rate_threshold": 50
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
is_enabled: true,
schedule_cron: '<string>',
schedule_description: '<string>',
location_ids: ['<string>'],
max_workers: 25,
batch_size: 255,
rate_limit_delay: 5.25,
alert_on_failure: true,
alert_on_error_rate: true,
error_rate_threshold: 50
})
};

fetch('http://localhost:3000/v1/scrapers/{retailerCode}/config', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v1/scrapers/{retailerCode}/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'is_enabled' => true,
'schedule_cron' => '<string>',
'schedule_description' => '<string>',
'location_ids' => [
'<string>'
],
'max_workers' => 25,
'batch_size' => 255,
'rate_limit_delay' => 5.25,
'alert_on_failure' => true,
'alert_on_error_rate' => true,
'error_rate_threshold' => 50
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "http://localhost:3000/v1/scrapers/{retailerCode}/config"

payload := strings.NewReader("{\n \"is_enabled\": true,\n \"schedule_cron\": \"<string>\",\n \"schedule_description\": \"<string>\",\n \"location_ids\": [\n \"<string>\"\n ],\n \"max_workers\": 25,\n \"batch_size\": 255,\n \"rate_limit_delay\": 5.25,\n \"alert_on_failure\": true,\n \"alert_on_error_rate\": true,\n \"error_rate_threshold\": 50\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("http://localhost:3000/v1/scrapers/{retailerCode}/config")
.header("Content-Type", "application/json")
.body("{\n \"is_enabled\": true,\n \"schedule_cron\": \"<string>\",\n \"schedule_description\": \"<string>\",\n \"location_ids\": [\n \"<string>\"\n ],\n \"max_workers\": 25,\n \"batch_size\": 255,\n \"rate_limit_delay\": 5.25,\n \"alert_on_failure\": true,\n \"alert_on_error_rate\": true,\n \"error_rate_threshold\": 50\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/scrapers/{retailerCode}/config")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_enabled\": true,\n \"schedule_cron\": \"<string>\",\n \"schedule_description\": \"<string>\",\n \"location_ids\": [\n \"<string>\"\n ],\n \"max_workers\": 25,\n \"batch_size\": 255,\n \"rate_limit_delay\": 5.25,\n \"alert_on_failure\": true,\n \"alert_on_error_rate\": true,\n \"error_rate_threshold\": 50\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "config": null
}

Path Parameters

retailerCode
string
required

Body

application/json
is_enabled
boolean
schedule_cron
string | null
Maximum string length: 100
schedule_description
string | null
Maximum string length: 100
location_ids
string[] | null
max_workers
integer
Required range: 1 <= x <= 50
batch_size
integer
Required range: 10 <= x <= 500
rate_limit_delay
number
Required range: 0.5 <= x <= 10
alert_on_failure
boolean
alert_on_error_rate
boolean
error_rate_threshold
integer
Required range: 1 <= x <= 100

Response

200 - application/json

Configuration updated

success
boolean
required
config
unknown