REST Email Marketing API Documentation

DOCUMENTS — COMPLAINTS

List the email addresses that have complained to their ISP about your mail.

HTTP VERB

Get

URL

/API/Rest/Documents/Complaints

ARGUMENTS

(Optional) documentName
(Optiona) startTime
(Optional) endTime

Required permission

StandardReports

ERRORS

No Permission
Invalid document name
Database error
Unknown error

RETURNS

A list of email addresses, in the format for large data sets.

{"downloadGuid":"9f3566f3-683c-4fda-861a-0a4a1e7c59b3","totalRows":3,"userData":[["joe@comcast.net"],["sam@yahoo.com"],["abe@COMCAST.NET"]]}

EXAMPLE

Retrieve the complaints registered between two dates.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Documents/Complaints?accountName=acme&login=ApiUser&startTime=1/1/2018&endTime=6/1/2018";

// 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/Documents/Complaints?accountName=acme&login=ApiUser&startTime=1/1/2018&endTime=6/1/2018'
response = RestClient.get(url, {:Password => "YOUR_PASSWORD"})
puts response

import requests

url = "https://example.com/API/Rest/Documents/Complaints?accountName=acme&login=ApiUser&startTime=1/1/2018&endTime=6/1/2018"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print(resp.text)

https://example.com/API/Rest/Documents/Complaints?accountName=acme&login=ApiUser&password=YOUR_PASSWORD&startTime=1/1/2018&endTime=6/1/2018