Skip to main content
POST
/
v1
/
sweeps
/
optimize
Optimize sweeps
curl --request POST \
  --url http://localhost:3000/v1/sweeps/optimize \
  --header 'Content-Type: application/json' \
  --data '
{
  "dry_run": false,
  "date": "<string>"
}
'
import requests

url = "http://localhost:3000/v1/sweeps/optimize"

payload = {
"dry_run": False,
"date": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({dry_run: false, date: '<string>'})
};

fetch('http://localhost:3000/v1/sweeps/optimize', 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/sweeps/optimize",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dry_run' => false,
'date' => '<string>'
]),
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/sweeps/optimize"

payload := strings.NewReader("{\n \"dry_run\": false,\n \"date\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", 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.post("http://localhost:3000/v1/sweeps/optimize")
.header("Content-Type", "application/json")
.body("{\n \"dry_run\": false,\n \"date\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/sweeps/optimize")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"dry_run\": false,\n \"date\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "dry_run": true,
  "plan": {
    "moves_count": 123,
    "sweeps_to_cancel": 123,
    "estimated_savings": 123,
    "moves": [
      {
        "from_sweep_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "to_sweep_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "items_count": 123,
        "reason": "<string>"
      }
    ]
  },
  "executed": true,
  "moved_items": 123,
  "cancelled_sweeps": 123
}
{
"error": "Not found"
}

Body

application/json
dry_run
boolean
default:false
date
string
Pattern: ^\d{4}-\d{2}-\d{2}$

Response

Optimization result

success
boolean
required
dry_run
boolean
required
plan
object
required
executed
boolean
required
moved_items
number
required
cancelled_sweeps
number
required