XML reporting

If you request an XML-format report, it is stored in your SFTP accessible space for easy retrieval. The report has the following structure:

    <report>
        <process start="" finish="" />
        <recipients lastupdate="" start="" finish=""></recipients>
        <delivery>
            <content time=""></content>
            <id>
                <normal time=""></normal>
                <test time=""></test>
            </id>
            <qualifier>
                <id>
                <normal time=""></normal>
                <test time=""></test>
                </id>
            </qualifier>
        </delivery>
        <error time="">
        </error>
    </report>

The XML tags represent the following:

  • <process>

    • The duration of the process, stored in the start and finish attributes

    The report file is written at the start of the process and updated following each step. The initial version only includes empty values. Subsequent versions have more information. Only the final report includes the finish time.

    Note:

    The file will not be updated correctly if it is locked for reading while the process is still running.

  • <recipients>

    • Stores the number of recipients uploaded

    The lastupdate attribute stores the time when the last recipient chunk is uploaded. When there is a substantial number of recipients, the upload is split in several segments and lastupdate is updated in a rewritten report file, while the process is running. The duration of the recipient upload process is stored in the start and finish attributes. The finish attribute is set when all subscribers have been uploaded.

  • <delivery>

    • Detailed information about normal and test deliveries

      Populated in a rewritten report file, as soon as the deliveries have been created.

  • <content>

    • The content of the message, together with the timestamp

      The content is empty if the body is not also available in plain text.

  • delivery/id/<normal>

    The normal delivery identifier, together with the timestamp.

  • delivery/id/<test>

    The test delivery identifier, together with the timestamp.

  • qualifier/id/<normal>

    The normal filter identifier, together with the timestamp.

  • qualifier/id/<test>

    The test filter identifier, together with the timestamp.

  • <error>

    Identifies what happened, if an error occurs, together with the timestamp of the error.

See Example of an XML report for more details.

Next page:

Using XMLDelivery


Also see: