---
title: "Getnetworkoverview"
method: GET
path: "/v2/giftcards/network/overview"
tags: ["Gift Cards"]
---

# Getnetworkoverview

`GET /v2/giftcards/network/overview`

### Network Overview

Returns aggregate statistics across the entire gift card network (all programs
and merchants). Intended for network-admin and reporting dashboards.

Groups card counts and transaction volumes by merchant, and returns overall totals.

**Status Codes**:
- 200: Overview returned successfully
- 401: Unauthorized
- 403: Forbidden (caller is not a network admin)

## Query parameters

- `programId` string
- `cardId` string

## Headers

- `X-Eposn-Customer-Token` string, nullable
- `X-Eposn-Merchant-Token` string, nullable

## Response `200`

Successful Response

- NetworkOverviewResponse
  - `totalMerchants` integer, required
  - `totalCards` integer, required
  - `totalTransactionVolume` string, required
  - `activeCards` integer, required
  - `totalTransactions` integer, required
  - `merchantBreakdowns` MerchantCardStats[], required
    - `merchantId` string, required
    - `merchantName` string, required
    - `cardCount` integer, required
    - `transactionVolume` string, required
  - `salesGrowth` string, nullable
  - `salesGrowthType` string, nullable
  - `merchantGrowth` string, nullable
  - `merchantGrowthType` string, nullable
  - `cardGrowth` string, nullable
  - `cardGrowthType` string, nullable
  - `txGrowth` string, nullable
  - `txGrowthType` string, nullable
  - `adoptionData` AdoptionDataPoint[]
    - `label` string, required
    - `value` integer, required
    - `secondaryValue` integer, required
  - `revenueData` RevenueDataPoint[]
    - `label` string, required
    - `value` integer, required
  - `breakage` BreakageData
    - `value` integer, required
    - `total` integer, required
    - `centerText` string, required
    - `label` string, required
  - `txFeeRevenue` string, nullable
  - `ltvUplift` string, nullable
  - `healthTxSuccessRate` number, nullable
  - `healthFraudAlerts` integer, nullable
  - `healthSupportTickets` integer, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/loyalty/apis/loyaltydog.md) · [All operations](https://skmtc.net/loyalty/apis/loyaltydog/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/loyalty/loyaltydog/versions/42b7b22af2b6/schema)
