---
title: "Reporting — overview"
method: GET
path: "/reporting/stats"
tags: ["Admin Reporting: Overview"]
---

# Reporting — overview

`GET /reporting/stats`

## Request

- Base URL: `http://localhost:8000/api/admin`
- URL: `http://localhost:8000/api/admin/reporting/stats`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bagisto/apis/bagisto-admin-api/docs/reporting/stats/get.ts> (a function with typed inputs; its response is checked against the schema)

Aggregate headline stats across sales/customers/products. Use `?type=` for the stat group; `?start=`, `?end=`, `?channel=` to bound the period.

## Query parameters

- `type` string
- `start` string, date
- `end` string, date
- `channel` string

## Response `200`

AdminReportingOverview collection

- AdminReportingOverview[]
  - `entity` string, nullable
  - `type` string, nullable
  - `dateRange` unknown[], nullable
    - unknown
  - `statistics` object, nullable

---

[API](https://skmtc.dev/bagisto/apis/bagisto-admin-api.md) - [All operations](https://skmtc.dev/bagisto/apis/bagisto-admin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bagisto/apis/bagisto-admin-api/revisions/3198f11be70f?raw)