NewsMAN API: transactional.emailHistory

Sections

Newsman – Knowledge Base

HomeAPITransactionaltransactional.emailHistory

Newsman Api Method: transactional.emailHistory

Prototype: transactional.emailHistory(list_id, email, count, before_timestamp, account_id)

Description: Returns an array of actions, sorted in descending order, for an email address

HTTP method: GET

Endpoint HTTP: /transactional.emailHistory.json

Endpoint XML-RPC: transactional.emailHistory

Return type: array

Return info: Array containing actions, sorted in descending order, for an email address

Request parameters GET

Variable	Type	Description
list_id	int\|string	The ID of the list from which to identify the SMTP account
email	string	The email for which to fetch the history
count	string\|int	Limit the number of results (must be between 50 and 10000 inclusive), default: 50
before_timestamp	string\|int	Timestamp (seconds since epoch) used to navigate between the results. If not present current time is used. (optional)
account_id	string\|boolean	The id of a specific SMTP ACCOUNT from which to fetch the email history (optional).

Response parameters

Parameter	Description
array	array containing actions, sorted in descending order, for an email address

Output example

[
    {
        "action": "send",
        "timestamp": 1731687291,
        "data": {
            "meta": {
                "subject": "test subject"
            },
            "send_id": "the_send_id"
        }
    },
    {
        "action": "send",
        "timestamp": 1731687240,
        "data": {
            "meta": {
                "subject": "test subject"
            },
            "send_id": "the_send_id"
        }
    },
    {
        "action": "view",
        "timestamp": 1731686344,
        "data": {
            "meta": {
                "ip": "the_ip",
                "subject": "test subject",
                "useragent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:115.0) Gecko\/20100101 Thunderbird\/115.16.2"
            },
            "send_id": "the_send_id"
        }
    },
    {
        "action": "view",
        "timestamp": 1731683897,
        "data": {
            "meta": {
                "ip": "the_ip",
                "subject": "test subject",
                "useragent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:115.0) Gecko\/20100101 Thunderbird\/115.16.2"
            },
            "send_id": "the_send_id"
        }
    },
    {
        "action": "view",
        "timestamp": 1731683890,
        "data": {
            "meta": {
                "ip": "the_ip",
                "subject": "test subject",
                "useragent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:115.0) Gecko\/20100101 Thunderbird\/115.16.2"
            },
            "send_id": "the_send_id"
        }
    },
    {
        "action": "view",
        "timestamp": 1731683244,
        "data": {
            "meta": {
                "ip": "the_ip",
                "subject": "test subject",
                "useragent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:115.0) Gecko\/20100101 Thunderbird\/115.16.2"
            },
            "send_id": "the_send_id"
        }
    },
    {
        "action": "view",
        "timestamp": 1731683051,
        "data": {
            "meta": {
                "ip": "the_ip",
                "subject": "test subject",
                "useragent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:115.0) Gecko\/20100101 Thunderbird\/115.16.2"
            },
            "send_id": "the_send_id"
        }
    },
    {
        "action": "view",
        "timestamp": 1731683049,
        "data": {
            "meta": {
                "ip": "the_ip",
                "subject": "test subject",
                "useragent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:115.0) Gecko\/20100101 Thunderbird\/115.16.2"
            },
            "send_id": "the_send_id"
        }
    },
    {
        "action": "send",
        "timestamp": 1731682493,
        "data": {
            "meta": {
                "subject": "test subject"
            },
            "send_id": "the_send_id"
        }
    },
    {
        "action": "reject",
        "timestamp": 1731681998,
        "data": {
            "meta": {
                "reason": "notallowed_from_domain example2.com",
                "subject": "test subject"
            }
        }
    },
    {
        "action": "reject",
        "timestamp": 1731681691,
        "data": {
            "meta": {
                "reason": "notallowed_from_domain example3.com",
                "subject": "test subject"
            }
        }
    }
]

Response Errors

Code	Message	Description
407	Missing required param list_id	list_id param is required
101	Not allowed for list_id = %s	Invalid access to list_id
17003	Could not find the SMTP account	Transactional account not found
17004	The SMTP account is inactive	The transactional account is inactive
17017	The email history could not be fetched: [error_reason]	The email history could not be fetched

Error examples

{
    "err": true,
    "message": "Missing required param list_id",
    "code": 407
}

{
    "err": true,
    "message": "Could not find the SMTP account",
    "code": 17003
}

{
    "err": true,
    "message": "The SMTP account is inactive",
    "code": 17004
}

{
    "err": true,
    "message": "The email history could not be fetched: [error_reason]",
    "code": 17017
}