Skip to content
Bottle

Get the reporting overview

GET
/reports/overview
curl --request GET \
  --url 'https://example.com/reports/overview?period=today&comparison=true' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Tenant-scoped order, invoice, customer and delivery trends, plus current debt, stock, cylinder and cash positions. Current positions do not change with the activity period.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
period
string
default: thirtyDays
Allowed values: today workingWeek sevenDays currentMonth thirtyDays currentQuarter custom
from
string format: date
to
string format: date
comparison
boolean | null
default: true

Responses

Section titled “Responses”

200

Section titled “200”

Reporting overview

Media typeapplication/json
object
generatedAt
required
string format: date-time
timezone
required
string
Allowed values: Europe/London
currency
required
string
Allowed values: GBP
period
required
string
Allowed values: today workingWeek sevenDays currentMonth thirtyDays currentQuarter custom
comparisonEnabled
required
boolean
range
required
object
startDate
required
string format: date
endDate
required
string format: date
label
required
string
comparisonRange
required
object
startDate
required
string format: date
endDate
required
string format: date
label
required
string
balanceAsOf
required
string format: date
metrics
required
object
orders
required
object
value
required
number | null
previous
required
number | null
unit
required
string
Allowed values: count pence percent
orderValue
required
object
value
required
number | null
previous
required
number | null
unit
required
string
Allowed values: count pence percent
invoiced
required
object
value
required
number | null
previous
required
number | null
unit
required
string
Allowed values: count pence percent
invoicesPaid
required
object
value
required
number | null
previous
required
number | null
unit
required
string
Allowed values: count pence percent
outstanding
required
object
value
required
number | null
previous
required
number | null
unit
required
string
Allowed values: count pence percent
overdue
required
object
value
required
number | null
previous
required
number | null
unit
required
string
Allowed values: count pence percent
newCustomers
required
object
value
required
number | null
previous
required
number | null
unit
required
string
Allowed values: count pence percent
deliverySuccess
required
object
value
required
number | null
previous
required
number | null
unit
required
string
Allowed values: count pence percent
orderValueTrend
required
Array<object>
object
date
required
string format: date
label
required
string
current
required
number
previous
number
deliveryTrend
required
Array<object>
object
date
required
string format: date
label
required
string
current
required
number
previous
number
customerTrend
required
Array<object>
object
date
required
string format: date
label
required
string
current
required
number
previous
number
channels
required
Array<object>
object
id
required
string
value
required
number
fulfilment
required
Array<object>
object
id
required
string
value
required
number
onlineShopSources
required
Array<object>
object
id
required
string
value
required
number
ageing
required
Array<object>
object
id
required
string
value
required
number
topProducts
required
Array<object>
object
id
required
string
name
required
string
quantity
required
number
value
required
number
customerInsights
required
object
returning
required
integer
inactive
required
integer
topCustomers
required
Array<object>
object
id
required
string
name
required
string
quantity
required
number
value
required
number
operations
required
object
roundsOut
integer
stockAlerts
required
integer
cylindersOnHire
required
integer
cashAwaitingHandInPence
required
integer
coverage
required
object
bottleShop
required
string
Allowed values: ready notConnected unavailable
woocommerce
required
string
Allowed values: ready notConnected unavailable
shopify
required
string
Allowed values: ready notConnected unavailable
note
required
string

Example 

{
  "timezone": "Europe/London",
  "currency": "GBP",
  "period": "today",
  "metrics": {
    "orders": {
      "unit": "count"
    },
    "orderValue": {
      "unit": "count"
    },
    "invoiced": {
      "unit": "count"
    },
    "invoicesPaid": {
      "unit": "count"
    },
    "outstanding": {
      "unit": "count"
    },
    "overdue": {
      "unit": "count"
    },
    "newCustomers": {
      "unit": "count"
    },
    "deliverySuccess": {
      "unit": "count"
    }
  },
  "coverage": {
    "bottleShop": "ready",
    "woocommerce": "ready",
    "shopify": "ready"
  }
}

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