KB Newsman
Newsman Api Method: abtest.getVariant
Prototype: abtest.getVariant(newsletter_id, variant_id)
Description: Returns specific variant of this test
HTTP method: GET
Endpoint HTTP: /abtest.getVariant.json
Endpoint XML-RPC: abtest.getVariant
Return type: struct|arrayReturn info: Hash array with: html, text, props (used when creating this variant)
Request parameters GET
| Variable | Type | Description |
|---|---|---|
| newsletter_id | string|int | The parent newsletter_id |
| variant_id | string|int | The variant id |
Response parameters
| Parameter | Description |
|---|---|
| html | The html content of the variant |
| text | The text content of the variant |
| props | The props of the variant (eg: subject) |
Output example
{ "html": "<html><body>test<\/body><\/html>", "text": null, "props": { "subject": "My test subject" } }
Response Errors
| Code | Message | Description |
|---|---|---|
| 407 | Missing required param newsletter_id | newsletter_id param is required |
| 407 | Missing required param variant_id | variant_id param is required |
| 131 | No such newsletter with ID: %s. | Newsletter not found |
| 503 | No variant with id %s found for newsletter %s. | Variant not found for newsletter |
Error examples
{ "err": true, "message": "Missing required param newsletter_id", "code": 407 }
{ "err": true, "message": "No such newsletter with ID: 239488.", "code": 131 }
{ "err": true, "message": "No variant with id 9345 found for newsletter 1936.", "code": 503 }