---
title: "Get statistics for loyalty dashboard"
method: GET
path: "/v1/loyalty_programs/{loyaltyProgramId}/dashboard"
tags: ["Loyalty"]
---

# Get statistics for loyalty dashboard

`GET /v1/loyalty_programs/{loyaltyProgramId}/dashboard`

## Request

- Base URL: `https://yourbaseurl.talon.one`
- URL: `https://yourbaseurl.talon.one/v1/loyalty_programs/{loyaltyProgramId}/dashboard`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/talon/apis/management-api/docs/v1/loyalty_programs/:loyaltyProgramId/dashboard/get.ts> (a function with typed inputs; its response is checked against the schema)

> [!note] Management API endpoints are **not** meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Retrieve the statistics displayed on the specified loyalty program's
dashboard, such as the total active points, pending points, spent points, and expired
points.

> [!important] The returned data does not include the current day. All statistics
> are updated daily at 11:59 PM in the loyalty program time zone.

## Path parameters

- `loyaltyProgramId` integer, required

## Query parameters

- `subledgerId` string
- `rangeStart` string, date-time, required
- `rangeEnd` string, date-time, required

## Response `200`

OK

- object
  - `totalResultSize` integer, required
  - `data` LoyaltyDashboardData[], required
    - `date` string, date-time, required: Date at which data point was collected.
    - `totalActivePoints` number, required: Total of active points for this loyalty program.
    - `totalPendingPoints` number, required: Total of pending points for this loyalty program.
    - `totalSpentPoints` number, required: Total of spent points for this loyalty program.
    - `totalExpiredPoints` number, required: Total of expired points for this loyalty program.
    - `totalNegativePoints` number, required: Total of negative points for this loyalty program.
    - `totalMembers` number, required: Number of loyalty program members.
    - `newMembers` number, required: Number of members who joined on this day.
    - `spentPoints` LoyaltyDashboardPointsBreakdown, required
      - `createdManually` number, required
      - `createdViaRuleEngine` number, required
    - `earnedPoints` LoyaltyDashboardPointsBreakdown, required
      - `createdManually` number, required
      - `createdViaRuleEngine` number, required

---

[API](https://skmtc.dev/talon/apis/management-api.md) - [All operations](https://skmtc.dev/talon/apis/management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/talon/apis/management-api/revisions/7ef1b9504c3a?raw)