NewsMAN API: transactional.accountHistory

Sections

Newsman – Knowledge Base

HomeAPITransactionaltransactional.accountHistory

Newsman Api Method: transactional.accountHistory

Prototype: transactional.accountHistory(list_id, date, action_type, count, before_timestamp, tag, account_id)

Description: Returns an array of actions, sorted in descending order, for a SMTP account

HTTP method: GET

Endpoint HTTP: /transactional.accountHistory.json

Endpoint XML-RPC: transactional.accountHistory

Return type: array

Return info: Array containing actions, sorted in descending order, for a SMTP account

Request parameters GET

Variable	Type	Description
list_id	int\|string	The ID of the list from which to identify the SMTP account
date	string	If date is present it must be in format YYYY-mm-dd in your local timezone and it limits the results to that specific day (eg: usefull when listing by days). If not present “before_timestamp” is used only. (optional)
action_type	string	Filter results to a specific action type. Can be send, view, click, unsub, bounce, spam, reject (optional)
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)
tag	string\|int	Limit the search for this tag only (optional)
account_id	string\|boolean	The id of a specific SMTP ACCOUNT from which to fetch the history (optional).

Response parameters

Parameter	Description
array	array containing actions, sorted in descending order, for a SMTP account

Output example

[
    {
        "action": "send",
        "timestamp": 1731687291,
        "data": {
            "meta": {
                "subject": "test subject"
            },
            "send_id": "the_send_id",
            "email": "john1@example.com"
        }
    },
    {
        "action": "send",
        "timestamp": 1731687240,
        "data": {
            "meta": {
                "subject": "test subject"
            },
            "send_id": "the_send_id_2",
            "email": "john2@example.com"
        }
    },
    {
        "action": "send",
        "timestamp": 1731682493,
        "data": {
            "meta": {
                "subject": "test subject"
            },
            "send_id": "the_send_id_3",
            "email": "john3@example.com"
        }
    }
]

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
17015	The account history could not be fetched: [error_reason]	The 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 account history could not be fetched: [error_reason]",
    "code": 17016
}