Get this person’s reporting dashboard layout

GET

/reports/layout

const url = 'https://example.com/reports/layout';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

sessionCookie
reports:read
apiKey
reports:read

Responses

200

Reporting widget order, sizes and visibility

application/json

object

items

required

Array<object>

<= 15 items

object

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

Not signed in

application/json

object

error

required

string

message

required

string

Example

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

403

Not allowed

application/json

object

error

required

string

message

required

string

Example

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