---
search:
  tags:
    - Dashboard
    - GET
seo:
  description: >-
    Any signed in user. Returns today's sales, revenue, and VAT with stock and…
    Reference for the GET /api/v1/dashboard/summary endpoint in the PharmaFlow
    API.
sidebar:
  label: Read the dashboard summary
  badge: GET
title: Read the dashboard summary
type: openapi-operation
---
Any signed in user. Returns today's sales, revenue, and VAT with stock and expiry counts. An empty branch_id rolls every figure up across all branches, and the trend compares today against yesterday.

`GET /api/v1/dashboard/summary`

**Responses**

- `200` — Today's totals and the stock and expiry counts
- `401` — Not authenticated

Response example, 200:

```json
{
  "today_sales_count": -9007199254740991,
  "today_revenue": "string",
  "today_vat": "string",
  "revenue_trend": 0,
  "sparkline_30d": [
    0
  ],
  "low_stock_count": -9007199254740991,
  "out_of_stock_count": -9007199254740991,
  "expiring_90_count": -9007199254740991,
  "expiring_30_count": -9007199254740991,
  "expired_count": -9007199254740991,
  "total_medicines": -9007199254740991
}
```