Get a List of Transactions

This request will return a subset of all your transactions. You can include the page, count, order, direction, and filter variables to affect the list you receive.


The Method

API Method
RESTGEThttp://[Your URL]/api/2.0/trans_mails/
XML-RPCCalltransactional._mails.ListTransactionalMails
Your URL is the address of your Everlytic install.

Your method must be structured as follows:

ListTransactionalMails(int $page, int $count, string $order, string $direction, \struct | array $filters) : array

Parameters

You can use the following parameters to refine your list:

PropertyTypeDescription
$pageintegerThe page number of the list.
$countintegerThe number of results to return per page. This field has a max value of 100.
$orderstringThe name of the field to order the listing with.
$directionstringThe direction of the ordering: 'asc' or 'desc'.
$filters\structarrayThe fields to filter on.

Properties

PropertyTypeDescriptionExample
trans_group_idintegerList transactions belonging to a specific group ID.$options['trans_group_id'] = 1
trans_group_namestringList transactions belonging to a specific group name.$options['trans_group_name'] = 'Group name'
send_email_fromstringList transactions sent from a specific address.$options['send_email_from'] = 'from@example.com'
send_email_tostringList transactions sent to a specific address.$options['send_email_to'] = 'to@example.com'
custom_headersstringList transactions sent using a specific custom header.$options['custom_headers']['header_name'] = 'header_value'
send_statusstringList transaction containing a specific status. Valid statuses include:

  • sent

  • failed

  • bounced

  • suppressed

$options['send_status'] = 'sent'
send_datestringList transactions sent between/on a specified date.$options['send_date'] = '1234567890' OR $options['send_date'] = '1234567890,1234568806'
opensstringList transactions that contain more than a specific number of opens.$options['opens'] = 1, This will list all transactions that have 1 or more opens
link_clicksstringList transactions that contain more than a specific number of link clicks.$options['link_clicks'] = 1, This will list all transactions that have 1 or more link clicks

Responses

TypeDescription
arrayAn array of transactions.
Translate »