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

# Pass breakdown by type (brand)

> Returns counts of wallet passes grouped by pass type across the brand. Use for high-level inventory and adoption reporting.



## OpenAPI

````yaml /openapi/brand-api.json get /{brand_id}/pass-breakdown
openapi: 3.0.0
info:
  title: Bambu Brand API
  description: >-
    Partner APIs for issuing and managing wallet cards, activations,
    transactions, SMS, and program configuration. Start with the Guides tab for
    authentication and your first issue-wallet call.
  version: 1.0.0
servers:
  - url: https://api.bambumeta.software/brands
    description: Production
  - url: https://api-sandbox.bambumeta.software/brands
    description: Sandbox
security: []
tags:
  - name: brand
    description: Brand setup and configuration
  - name: brand-activation
    description: Onboarding activations and issue-wallet for an activation
  - name: brands
    description: Custom brand attribute fields
  - name: link-activation
    description: Distribution link activation CRUD
  - name: onboarding
    description: >-
      Program onboarding metrics (internal tag, grouped under reporting in the
      portal)
  - name: program
    description: Program setup and transactions
  - name: reporting
    description: Pass and stage breakdown reports
  - name: sms
    description: Send outbound SMS messages
  - name: subscription
    description: SMS subscription enrollment and stage updates
  - name: template
    description: Wallet template management
  - name: transactions
    description: Transaction types, records, and program transactions
  - name: wallet
    description: Issue, retrieve, update, and delete wallet cards
  - name: wallet-bulk
    description: Bulk pass updates and scheduled changes
  - name: workflow
    description: Trigger workflows that issue or update passes
paths:
  /{brand_id}/pass-breakdown:
    get:
      tags:
        - reporting
        - onboarding
      summary: Pass breakdown by type (brand)
      description: >-
        Returns counts of wallet passes grouped by pass type across the brand.
        Use for high-level inventory and adoption reporting.
      parameters:
        - name: brand_id
          in: path
          description: Brand Identifier
          required: true
          style: simple
          explode: false
          schema:
            type: number
          example: '353'
        - name: template_id
          in: query
          description: Template Identifier
          required: false
          schema:
            type: number
        - name: template_tier_id
          in: query
          description: Template Tier Identifier
          required: false
          schema:
            type: number
        - name: start_date
          in: query
          description: Filter by start_date
          schema:
            type: string
        - name: end_date
          in: query
          description: Filter by end_date
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PassBreakdown'
              example:
                - templateId: 100
                  templateName: Membership
                  count: 1250
                - templateId: 101
                  templateName: VIP
                  count: 84
      security:
        - cognito-authorizer:
            - https://admin.bambumeta.software/ui
components:
  schemas:
    PassBreakdown:
      type: object
      properties:
        walletPassesCreated:
          type: number
          description: Total number of passes created
        walletPassesInstalled:
          type: number
          description: Total number of passes installed
        walletPassesUninstalled:
          type: number
          description: Total number of passes uninstalled
        deviceBreakdown:
          type: object
          description: Breakdown of active installations by device installs
          properties:
            devicesInstalled:
              type: number
              description: Total number of devices installed
            appleWallet:
              type: number
              description: Total number of devices installed with Apple Wallet
            googleWallet:
              type: number
              description: Total number of devices installed with Google Wallet
  securitySchemes:
    cognito-authorizer:
      type: apiKey
      name: Authorization
      in: header

````