Skip to content
Bottle

Save this person’s reporting dashboard layout

PUT
/reports/layout
curl --request PUT \
  --url https://example.com/reports/layout \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "items": [ { "id": "keyFigures", "size": "medium", "columns": 1, "newRow": true, "visible": true } ] }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
items
required
Array<object>
<= 15 items
object
id
required
string
Allowed values: keyFigures orderValue orderChannels deliverySuccess moneyOutstanding topProducts customerGrowth customerInsights deliveryOrCollection rightNow orderFeeds mostDeliveredProducts stockMovements cylindersWithCustomers vehicleLoading
size
required
string
Allowed values: medium wide full
columns
integer
>= 3 <= 12
newRow
boolean
visible
required
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Saved reporting layout

Media typeapplication/json
object
items
required
Array<object>
<= 15 items
object
id
required
string
Allowed values: keyFigures orderValue orderChannels deliverySuccess moneyOutstanding topProducts customerGrowth customerInsights deliveryOrCollection rightNow orderFeeds mostDeliveredProducts stockMovements cylindersWithCustomers vehicleLoading
size
required
string
Allowed values: medium wide full
columns
integer
>= 3 <= 12
newRow
boolean
visible
required
boolean

Example 

{
  "items": [
    {
      "id": "keyFigures",
      "size": "medium"
    }
  ]
}

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 allowed

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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