BFF API - SOM GUI API Specification

Endpoints

Order Statistics

Overview

The Order Statistics API provides insights into order metrics, including statistics by state and overall order count within a specified timeframe. The API enables tracking and analysis of order trends to support business decision-making.

Get Order Statistics by State

GET /orderStatistics/byState

• Description: Retrieves order statistics categorized by state within a specified timeframe.
• Authentication: Required (Bearer Token)
• Query Parameters:
  • timestampFrom (string, date-time, optional): Start timestamp for filtering results.
  • timestampTo (string, date-time, optional): End timestamp for filtering results.
• Responses:
  • 200 OK: Returns order statistics grouped by state.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Requested resource not found.
  • 500 Internal Server Error: Unexpected server error.

Get Order Count Statistics

GET /orderStatistics/orderCount

• Description: Retrieves aggregated order count statistics within a specified timeframe, optionally grouped by a specified unit.
• Authentication: Required (Bearer Token)
• Query Parameters:
  • timestampFrom (string, date-time, optional): Start timestamp for filtering results.
  • timestampTo (string, date-time, optional): End timestamp for filtering results.
  • groupUnit (enum, optional): Unit for grouping statistics (e.g., epochDay, week, month, year).
• Responses:
  • 200 OK: Returns aggregated order count statistics.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Requested resource not found.
  • 500 Internal Server Error: Unexpected server error.