Get information about the sending status of all recipients of a test mailing
1 min
GET
https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/test/{testMailingId}
Path Parameters
- clientIdinteger<int64>requiredDescriptionFormatint64
- testMailingIdinteger<int32>requiredDescriptionFormatint32
- mailingIdinteger<int64>requiredDescriptionFormatint64
- campaignIdinteger<int64>requiredDescriptionFormatint64
Header Parameters
- acceptstringDescriptionDefaultapplication/jsonAllowedapplication/jsonapplication/vnd.optivo.broadmail.v1+json
Responses
200
- TestMailingReport
- recipientStatusmap<string, string>Description
- mailingIdinteger<int64>DescriptionFormatint64
- reportDatestring<date-time>DescriptionFormatdate-time
- mediaTypestringDescription
- statusstring<invalid | activationRequired | activated | canceled | paused | running | finished>DescriptionAllowedinvalidactivationRequiredactivatedcanceledpausedrunningfinished
- startedstring<date-time>DescriptionFormatdate-time
- finishedstring<date-time>DescriptionFormatdate-time
curl
curl --request GET \
--url https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/test/{testMailingId} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/test/{testMailingId}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/test/{testMailingId}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/test/{testMailingId}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// The report was retrieved successfully.
{
"recipientStatus": "",
"mailingId": "",
"reportDate": "",
"mediaType": "",
"status": "",
"started": "",
"finished": ""
}