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

// CONFIG FOR WOOSIGNAL
var wsConfig = {
"appKey":"your app key",
"debugMode":true
};

// CREATING AN INSTANCE
WooSignal.getInstance(config: wsConfig).then( (wcStore) {
    wcStore.getReports().then( (reports) {
        print(reports.toString());
    });
});

Response

List<Reports> instance

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

API Call

// CONFIG FOR WOOSIGNAL
var wsConfig = {
"appKey":"your app key",
"debugMode":true
};

// CREATING AN INSTANCE
WooSignal.getInstance(config: wsConfig).then( (wcStore) {

    wcStore.getSaleReports({
      String context,
      String period,
      String dateMin,
      String dateMax,
      }).then( (salesReports) {
        print(salesReports.toString());
    });

});

Response

List<SalesReports> instance

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,

API Call

// CONFIG FOR WOOSIGNAL
var wsConfig = {
"appKey":"your app key",
"debugMode":true
};

// CREATING AN INSTANCE
WooSignal.getInstance(config: wsConfig).then( (wcStore) {

    wcStore.getTopSellerReports({
      String context,
      String period,
      String dateMin,
      String dateMax,
      }).then( (topSellerReports) {
        print(topSellerReports.toString());
    });
});

Response

List<TopSellerReport> instance

Represents the following object - WooCommerce top seller report


Retrieve coupons totals

This API lets you retrieve and view coupons totals report.

getTotalCouponsReports()

API Call

// CONFIG FOR WOOSIGNAL
var wsConfig = {
"appKey":"your app key",
"debugMode":true
};

// CREATING AN INSTANCE
WooSignal.getInstance(config: wsConfig).then( (wcStore) {

    wcStore.getTotalCouponsReports().then( (totalReports) {
        print(totalReports.toString());
    });
});

Response

List<TotalReport> instance

Represents the following object - WooCommerce retrieve coupons totals


Retrieve customers totals

This API lets you retrieve and view customers totals report.

getTotalCustomerReports()

API Call

// CONFIG FOR WOOSIGNAL
var wsConfig = {
"appKey":"your app key",
"debugMode":true
};

// CREATING AN INSTANCE
WooSignal.getInstance(config: wsConfig).then( (wcStore) {

    wcStore.getTotalCustomerReports().then( (totalReports) {
        print(totalReports.toString());
    });
});

Response

List<TotalReport> instance

Represents the following object - WooCommerce retrieve customers totals


Retrieve orders totals

This API lets you retrieve and view orders totals report.

getTotalOrderReports()

API Call

// CONFIG FOR WOOSIGNAL
var wsConfig = {
"appKey":"your app key",
"debugMode":true
};

// CREATING AN INSTANCE
WooSignal.getInstance(config: wsConfig).then( (wcStore) {

    wcStore.getTotalOrderReports().then( (totalReports) {
        print(totalReports.toString());
    });
});

Response

List<TotalReport> instance

Represents the following object - WooCommerce retrieve orders totals


Retrieve products totals

This API lets you retrieve and view products totals report.

getTotalProductReports()

API Call

// CONFIG FOR WOOSIGNAL
var wsConfig = {
"appKey":"your app key",
"debugMode":true
};

// CREATING AN INSTANCE
WooSignal.getInstance(config: wsConfig).then( (wcStore) {

    wcStore.getTotalProductReports().then( (totalReports) {
        print(totalReports.toString());
    });
});

Response

List<TotalReport> instance

Represents the following object - WooCommerce retrieve products totals


Retrieve reviews totals

This API lets you retrieve and view reviews totals report.

getTotalReviewReports()

API Call

// CONFIG FOR WOOSIGNAL
var wsConfig = {
"appKey":"your app key",
"debugMode":true
};

// CREATING AN INSTANCE
WooSignal.getInstance(config: wsConfig).then( (wcStore) {

    wcStore.getTotalReviewReports().then( (totalReports) {
        print(totalReports.toString());
    });
});

Response

List<TotalReport> instance

Represents the following object - WooCommerce retrieve reviews totals