# mageplaza/module-reports

> Magento 2 Reports Extension

`composer require mageplaza/module-reports`

Canonical URL: https://packagento.com/mageplaza/module-reports

## At a glance

- **Vendor**: mageplaza (https://packagento.com/mageplaza.md)
- **Latest version**: 4.1.6 — released 2025-05-06
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/mageplaza/module-reports and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require mageplaza/module-reports:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Magento 2 Reports Extension

## README


**Mageplaza Magento 3 Advanced Reports** is a free extension which helps stores quickly access to advanced reports on Dashboard. As your shop grows, so is the amount of numbers you have to deal with everyday. Eventually, it would reach a point where you find yourself in dire need of a tool that can take care of the figures for you.

To facilitate the management of statistics, we proudly introduce **[Magento 2 Advanced Reports extension](https://www.mageplaza.com/magento-2-reports-extension/)** by Mageplaza. This module would help store admins keep their number neat and clean while enable them to see the level of progress made in comparison to the same period last month, last year and so on.


[![Latest Stable Version](https://poser.pugx.org/mageplaza/module-reports/v/stable)](https://packagist.org/packages/mageplaza/module-reports)
[![Total Downloads](https://poser.pugx.org/mageplaza/module-reports/downloads)](https://packagist.org/packages/mageplaza/module-reports)

**IMPORTANT NOTE: This version of Mageplaza Reports extension on Github is free as a contribution to the Magento community from Mageplaza. This package does not include the technical support. Should you need technical support for this extension, you will have to buy a license from Mageplaza. [Click here to buy](https://www.mageplaza.com/magento-2-reports-extension/).*

### 1. Advanced Reports Documentation
- [Mageplaza sale page](https://www.mageplaza.com/magento-2-reports-extension/)

- [Installation guide](https://www.mageplaza.com/install-magento-2-extension/)
- [User guide](https://github.com/magepages/mpdocs/blob/master/docs/reports/index.md)

### 2. Advanced Reports FAQs

Q: I got an error: `Mageplaza_Core` has been already defined

A: Read solution [here](https://github.com/mageplaza/module-core/issues/3)

Q: Can Reports be used with multiple stores? If so, how can I use it?

A: Yes, it can.
* Stores are set the default as the Default Configuration.
* To change the configuration for each store, need to remove tick at Use Website on the right of each option.
* Config of the extension in each store will be applied in the store itself.
* Config in this store doesn't affect the config in the other store.

### 3. How to install Magento 2 Advanced Reports extension

#### ✓ Install via composer (recommend)
Run the following command in Magento 2 root folder:

With Marketing Automation (recommend):
```
composer require mageplaza/module-reports mageplaza/module-smtp
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
```

Without Marketing Automation:
```
composer require mageplaza/module-reports
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
```

### 4. Magento 2 Advanced Reports features

#### New advanced reports

Along with other reports which are already accessible and available in default Magento 2, **Mageplaza Advanced Reports extension** complements two more advanced reports:
- **Sale by Location report**
- **Repeat customers rate report**

While the **Sale by location report** helps store owners have an overview of sales in specific countries/regions, that of Repeat customer rate shows how your loyalty program is doing in a visual way.

These statistical data are also ready to be compared with that of the previous period on a daily, monthly or even yearly basis.

![new advanced reports for Magento 2](https://i.imgur.com/Xz7maXc.png)

#### Customizable report period & report comparison

Store admins can select a period in which statistical data is demonstrated. **Mageplaza Advanced Reports Magento 2** allows you to show figures of:
* Today
* Yesterday
* Last 7 days
* Last 30 days
* This month
* Last month
* Custom range

With Custom Range, admins are able to select specific time for the report and will not be limited to any range of time.

![Magento 2 customizable report period & report comparison](https://i.imgur.com/v1Mrh7R.png)


##### Report comparison

Moreover, statistic data can be compared with that of the previous period which includes:
* The previous month
* The previous year
* Custom range

With **Custom Range**, store admins can filter figures which belong to a specific period of time to compare with the initial ones.

#### Line-chart reports

In **Mageplaza Advanced Reports standard version**; reports on repeat customer rate, transactions, total sales, average order value, tax, and shipping will be displayed as line charts. This provides store owners with a visual look at statistic data, making it easier to compare, follow and process figures. In every graph, the rates between numbers will also be shown with red standing for positive statistics and green indicating negative ones.

![Magento 2 line-chart reports](https://i.imgur.com/lpQDb5Y.png)

#### Flexible reports dashboard layouts

On the **Magento 2 dashboard**, store admins can drag and drop to move report areas and arrange figure sections with ease. Moreover, the report board’s size can be adjusted by pulling the double arrow. Let’s see the screen gif below:

![Magento 2 dashboard extension](https://i.imgur.com/cLbXk6G.gif)


### 5. More Magento 2 Reports features

#### Friendly presentation

Figures and numbers can be a headache to deal with. Thank to the extension, you can now view them in forms of charts and graphs, making them much easier to follow.

#### Rates & Changes

A great thing about Reports is its instant analysis. With just a quick glance, you can see how your current performance compared to that of previous periods. 

#### Enhance default reports

**Advanced Reports** better the default reports that come with Magento2. It adds further analysis of **Revenue, Tax, Shipping and Quantity**.

#### High compatibility

Advanced Reports extension is compatible with many [other Mageplaza products](https://www.mageplaza.com/magento-2-extensions/), such as **Reward points**,

_(README truncated for .md surface. Full README on https://packagento.com/mageplaza/module-reports.)_

## Changelog

CHANGELOG: https://www.mageplaza.com/releases/reports/

## Recent Versions

| Version | Released |
|---|---|
| 4.1.6 | 2025-05-06 |
| 4.1.5 | 2023-05-30 |
| 4.1.4 | 2022-08-30 |
| 1.4.2 | 2021-12-28 |
| 4.1.3 | 2021-12-28 |
| 4.1.2 | 2021-10-25 |
| 4.1.1 | 2021-09-13 |
| 1.4.1 | 2021-09-13 |
| 1.4.0 | 2021-05-26 |
| 4.1.0 | 2021-05-26 |

Showing 10 of 23 versions. Full release history on https://packagento.com/mageplaza/module-reports.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| mageplaza/module-core | ^1.5.13 |

## Quality

Latest release (4.1.6) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 207 | 207 warnings (ruleset: Magento2) — 155 auto-fixable with phpcbf |
| PHPMD | Warning | 26 | 26 rule violations (IfStatementAssignment:13, MissingImport:6, UnusedFormalParameter:2, NumberOfChildren:1, ExcessiveClassComplexity:1) |
| Cpd | Warning | 3 | 3 duplicated chunks spanning 91 total lines (min-lines=5, min-tokens=70) |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 58 | 58 | – | – |
| 2.4.8 | – | 58 | 58 | – |
| 2.4.9 | – | – | 56 | 56 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["mageplaza/module-reports"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

mageplaza is a Magento 2 vendor on Packagento. See https://packagento.com/mageplaza.md for their full catalogue.