v1

latestOpenAPI 3.0.02026-07-247251950.2 KB
Analytics

Retrieve weekly analytics

Overview

Get weekly aggregated sales and booking data broken down by week. Perfect for tracking week-over-week performance trends.

When to Use

  • Weekly performance dashboards - Show sales trends by week
  • Week-over-week comparisons - Identify growth patterns
  • Business reporting - Generate weekly reports for stakeholders
  • Performance monitoring - Track weekly sales metrics

What You Get

  • Weekly sales totals - Aggregated sales revenue per week
  • Week labels - Human-readable week identifiers (e.g., "week 12")
  • Time-series data - Ordered by week for easy charting

Quick Start

Provide a date range (from and to dates). The endpoint returns sales data grouped by week within that range.

post/analytics/weekly

Request body

fromstring date required

Start date for the analytics data YYYY-MM-DD (ISO 8601)

tostring date required

End date for the analytics data YYYY-MM-DD (ISO 8601)

Response

Weekly analytics data retrieved successfully