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>"
}
'
{
  "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
}

Body

application/json
dry_run
boolean
default:false
date
string

Response

Optimization result

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