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

# Get notification statistics

> Retrieve detailed statistics for a specific wallet pass notification including delivery metrics,
click tracking, and engagement data.

**Statistics Include:**
- Delivery status and timestamps
- Click-through rates for notification links
- User engagement metrics
- Error tracking and failure reasons

**Pagination:**
- Use `cursor` parameter for next page navigation
- `limit` controls page size (default: 20, max: 20)




## OpenAPI

````yaml api-reference/openapi.json get /wallet-pass/notifications/{id}/stats
openapi: 3.1.0
info:
  title: Unblocked Wallet Passes API
  description: Unblocked Wallet Passes API
  version: 1.0.0
servers:
  - url: https://api.ubpass.co/v1
    description: Generated server url
security:
  - AccessToken: []
  - APIKey: []
tags:
  - name: Pique
    description: Get Pique Campaigns and their video performance data
  - name: Passport - Passes
    description: >-
      Create, update, retrieve, and delete wallet passes for Apple and Google
      platforms
  - name: Passport - Push Notifications
    description: Create, update, get, and delete wallet pass notifications
  - name: Passport - Locations
    description: Create, update, get, and delete wallet pass locations
  - name: Upload APIs
    description: Upload and manage pass assets and images
paths:
  /wallet-pass/notifications/{id}/stats:
    get:
      tags:
        - Passport - Push Notifications
      summary: Get notification statistics
      description: >
        Retrieve detailed statistics for a specific wallet pass notification
        including delivery metrics,

        click tracking, and engagement data.


        **Statistics Include:**

        - Delivery status and timestamps

        - Click-through rates for notification links

        - User engagement metrics

        - Error tracking and failure reasons


        **Pagination:**

        - Use `cursor` parameter for next page navigation

        - `limit` controls page size (default: 20, max: 20)
      operationId: getPassNotificationStats
      parameters:
        - name: x-workspace-id
          in: header
          description: >-
            Workspace ID to perform the operation in. If not provided, system
            will use the first one assigned to the user
          required: false
          schema:
            type: string
            pattern: ^[a-zA-Z0-9-_]+$
          example: 1f089d29-6f9c-66c2-af59-99631cec7ab5
        - name: id
          in: path
          description: Unique identifier of the notification to get statistics for
          required: true
          schema:
            type: string
            pattern: ^[a-zA-Z0-9-_]+$
          example: 1f089d37-5ebe-6778-af59-99631cec7ab5
        - name: cursor
          in: query
          description: Pagination cursor for fetching the next set of statistics records
          required: false
          schema:
            type: integer
            minimum: 0
          example: 0
        - name: limit
          in: query
          description: Number of statistics records to return per page (1-20, max 20)
          required: false
          schema:
            type: integer
            maximum: 20
            minimum: 1
          example: 20
      responses:
        '200':
          description: Successfully retrieved notification statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationStats'
              examples:
                Success Response:
                  summary: Notification statistics data
                  description: Success Response
                  value:
                    notificationId: 1f089d37-5ebe-6778-af59-99631cec7ab5
                    totalSent: 150
                    totalDelivered: 148
                    totalFailed: 2
                    totalClicks: 45
                    clickThroughRate: 30.4
                    deliveryRate: 98.7
                    lastUpdated: '2025-09-04T21:15:42.123Z'
                    linkStats:
                      - linkId: 1f089d37-8a1b-4c2d-9e3f-123456789abc
                        linkUrl: https://premiumbrands.com/vip-benefits
                        clickCount: 32
                        uniqueClicks: 28
                        lastClicked: '2025-09-04T20:45:30.456Z'
                      - linkId: 1f089d37-8a1b-4c2d-9e3f-123456789def
                        linkUrl: https://premiumbrands.com/offers
                        clickCount: 13
                        uniqueClicks: 12
                        lastClicked: '2025-09-04T19:22:15.789Z'
                    deliveryStats:
                      delivered: 148
                      failed: 2
                      pending: 0
                      failedReasons:
                        - reason: Invalid device token
                          count: 2
        '401':
          description: Unauthorized - Invalid or missing authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnblockedApiError'
              examples:
                Unauthorized Error:
                  summary: Authentication failed
                  description: Unauthorized Error
                  value:
                    txId: Root=1-68d3693c-26a3db2278c7668f5e086711
                    timestamp: 24-09-2025 03:45:00
                    errorCode: UNAUTHORIZED
                    errorMessage: UNAUTHORIZED.
        '404':
          description: Not Found - Notification ID not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnblockedApiError'
              examples:
                Not Found Error:
                  summary: Notification not found
                  description: Not Found Error
                  value:
                    txId: 1f098fa9-3786-64d4-b4ff-533200846d35
                    timestamp: 24-09-2025 03:57:23
                    errorCode: NOT_FOUND
                    errorMessage: Not found.
                    context:
                      id: 1f083424-11ed-617f-9513-1b26dc975ee2
components:
  schemas:
    NotificationStats:
      type: object
      properties:
        id:
          type: string
        createdTime:
          type: string
          format: date-time
          description: >-
            The time when the entity was created in ISO 8601 format including
            milliseconds and timezone offset.
          example: '2025-05-13T15:07:15.036Z'
        updatedTime:
          type: string
          format: date-time
          description: >-
            The time when the entity was last updated in ISO 8601 format
            including milliseconds and timezone offset.
          example: '2025-05-13T15:07:15.036Z'
        createdBy:
          type: string
          description: The user who created the entity.
        updatedBy:
          type: string
          description: The user who last updated the entity.
        workspaceId:
          type: string
          description: The ID of the workspace to which this entity belongs.
        totalNotificationsSent:
          type: integer
          format: int32
        totalLinksClicks:
          type: integer
          format: int32
        linkStats:
          $ref: '#/components/schemas/BXPagedListWorkspaceTopLinkStats'
    UnblockedApiError:
      type: object
      properties:
        txId:
          type: string
        timestamp:
          type: string
          format: date-time
        errorCode:
          type: string
        errorMessage:
          type: string
        context:
          type: object
          additionalProperties: {}
    BXPagedListWorkspaceTopLinkStats:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceTopLinkStats'
        cursor:
          type: string
        hasMore:
          type: boolean
    WorkspaceTopLinkStats:
      type: object
      properties:
        id:
          type: string
        createdTime:
          type: string
          format: date-time
          description: >-
            The time when the entity was created in ISO 8601 format including
            milliseconds and timezone offset.
          example: '2025-05-13T15:07:15.036Z'
        updatedTime:
          type: string
          format: date-time
          description: >-
            The time when the entity was last updated in ISO 8601 format
            including milliseconds and timezone offset.
          example: '2025-05-13T15:07:15.036Z'
        createdBy:
          type: string
          description: The user who created the entity.
        updatedBy:
          type: string
          description: The user who last updated the entity.
        workspaceId:
          type: string
          description: The ID of the workspace to which this entity belongs.
        linkUrl:
          type: string
        totalClicks:
          type: integer
          format: int32
  securitySchemes:
    AccessToken:
      type: http
      description: Bearer token authentication
      scheme: bearer
      bearerFormat: JWT
    APIKey:
      type: apiKey
      description: API Key authentication
      name: api-key
      in: header

````