GET
/
wallet-pass
/
notifications
/
{id}
/
stats
Get notification statistics
curl --request GET \
  --url https://api.ubpass.co/v1/wallet-pass/notifications/{id}/stats \
  --header 'api-key: <api-key>'
{
  "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
      }
    ]
  }
}

Authorizations

​
api-key
string
header
required

API Key authentication

Headers

​
x-workspace-id
string

Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user

Path Parameters

​
id
string
required

Unique identifier of the notification to get statistics for

Query Parameters

​
cursor
integer

Pagination cursor for fetching the next set of statistics records

Required range: x >= 0
​
limit
integer

Number of statistics records to return per page (1-20, max 20)

Required range: 1 <= x <= 20

Response

Successfully retrieved notification statistics

​
id
string
​
createdTime
string<date-time>

The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
updatedTime
string<date-time>

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
string

The user who created the entity.

​
updatedBy
string

The user who last updated the entity.

​
workspaceId
string

The ID of the workspace to which this entity belongs.

​
totalNotificationsSent
integer
​
totalLinksClicks
integer
​
linkStats
object