REST Email Marketing API Documentation

MAILINGS — CHECKQUEUERESULTS

If the call to queue a mailing didn't give the results within the timeout, you can call this function to get the final results. Once you get results once they are not returned again. Only mailings that didn't return the results immediately after the queue will return results with this function.

HTTP VERB

Get

URL

/API/Rest/Mailings/CheckQueueResults

ARGUMENTS

mailingTitle

Required permission

QueueMailing

ERRORS

Empty results means there is nothing to report.
No Permission
Invalid mailing title
Too many API calls
Database error
Unknown error

RETURNS

A structure with fields for the different exclusions. The total recipients that were queued for the mailing is the totalRecords minus each of the exclusions.

{"totalHeldMembers":6261, "totalUnconfirmedMembers":3201, "totalUnsubscribedMembers":99, "totalRecencyMembers":0, "totalSuppressedMembers":0, "fccBans":0, "totalRecords":25510}

EXAMPLE

Get the details for one specific mailing.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Mailings/CheckQueueResults?accountName=acme&login=ApiUser&mailingTitle=Test1";

// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Get, url))
{
	request.Headers.Add("Password", "YOUR_PASSWORD");

	using (HttpResponseMessage response = await client.SendAsync(request))
	{
		response.EnsureSuccessStatusCode();
		Console.WriteLine(await response.Content.ReadAsStringAsync());
	}
}
			
# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'https://example.com/API/Rest/Mailings/CheckQueueResults?accountName=acme&login=ApiUser&mailingTitle=Test1'
response = RestClient.get(url, {:Password => "YOUR_PASSWORD"})
puts response						
						
import requests

url = "https://example.com/API/Rest/Mailings/CheckQueueResults?accountName=acme&login=ApiUser&mailingTitle=Test1"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

https://example.com/API/Rest/Mailings/CheckQueueResults?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&mailingTitle=Test1