Data Retention

Manage data retention settings to periodically delete uncontactable profile and audit log data

As your project grows, so does the volume of data stored on the platform including records for users who have long since become inactive or uncontactable. Removing this data ensures your campaigns reach the right audience and helps you meet your obligations under GDPR, which requires that you only hold data that is necessary.

Data Retention Settings let you define how long specific types of data are kept on the platform. Once a record reaches the end of its configured retention period, it is automatically deleted. The deletion job runs on a schedule, so your data is kept clean without any manual intervention.

Overview

Under Settings > Advanced > Data Retention, you can control how long the following are retained on a project:

  • User Profiles (Web only): Specifies how long uncontactable profiles are retained on the platform before deletion. This applies only to projects that have a website configured in Xtremepush.
  • Audit Logs: Specifies how long profile and campaign audit log records are retained before removal.

For each data type, you configure a duration for which the data is stored on the platform. After this duration passes, the data is deleted.

This check runs daily for User Profiles and monthly for Audit Logs. For example, if you have configured Uncontactable Web Profiles to be deleted after 31 days, the platform checks every day for profiles that have crossed that mark. You can see when this last ran and when it is next scheduled to run under Last Run and Next Scheduled Run sections.

🚧

Deletion is Permanent

Deletion through data retention is permanent and irreversible. Once data is removed, it cannot be restored. Review your retention periods carefully before saving any changes

The following roles can access Data Retention Settings:

RoleViewEdit
Provider Admin
Company Admin
Data Protection Officer
Project Admin
📘

All other roles cannot view or access Data Retention Settings. Xtremepush Support can view your settings if you need assistance contact your account manager or our support team.

Manage your Data Retention Policy

Go to Settings > Advanced> Data Retention to manage your data retention policy.

The page is divided into two sections: User Profiles Retention and Audit Log Retention. Each section can be enabled or disabled independently.

Click Edit to make changes, and use the toggle at the top of each section to enable or disable retention for that data type.

📘

Data Retention Audit Log

Any change you make to your data retention policy is recorded in the Audit Log tab. Each entry shows the date and time of the change, the action taken, the section affected, the user who made the change, and a summary of what was updated.

User Profile Retention

When you use the Xtremepush web SDK, a profile is created for each unique visitor to your website. The following are the three types of uncontactable profiles you can configure a retention period for, each specified in days:

  • Uncontactable Web Devices: A web device that the platform cannot send push notifications to because there is no valid push token. This can happen if the user never completed web push registration, or if their browser push subscription has expired or been revoked.
  • Uncontactable Anonymous Profiles: A profile with no user ID and no contact details on any channel, so the platform has no way to reach the user. The profile has no email address, no mobile number, no WhatsApp number, and no associated mobile or web devices.
  • Uncontactable Identified Profiles: A profile with a user ID but no contact details on any channel, so the platform has no way to reach the user. The profile has no email address, no mobile number, no WhatsApp number, and no associated mobile or web devices.

Example User Profile Retention Policy

The deletion job runs daily. For example, if you set a retention period of 31 days for Uncontactable Web Devices, the platform checks every day and removes any web devices that have been uncontactable for more than 31 days.

👍

If you leave a field empty, or clear a value that was previously set, cleanup for that profile type is disabled and no profiles of that type will be deleted.

Audit Log Retention

Audit Log Retention removes aged audit log records from your project, with a default retention period of 3 months. The section contains two fields, each specifying a retention period in months:

  • Profile Audit Logs: A log of changes made to user profiles which is recorded under User Profiles > Audit Log. The profile audit log is not enabled on all projects and this setting only applies if this feature is enabled for your project.
  • Campaign Audit Logs: A record of every change made to the campaign. For more information, see Campaign Audit Logs.

Example Audit Log Retention Policy

The deletion job runs monthly. For example, if you set a retention period of 3 months, logs created before the start of that 3-month window are deleted on the first of the following month.

👍

Leaving a field empty reverts cleanup to the default period of 3 months. To disable cleanup, enter 0.