KB Newsman
Newsman Api Method: subscriber.history
Prototype: subscriber.history(subscriber_id)
Description: Returns subscriber action history (last 100 actions) as struct (array with history entries)
HTTP method: GET
Endpoint HTTP: /subscriber.history.json
Endpoint XML-RPC: subscriber.history
Return type: structReturn info: The history list for this subscriber. Each history item is a struct made of:- action: bounce, click, view, subscribe, spam, send, unsubscribe
- date: action date
- meta: metadata regarding this action (ex: newsletter subject or id, link, etc.).
Request parameters GET
- action: bounce, click, view, subscribe, spam, send, unsubscribe
- date: action date
- meta: metadata regarding this action (ex: newsletter subject or id, link, etc.).
| Variable | Type | Description |
|---|---|---|
| subscriber_id | string|int | The ID of the subscriber for which to get the data |
Response parameters
| Parameter | Description |
|---|---|
| action | Can be one of: bounce, click, view, subscribe, spam, send, unsubscribe |
| date | action date |
| meta | metadata regarding this action (ex: newsletter subject or id, link, etc.) |
Request examples
Output example
[ { "action": "view", "date": "2018-03-15 19:13", "meta": { "newsletter_id": 155001, "subject": "Some subject here", "user_ip": "127.0.0.1", "send_ip": "127.0.0.1" } }, { "action": "send", "date": "2018-03-15 17:13", "meta": { "ip": "127.0.0.1", "newsletter_id": 155001, "subject": "Some subject here" } } ]
Response Errors
| Code | Message | Description |
|---|---|---|
| 407 | Missing required param subscriber_id | subscriber_id param is required |
| 101 | Not allowed for list_id = %s | Invalid access to subscriber list_id |
| 108 | List %s has been deleted | Subscriber ID belongs to a list which has been deleted |
| 129 | Not allowed for subscriber with ID: %s | Invalid access to subscriber id |
| 121 | Could not load subscriber | The subscriber was not found |
Error examples
{ "err": true, "message": "Missing required param subscriber_id", "code": 407 }
{ "err": true, "message": "Not allowed for subscriber with ID: 952933", "code": 129 }
{ "err": true, "message": "Could not load subscriber", "code": 121 }