Metrics
Mobile

High-level sales-order overview metrics from ClickHouse.

get/metrics/sales-orders/overview

Request

  • Base URL: https://api.floorworks.co.uk/api/v1
  • URL: https://api.floorworks.co.uk/api/v1/metrics/sales-orders/overview
  • Auth: OAuth 2 (password, token URL https://api.floorworks.co.uk/api/v1/auth)

Query parameters

srch_date_fromstring d/m/Y

Filter from date (d/m/Y).

srch_date_tostring d/m/Y

Filter to date (d/m/Y).

srch_period'today' | 'week' | 'month' | 'year'

Pre-defined period filter (e.g. today, week, month, year).

Response

Sales-order overview aggregations.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.