ChangeHistoryService Types

ChangeHistoryService WSDL


This service is stateless.

Examples +

  • enqueue report
  • get progress
  • download
.

    downloadChangeHistoryReporttop

    Deprecated 2026-08-17

    This method will be removed in upcoming releases.

    Superseded by enqueueChangeHistoryReport, getChangeHistoryReportGenerationProgress

    Description

    And downloadChangeHistoryReportFile (AB-3446). This method generates the report in the web
    server process, which aborts on reports with many changes.

    ChangeHistoryFile downloadChangeHistoryReport(int $campaign_id)

    Parameters

    int $campaign_id

    Return Values

    ChangeHistoryFile

    downloadChangeHistoryReportFiletop

    Description



    ChangeHistoryFile downloadChangeHistoryReportFile(int $job_id)

    Parameters

    int $job_id

    Return Values

    ChangeHistoryFile

    enqueueChangeHistoryReporttop

    Description



    int enqueueChangeHistoryReport(int $campaign_id)

    Parameters

    int $campaign_id

    Return Values

    int The id of the report job

    getChangeHistoryReportGenerationProgresstop

    Description



    ChangeHistoryReportProgress getChangeHistoryReportGenerationProgress(int $job_id)

    Parameters

    int $job_id

    Return Values

    ChangeHistoryReportProgress

    logintop

    Description

    Initializes a new session with given information

    boolean login(string $user, string $pass, int $network)

    Parameters

    string $user Username
    string $pass Password
    int $network $network Network ID

    Return Values

    boolean true on success, false on fail

    logouttop

    Description

    Destroys the active session, logging out the user.

    boolean logout()

    Return Values

    boolean true on success, false on fail

    ChangeHistoryFiletop

    Definition

    object ChangeHistoryFile {
    - string $base64FileContent

    required

    - string $fileName

    required

    }

    ChangeHistoryReportProgresstop

    Definition

    object ChangeHistoryReportProgress {
    - string $status

    required

    - int $percentage

    required

    }

    Console