Reports

Overview

The reports API allows you to create, view, update, and delete individual, or a batch, of report codes.

List all reports

This API lets you retrieve and view a simple list of available reports.

getReports()

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
List<Reports> reports = await WooSignal.instance.getReports();
Copy

Response

List<Reports> instance
Copy

Represents the following object - WooCommerce list reports

Retrieve sales report

This API lets you retrieve and view a sales report.

getSaleReports({})

Parameters

String context
String period
String dateMin
String dateMax
Copy

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
List<SalesReports> salesReports = await WooSignal.instance.getSaleReports();
Copy

Response

List<SalesReports> instance
Copy

Represents the following object - WooCommerce sales report

Retrieve top sellers report

This API lets you retrieve and view a list of top sellers report.

getTopSellerReports({})

Parameters

String context,
String period,
String dateMin,
String dateMax,
Copy

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
List<TopSellerReport> topSellerReports = await WooSignal.instance.getTopSellerReports();
Copy

Response

List<TopSellerReport> instance
Copy

Represents the following object - WooCommerce top seller report

Retrieve coupons totals

This API lets you retrieve and view coupons totals report.

getTotalCouponsReports()

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
List<TotalReport> totalReports = await WooSignal.instance.getTotalCouponsReports();
Copy

Response

List<TotalReport> instance
Copy

Represents the following object - WooCommerce retrieve coupons totals

Retrieve customers totals

This API lets you retrieve and view customers totals report.

getTotalCustomerReports()

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
List<TotalReport> totalCustomerReports = await WooSignal.instance.getTotalCustomerReports();
Copy

Response

List<TotalReport> instance
Copy

Represents the following object - WooCommerce retrieve customers totals

Retrieve orders totals

This API lets you retrieve and view orders totals report.

getTotalOrderReports()

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
List<TotalReport> totalOrderReports = await WooSignal.instance.getTotalOrderReports();
Copy

Response

List<TotalReport> instance
Copy

Represents the following object - WooCommerce retrieve orders totals

Retrieve products totals

This API lets you retrieve and view products totals report.

getTotalProductReports()

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
List<TotalReport> totalOrderReports = await WooSignal.instance.getTotalProductReports();
Copy

Response

List<TotalReport> instance
Copy

Represents the following object - WooCommerce retrieve products totals

Retrieve reviews totals

This API lets you retrieve and view reviews totals report.

getTotalReviewReports()

API Call

// Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");

// Call API
List<TotalReport> totalOrderReports = await WooSignal.instance.getTotalReviewReports();
Copy

Response

List<TotalReport> instance
Copy

Represents the following object - WooCommerce retrieve reviews totals