Please note that this API functionality has been deprecated in favour of our new Webhook API. Visit our Transactional API Migration page to learn more.
Overview
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 |
|---|---|---|
| REST | GET | https://[Your URL]/api/2.0/trans_mails/ |
| XML-RPC | Call | transactional._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:
| Property | Type | Description |
|---|---|---|
| $page | integer | The page number of the list. |
| $count | integer | The number of results to return per page. This field has a max value of 100. |
| $order | string | The name of the field to order the listing with. |
| $direction | string | The direction of the ordering: ‘asc’ or ‘desc’. |
| $filters | structarray | The fields to filter on. |
Properties
| Property | Type | Description | Example |
|---|---|---|---|
| trans_group_id | integer | List transactions belonging to a specific group ID. | $options[‘trans_group_id’] = 1 |
| trans_group_name | string | List transactions belonging to a specific group name. | $options[‘trans_group_name’] = ‘Group name’ |
| send_email_from | string | List transactions sent from a specific address. | $options[‘send_email_from’] = ‘[email protected]’ |
| send_email_to | string | List transactions sent to a specific address. | $options[‘send_email_to’] = ‘[email protected]’ |
| custom_headers | string | List transactions sent using a specific custom header. | $options[‘custom_headers’][‘header_name’] = ‘header_value’ |
| send_status | string | List transaction containing a specific status. Valid statuses include:
| $options[‘send_status’] = ‘sent’ |
| send_date | string | List transactions sent between/on a specified date. | $options[‘send_date’] = ‘1234567890’ OR $options[‘send_date’] = ‘1234567890,1234568806’ |
| opens | string | List 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_clicks | string | List 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
| Type | Description |
|---|---|
| array | An array of transactions. |