Articles in this section

See more

Push Notification Export Formats

  • Updated
Follow

The push notification data represents all push notification events triggered by MyDataHelps. For all of the push notification events, a record can be uniquely identified using ParticipantID (or ParticipantIdentifier), Timestamp, NotificationIdentifier, PushEventKey, and DeviceIdentifier.

Each row in the Push Notification Export represents a notification and device registration. For example, if a participant is using two device types, there would be two rows for the participant in the export.

Table of Contents

Push Notification Opened

Push Notification Open events occur when the participant clicks on the push notification. These are recorded for both iOS and Android users.

If the participant swipes to clear a notification, it will not be recorded as opened.

The Push Notification Opened file contains the following fields.

Field Description
ParticipantID The stable, automatically generated, internal system identifier for this participant.
ParticipantIdentifier The identifier of the participant the notification or survey was delivered to. Can be used to cross reference with Participants.
Timestamp The timestamp of when the push notification was opened, in UTC.
DeviceIdentifier The identifier of the device that received the push notification.
PushEventKey The push event key is a unique identifier that is specific to each push notification event.
NotificationIdentifier The organization-specific identifier of the notification that was sent. This is the identifier shown in the Notifications library.

Push Notification Received

Push Notification Open events occur when the notification is delivered to the participant’s device and the participant is logged into MyDataHelps at the same time.

Received Events are recorded for Android users only.

The Push Notification Received file contains the following fields.

Field Description
ParticipantID The stable, automatically generated, internal system identifier for this participant.
ParticipantIdentifier The identifier of the participant the notification or survey was delivered to. Can be used to cross reference with Participants.
Timestamp The timestamp of when the push notification was received, in UTC.
DeviceIdentifier The identifier of the device that received the push notification.
PushEventKey The push event key is a unique identifier that is specific to each push notification event.
NotificationIdentifier The organization-specific identifier of the notification that was sent. This is the identifier shown in the Notifications library.

Push Notification Sent

Push Notification Sent events occur when the notification is sent from MyDataHelps Designer to the participant’s device. These are recorded for both iOS and Android users.

All send events will be recorded in this file, regardless of whether the participant was logged into MyDataHelps at the time the notification was sent.

The Push Notification Sent file contains the following fields.

Field Description
ParticipantID The stable, automatically generated, internal system identifier for this participant.
ParticipantIdentifier The identifier of the participant the notification or survey was delivered to. Can be used to cross reference with Participants.
Timestamp The timestamp of push notification was sent, in UTC.
Body The body text of the push notification.
PushEventKey The push event key is a unique identifier that is specific to each push notification event.
NotificationIdentifier The organization-specific identifier of the notification that was sent. This is the identifier shown in the Notifications library.
Title The title text of the push notification.

Sample CSV Export

ParticipantIdentifier,Timestamp,Body,NotificationIdentifier,Title,ParticipantID,PushEventKey
641d313d-7144-4534-ac28-719e0904253e,2022-03-22T16:35:21Z,Welcome to our study!,Welcome-Push-1,Welcome,61fd00e8-eea9-ec11-aaab-f47bb6835a10,sjdsneyq20248

Sample JSON Export

{
  "ParticipantID":"61fd00e8-eea9-ec11-aaab-f47bb6835a10",
  "ParticipantIdentifier":"641d313d-7144-4534-ac28-719e0904253e",
  "Timestamp":"2022-03-22T16:35:21Z",
  "PushEventKey":"sjdsneyq20248"
  "Properties":
    {
      "NotificationIdentifier": "Welcome-Push-1", 
      "Title": "Welcome",
      "Body": "Welcome to our study!"
    }
}

Related articles