> ## Documentation Index
> Fetch the complete documentation index at: https://docs.loyalty.dog/llms.txt
> Use this file to discover all available pages before exploring further.

# Getnetworkoverview

> ### 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)



## OpenAPI

````yaml https://api.loyalty.dog/openapi.json get /v2/giftcards/network/overview
openapi: 3.1.0
info:
  title: LoyaltyDog
  description: >-

    Welcome to the LoyaltyDog API! This API provides access to our loyalty
    program features, allowing you to integrate with various platforms and
    manage your loyalty data.


    Want to query LoyaltyDog via an AI assistant (Claude, Cursor, Windsurf)? See
    the [MCP Integration guide](https://loyaltydog.ai/playground#mcp).
        
  termsOfService: https://loyalty.dog/loyalty-program-terms-service
  contact:
    name: LoyaltyDog Support
    url: https://loyalty.dog/contact-us
    email: support@loyalty.dog
  version: 1.0.1
servers:
  - url: https://api.loyalty.dog
    description: Production
security:
  - bearerAuth: []
paths:
  /v2/giftcards/network/overview:
    get:
      tags:
        - Gift Cards
      summary: Getnetworkoverview
      description: >-
        ### 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)
      operationId: getNetworkOverview_v2_giftcards_network_overview_get
      parameters:
        - name: programId
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/PydanticObjectId'
              - type: 'null'
            title: Programid
        - name: cardId
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/PydanticObjectId'
              - type: 'null'
            title: Cardid
        - name: X-Eposn-Customer-Token
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Eposn-Customer-Token
        - name: X-Eposn-Merchant-Token
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Eposn-Merchant-Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkOverviewResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PydanticObjectId:
      type: string
      maxLength: 24
      minLength: 24
      pattern: ^[0-9a-f]{24}$
      example: 5eb7cf5a86d9755df3a6c593
    NetworkOverviewResponse:
      properties:
        totalMerchants:
          type: integer
          title: Totalmerchants
        totalCards:
          type: integer
          title: Totalcards
        totalTransactionVolume:
          type: string
          title: Totaltransactionvolume
        activeCards:
          type: integer
          title: Activecards
        totalTransactions:
          type: integer
          title: Totaltransactions
        merchantBreakdowns:
          items:
            $ref: '#/components/schemas/MerchantCardStats'
          type: array
          title: Merchantbreakdowns
        salesGrowth:
          anyOf:
            - type: string
            - type: 'null'
          title: Salesgrowth
        salesGrowthType:
          anyOf:
            - type: string
            - type: 'null'
          title: Salesgrowthtype
        merchantGrowth:
          anyOf:
            - type: string
            - type: 'null'
          title: Merchantgrowth
        merchantGrowthType:
          anyOf:
            - type: string
            - type: 'null'
          title: Merchantgrowthtype
        cardGrowth:
          anyOf:
            - type: string
            - type: 'null'
          title: Cardgrowth
        cardGrowthType:
          anyOf:
            - type: string
            - type: 'null'
          title: Cardgrowthtype
        txGrowth:
          anyOf:
            - type: string
            - type: 'null'
          title: Txgrowth
        txGrowthType:
          anyOf:
            - type: string
            - type: 'null'
          title: Txgrowthtype
        adoptionData:
          items:
            $ref: '#/components/schemas/AdoptionDataPoint'
          type: array
          title: Adoptiondata
        revenueData:
          items:
            $ref: '#/components/schemas/RevenueDataPoint'
          type: array
          title: Revenuedata
        breakage:
          anyOf:
            - $ref: '#/components/schemas/BreakageData'
            - type: 'null'
        txFeeRevenue:
          anyOf:
            - type: string
            - type: 'null'
          title: Txfeerevenue
        ltvUplift:
          anyOf:
            - type: string
            - type: 'null'
          title: Ltvuplift
        healthTxSuccessRate:
          anyOf:
            - type: number
            - type: 'null'
          title: Healthtxsuccessrate
        healthFraudAlerts:
          anyOf:
            - type: integer
            - type: 'null'
          title: Healthfraudalerts
        healthSupportTickets:
          anyOf:
            - type: integer
            - type: 'null'
          title: Healthsupporttickets
      type: object
      required:
        - totalMerchants
        - totalCards
        - totalTransactionVolume
        - activeCards
        - totalTransactions
        - merchantBreakdowns
      title: NetworkOverviewResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MerchantCardStats:
      properties:
        merchantId:
          $ref: '#/components/schemas/PydanticObjectId'
        merchantName:
          type: string
          title: Merchantname
        cardCount:
          type: integer
          title: Cardcount
        transactionVolume:
          type: string
          title: Transactionvolume
      type: object
      required:
        - merchantId
        - merchantName
        - cardCount
        - transactionVolume
      title: MerchantCardStats
    AdoptionDataPoint:
      properties:
        label:
          type: string
          title: Label
        value:
          type: integer
          title: Value
        secondaryValue:
          type: integer
          title: Secondaryvalue
      type: object
      required:
        - label
        - value
        - secondaryValue
      title: AdoptionDataPoint
    RevenueDataPoint:
      properties:
        label:
          type: string
          title: Label
        value:
          type: integer
          title: Value
      type: object
      required:
        - label
        - value
      title: RevenueDataPoint
    BreakageData:
      properties:
        value:
          type: integer
          title: Value
        total:
          type: integer
          title: Total
        centerText:
          type: string
          title: Centertext
        label:
          type: string
          title: Label
      type: object
      required:
        - value
        - total
        - centerText
        - label
      title: BreakageData
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT access token obtained from POST /v2/token.

````