docs/apis/rest-api/v2/reports.mdx
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
The reports API allows you to view all types of reports available.
This API lets you retrieve and view a simple list of available reports.
GET /wp-json/wc/v2/reports
curl https://example.com/wp-json/wc/v2/reports \
-u consumer_key:consumer_secret
WooCommerce.get("reports")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('reports')); ?>
print(wcapi.get("reports").json())
woocommerce.get("reports").parsed_response
[
{
"slug": "sales",
"description": "List of sales reports.",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v2/reports/sales"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v2/reports"
}
]
}
},
{
"slug": "top_sellers",
"description": "List of top sellers products.",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v2/reports/top_sellers"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v2/reports"
}
]
}
}
]
This API lets you retrieve and view a sales report.
GET /wp-json/wc/v2/reports/sales
curl https://example.com/wp-json/wc/v2/reports/sales?date_min=2016-05-03&date_max=2016-05-04 \
-u consumer_key:consumer_secret
WooCommerce.get("reports/sales", {
date_min: "2016-05-03",
date_max: "2016-05-04"
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$query = [
'date_min' => '2016-05-03',
'date_max' => '2016-05-04'
];
print_r($woocommerce->get('reports/sales', $query));
?>
print(wcapi.get("reports/sales?date_min=2016-05-03&date_max=2016-05-04").json())
query = {
date_min: "2016-05-03",
date_max: "2016-05-04"
}
woocommerce.get("reports/sales", query).parsed_response
[
{
"total_sales": "14.00",
"net_sales": "4.00",
"average_sales": "2.00",
"total_orders": 3,
"total_items": 6,
"total_tax": "0.00",
"total_shipping": "10.00",
"total_refunds": 0,
"total_discount": "0.00",
"totals_grouped_by": "day",
"totals": {
"2016-05-03": {
"sales": "14.00",
"orders": 3,
"items": 6,
"tax": "0.00",
"shipping": "10.00",
"discount": "0.00",
"customers": 0
},
"2016-05-04": {
"sales": "0.00",
"orders": 0,
"items": 0,
"tax": "0.00",
"shipping": "0.00",
"discount": "0.00",
"customers": 0
}
},
"total_customers": 0,
"_links": {
"about": [
{
"href": "https://example.com/wp-json/wc/v2/reports"
}
]
}
}
]
| Attribute | Type | Description |
|---|---|---|
total_sales | string | Gross sales in the period. READ-ONLY |
net_sales | string | Net sales in the period. READ-ONLY |
average_sales | string | Average net daily sales. READ-ONLY |
total_orders | integer | Total of orders placed. READ-ONLY |
total_items | integer | Total of items purchased. READ-ONLY |
total_tax | string | Total charged for taxes. READ-ONLY |
total_shipping | string | Total charged for shipping. READ-ONLY |
total_refunds | number | Total of refunded orders. READ-ONLY |
total_discount | integer | Total of coupons used. READ-ONLY |
totals_grouped_by | string | Group type. READ-ONLY |
totals | array | Totals. READ-ONLY |
| Parameter | Type | Description |
|---|---|---|
context | string | Scope under which the request is made; determines fields present in response. Default is view. Options: view. |
period | string | Report period. Default is today's date. Options: week, month, last_month and year |
date_min | string | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. |
date_max | string | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. |
This API lets you retrieve and view a list of top sellers report.
GET /wp-json/wc/v2/reports/top_sellers
curl https://example.com/wp-json/wc/v2/reports/top_sellers?period=last_month \
-u consumer_key:consumer_secret
WooCommerce.get("reports/top_sellers", {
period: "last_month"
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$query = [
'period' => 'last_month'
];
print_r($woocommerce->get('reports/top_sellers', $query));
?>
print(wcapi.get("reports/top_sellers?period=last_month").json())
query = {
period: "last_month"
}
woocommerce.get("reports/top_sellers", query).parsed_response
[
{
"title": "Happy Ninja",
"product_id": 37,
"quantity": 1,
"_links": {
"about": [
{
"href": "https://example.com/wp-json/wc/v2/reports"
}
],
"product": [
{
"href": "https://example.com/wp-json/wc/v2/products/37"
}
]
}
},
{
"title": "Woo Album #4",
"product_id": 96,
"quantity": 1,
"_links": {
"about": [
{
"href": "https://example.com/wp-json/wc/v2/reports"
}
],
"product": [
{
"href": "https://example.com/wp-json/wc/v2/products/96"
}
]
}
}
]
| Attribute | Type | Description |
|---|---|---|
title | string | Product title. READ-ONLY |
product_id | integer | Product ID. READ-ONLY |
quantity | integer | Total number of purchases. READ-ONLY |
| Parameter | Type | Description |
|---|---|---|
context | string | Scope under which the request is made; determines fields present in response. Default is view. Options: view. |
period | string | Report period. Default is week. Options: week, month, last_month and year |
date_min | string | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. |
date_max | string | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. |