Returns status code

200

Request url

/splittests/Vxx?fields=name

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

{
    "splittestId": "vv1y",
    "href": "https://api.getresponse.com/v3/splittests/vv1y",
    "name": "A/B test",
    "status": "active",
    "winningCriteria": "open",
    "winningTargets": "16",
    "stage": "finished",
    "type": "subject",
    "samplingPercentage": "18",
    "samplingTime": "86400",
    "chooseWinning": "automatic",
    "winningScoreOpens": "0",
    "winningScoreClicks": "0",
    "winningScheduledOn": "2015-06-25T20:05:10+0000",
    "nextStepOn": null,
    "evaluationSkippedOn": null,
    "canceledOn": null,
    "createdOn": "2015-06-24T20:02:58+0000",
    "newsletters": [
        {
            "newsletterId": "B2fvv",
            "href": "https://api.getresponse.com/v3/newsletters/B2vvv",
            "name": "A/B newsletter 1",
            "subject": "hello [[name]]",
            "fromField": {
                "fromFieldId": "KM6X",
                "href": "https://api.getresponse.com/v3/from-fields/KM6X"
            },
            "status": "chosen",
            "samplingTargets": "1",
            "samplingDelivered": "1",
            "scoreOpens": "1",
            "scoreClicks": "0"
        },
        {
            "newsletterId": "B2fEb",
            "href": "https://api.getresponse.com/v3/newsletters/B4Eb",
            "name": "A/B newsletter 2",
            "subject": "Hi my friend",
            "fromField": {
                "fromFieldId": "KM6X",
                "href": "https://api.getresponse.com/v3/from-fields/K2X"
            },
            "status": "rejected",
            "samplingTargets": "1",
            "samplingDelivered": "1",
            "scoreOpens": "1",
            "scoreClicks": "0"
        }
    ],
    "sendSettings": {
        "timeTravel": "true",
        "selectedCampaigns": [
            "o5lx"
        ],
        "selectedSegments": [],
        "selectedSuppressions": [],
        "excludedCampaigns": [],
        "excludedSegments": []
    }
}

Returns status code

200

Request url

/splittests?query[name]=splittestName&fields=name,type&sort[createdOn]=desc&page=4&perPage=30

Request params

Field nameField typeField description
queryhashUsed to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic.
KeyPossible values if fixed
name*
createdOn[from]Y-m-d
createdOn[to]Y-m-d
typecontent, subject, day, hour, from_field
statusactive, inactive
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma
sorthashEnable sorting using specified field (set as a key) and order (set as a value). You can specify multiple fields to sort by.
KeyPossible values if fixed
nameasc,desc
createdOnasc,desc
campaignIdasc,desc
pageintegerSpecify which page of results return.
perPageintegerSpecify how many results per page should be returned
additionalFlagsstringAdditional flags parameter with value 'exactMatch' will search contacts with exact value of email and name provided in query string. Without that flag matching is done via standard 'like' comparison, what could be sometimes slow.

Example Response

[
    {
        "splittestId": "vv1y",
        "href": "https://api.getresponse.com/v3/splittests/vv1y",
        "name": "A/B test",
        "status": "active",
        "winningCriteria": "open",
        "winningTargets": "16",
        "stage": "finished",
        "type": "subject",
        "samplingPercentage": "18",
        "samplingTime": "86400",
        "chooseWinning": "automatic",
        "winningScoreOpens": "0",
        "winningScoreClicks": "0",
        "winningScheduledOn": "2015-06-25T20:05:10+0000",
        "nextStepOn": null,
        "evaluationSkippedOn": null,
        "canceledOn": null,
        "createdOn": "2015-06-24T20:02:58+0000",
        "newsletters": [
            {
                "newsletterId": "B2fvv",
                "href": "https://api.getresponse.com/v3/newsletters/B2vvv",
                "name": "A/B newsletter 1",
                "subject": "hello [[name]]",
                "fromField": {
                    "fromFieldId": "KM6X",
                    "href": "https://api.getresponse.com/v3/from-fields/KM6X"
                },
                "status": "chosen",
                "samplingTargets": "1",
                "samplingDelivered": "1",
                "scoreOpens": "1",
                "scoreClicks": "0"
            },
            {
                "newsletterId": "B2fEb",
                "href": "https://api.getresponse.com/v3/newsletters/B4Eb",
                "name": "A/B newsletter 2",
                "subject": "Hi my friend",
                "fromField": {
                    "fromFieldId": "KM6X",
                    "href": "https://api.getresponse.com/v3/from-fields/K2X"
                },
                "status": "rejected",
                "samplingTargets": "1",
                "samplingDelivered": "1",
                "scoreOpens": "1",
                "scoreClicks": "0"
            }
        ],
        "sendSettings": {
            "timeTravel": "true",
            "selectedCampaigns": [
                "o5lx"
            ],
            "selectedSegments": [],
            "selectedSuppressions": [],
            "excludedCampaigns": [],
            "excludedSegments": []
        }
    }
]