Purge API Parameters

All parameters are optional.

Parameter

Description

Notes

dataStoreEmergencyPurgeDiskUsage

The percent of disk usage that acts as a purge threshold. When this threshold is reached a purge starts. Social contacts older than dataStorePurgeAge are removed first. If disk usage is still above the threshold for emergency purging, then the purge continues removing social contacts (one day at a time) until the disk usage is below the threshold for emergency purge.

Valid values are 40–90.

dataStorePurgeAge

The age of the social contacts that will be purged.

Must be a whole number between 1–550 (no decimal).

reportingPurgeAge

The time, in 24 hour format (HH:mm), when the purge is to start.

Valid values are 00:00 to 23:59.

reportingPurgeTime

The ages of reporting records that will be purged.

Valid values are 1 to 550.