Reports - API Reference

Reports

# Reports

<div id="overview"></div>

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

---

<div id="list-all-reports"></div>

## List all reports

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

`getReports()`

<div id="create-a-report-api-call"></div>

### API Call

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

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

<div id="create-a-report-response"></div>

### Response

```dart 
List<Reports> instance
```
Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-reports" target="_BLANK">WooCommerce list reports</a>

<hr>

<div id="retrieve-sales-report"></div>

## Retrieve sales report

This API lets you retrieve and view a sales report.

`getSaleReports({})`

<div id="retrieve-sales-report-parameters"></div>

### Parameters

```dart
String context
String period
String dateMin
String dateMax
```

<div id="retrieve-sales-report-api-call"></div>

### API Call

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

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

<div id="retrieve-sales-report-response"></div>

### Response

```dart 
List<SalesReports> instance
```
Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#retrieve-sales-report" target="_BLANK">WooCommerce sales report</a>

<hr>

<div id="retrieve-top-sellers-report"></div>

## Retrieve top sellers report

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

`getTopSellerReports({})`

<div id="retrieve-top-sellers-report-parameters"></div>

### Parameters

```dart
String context,
String period,
String dateMin,
String dateMax,
```

<div id="retrieve-top-sellers-report-api-call"></div>

### API Call

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

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

<div id="retrieve-top-sellers-report-response"></div>

### Response

```dart 
List<TopSellerReport> instance
```
Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#retrieve-top-sellers-report" target="_BLANK">WooCommerce top seller report</a>

<hr>

<div id="retrieve-coupons-totals"></div>

## Retrieve coupons totals

This API lets you retrieve and view coupons totals report.

`getTotalCouponsReports()`

<div id="retrieve-coupons-totals-api-call"></div>

### API Call

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

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

<div id="retrieve-coupons-totals-response"></div>

### Response

```dart 
List<TotalReport> instance
```
Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#retrieve-coupons-totals" target="_BLANK">WooCommerce retrieve coupons totals</a>

<hr>

<div id="retrieve-customers-totals"></div>

## Retrieve customers totals

This API lets you retrieve and view customers totals report.

`getTotalCustomerReports()`

<div id="retrieve-customers-totals-api-call"></div>

### API Call

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

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

<div id="retrieve-customers-totals-response"></div>

### Response

```dart 
List<TotalReport> instance
```

Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#retrieve-customers-totals" target="_BLANK">WooCommerce retrieve customers totals</a>

<hr>

<div id="retrieve-orders-totals"></div>

## Retrieve orders totals

This API lets you retrieve and view orders totals report.

`getTotalOrderReports()`

<div id="retrieve-orders-totals-api-call"></div>

### API Call

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

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

<div id="retrieve-orders-totals-response"></div>

### Response

```dart 
List<TotalReport> instance
```

Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#retrieve-orders-totals" target="_BLANK">WooCommerce retrieve orders totals</a>

<hr>

<div id="retrieve-products-totals"></div>

## Retrieve products totals

This API lets you retrieve and view products totals report.

`getTotalProductReports()`

<div id="retrieve-products-totals-api-call"></div>

### API Call

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

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

<div id="retrieve-products-totals-response"></div>

### Response

```dart 
List<TotalReport> instance
```

Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#retrieve-products-totals" target="_BLANK">WooCommerce retrieve products totals</a>

<hr>

<div id="retrieve-reviews-totals"></div>

## Retrieve reviews totals

This API lets you retrieve and view reviews totals report.

`getTotalReviewReports()`

<div id="retrieve-reviews-totals-api-call"></div>

### API Call

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

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

<div id="retrieve-reviews-totals-response"></div>

### Response

```dart 
List<TotalReport> instance
```

Represents the following object - <a href="https://woocommerce.github.io/woocommerce-rest-api-docs/#retrieve-reviews-totals" target="_BLANK">WooCommerce retrieve reviews totals</a>

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();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Response

List<TotalReport> instance

Represents the following object - WooCommerce retrieve reviews totals