KB Newsman
Newsman Api Method: abtest.getTestProps
Prototype: abtest.getTestProps(newsletter_id)
Description: Returns the current Newsletter AB Test properties
HTTP method: GET
Endpoint HTTP: /abtest.getTestProps.json
Endpoint XML-RPC: abtest.getTestProps
Return type: struct|arrayReturn info: Returns the hash array with the test properties. Returned keys are: test_duration, winner_method, test_group_size
Request parameters GET
| Variable | Type | Description |
|---|---|---|
| newsletter_id | string|int | The ID of the list for which to get the ips |
Response parameters
| Parameter | Description |
|---|---|
| test_duration | The time to wait before deciding the test winner |
| winner_method | The method by which the test winner is decided |
| test_group_size | The percent of the list on which to send the test |
Output example
{ "test_duration": "35", "winner_method": "manual", "test_group_size": "20" }
Response Errors
| Code | Message | Description |
|---|---|---|
| 407 | Missing required param newsletter_id | newsletter_id param is required |
| 131 | No such newsletter with ID: %s. | Newsletter not found |
Error examples
{ "err": true, "message": "Missing required param newsletter_id", "code": 407 }
{ "err": true, "message": "No such newsletter with ID: 239488.", "code": 131 }