Skip to content
Bottle

List what Bottle has learned

GET
/rounds/learned
curl --request GET \
  --url https://example.com/rounds/learned \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Everything Bottle believes about this business and why, and what it stopped using.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

What Bottle has learned

Media typeapplication/json
object
enabled
required
boolean
items
required
Array<object>
object
editable
boolean
id
required
string format: uuid
stage
required
string
Allowed values: learned checking pleaseCheck youToldUs stopped
journey
required
string
Allowed values: hint trial trusted stale retired
about
required
string
Allowed values: customers driversAndVehicles howYouPlan
statement
required
string
supports
required
integer
contradicts
required
integer
plansUsed
required
integer
plansChanged
required
integer
canWarnOnPlan
required
boolean
stoppedByOwner
required
boolean
progress
required
object
measure
required
string
Allowed values: days plans
done
required
integer
needed
required
integer
> 0
heldBack
required
boolean
evidence
required
Array<object>
object
direction
required
string
Allowed values: supports contradicts
source
required
string
Allowed values: customer address order person roundEdit ownerAnswer
at
required
string format: date-time
firstSeenAt
required
string format: date-time
lastUsedAt
required
string | null format: date-time
checkAgainAt
required
string | null format: date-time
toldAt
required
string | null format: date-time
reviewAt
required
string | null format: date-time
outsideRota
object
driverUserId
required
string
start
required
string | null
end
required
string | null
rotaStart
required
string
rotaEnd
required
string
rules
required
object
supportingDays
required
integer
> 0
reviewedPlans
required
integer
> 0
reversals
required
integer
quietDays
required
integer
> 0
contradictionsInARow
required
integer
> 0
story
required
object
daysWatched
required
integer
firstWatchedOn
required
string | null
lastWatchedOn
required
string | null
ordersSent
required
integer
ordersAlsoPlanned
required
integer
sameDriver
required
integer
planLevel
required
string
Allowed values: background suggest send exceptions holiday
daysToSuggest
required
integer
> 0
daysCounted
required
integer
more
required
string
Allowed values: closed needsDays needsAgreement held ready

Example 

{
  "items": [
    {
      "stage": "learned",
      "journey": "hint",
      "about": "customers",
      "progress": {
        "measure": "days"
      },
      "evidence": [
        {
          "direction": "supports",
          "source": "customer"
        }
      ]
    }
  ],
  "story": {
    "planLevel": "background",
    "more": "closed"
  }
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not the owner in the office app, or on a plan without rounds

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

The words can’t be kept, with the reason

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}