This function returns progress information for a cPanel account backup.

Note: When the PkgAcct::Create hook is installed, that hook anchors the run's start and finish, and the function reports complete only after it confirms the published archive in the home directory, along with the archive's exact final size. A run that never publishes an archive is therefore never reported as complete. Without the hook, the function falls back to the on-disk marker file. When no run is active, the state return value is none and the other return values are 0 or null. When the function cannot determine the account's disk usage, the estimatedTotalBytes and estimatedPercent return values are 0 even while a run is active.

{
  "apiversion": 3,
  "func": "progress",
  "module": "BackupInfo",
  "result": {
    "data": {
      "currentBytes": 104857600,
      "elapsedSeconds": 42,
      "estimatedPercent": 33.3,
      "estimatedTotalBytes": 314572800,
      "finishedAtEpoch": 1750640400,
      "startedAtEpoch": 1750636800,
      "state": "inprogress",
      "stateSource": "hook"
    },
    "status": 1
  }
}