REST Email Marketing API Documentation

DEMOGRAPHICS — RETRIEVE

Get data about all the demographics.

HTTP VERB

Get

URL

/API/Rest/Demographics

ARGUMENTS

(none)

Required permission

ViewDemographic

ERRORS

No Permission
Database error
Unknown error

RETURNS

A structure with the demographic fields:

[{"ColumnName":"Company","DataType":"String100","DisplayInSearchResults":false,"ExportWithReports":false},
{"ColumnName":"FirstName","DataType":"String100","DisplayInSearchResults":false,"ExportWithReports":true},
{"ColumnName":"id","DataType":"String25","DisplayInSearchResults":true,"ExportWithReports":true},
{"ColumnName":"Language","DataType":"String50","DisplayInSearchResults":false,"ExportWithReports":true},
{"ColumnName":"LastName","DataType":"String100","DisplayInSearchResults":false,"ExportWithReports":true},
{"ColumnName":"Mailing_Country","DataType":"String50","DisplayInSearchResults":false,"ExportWithReports":true},
{"ColumnName":"Salutation","DataType":"String50","DisplayInSearchResults":false,"ExportWithReports":false},
{"ColumnName":"Territory_Region","DataType":"String50","DisplayInSearchResults":false,"ExportWithReports":true},
{"ColumnName":"Title","DataType":"String100","DisplayInSearchResults":false,"ExportWithReports":false}]

EXAMPLE

Get data on the demographics.

using System;
using System.Net.Http;

string url = "https://example.com/API/Rest/Demographics?accountName=acme&login=ApiUser";

// 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/Demographics?accountName=acme&login=ApiUser'
response = RestClient.get(url, {:Password => "YOUR_PASSWORD"})
puts response
						
import requests

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

https://example.com/API/Rest/Demographics?accountName=acme&login=ApiUser&password=YOUR_PASSWORD