Skip to content

Latest commit

 

History

History
63 lines (48 loc) · 1.78 KB

rest-get-logfiles-xml.md

File metadata and controls

63 lines (48 loc) · 1.78 KB
Raw

REST API: GET XML logfiles

Warning: You are viewing the documentation for the old REST API. We recommend using version 2 of the REST API.

Copernica keeps logfiles which you can request with the API. This method can be used to download a logfile as XML using its filename. If you don't know the filename please see "More information" for instructions. To execute the method you can send an HTTP GET request to the following URL:

https://api.copernica.com/v1/logfiles/$filename/xml?access_token=xxxx

where $filename is the name of the file you want to request.

Returned value

An XML representation of the requested log file. An example is shown below.

<records>
    <record>
        <id>XXXXXXXXXX1</id>
        <time>2016-11-04 11:01:00</time>
        <mailingid>12345</mailingid>
        <profileid>1111111</profileid>
        <subprofileid>2</subprofileid>
        <databaseid>133</databaseid>
        <collectionid>0</collectionid>
        <senderdomain>copernica.com</senderdomain>
        <templateid>1234</templateid>
        <tags></tags>
        <email>employee1234@copernica.com</email>
    </record>
    <record>
        ...
    </record>
    ...
</records>

PHP Example

The following PHP script demonstrates how to use the API method.

// dependencies
require_once('copernica_rest_api.php');
   
// change this into your access token
$api = new CopernicaRestApi("your-access-token");

// do the call, and print result
print_r($api->get("logfiles/cdm-attempts.2016-11-04.log/xml"));

The example above requires the CopernicaRestApi class.

More information