TicketUserServices

<back to all web services

CampaignConversionPreviewRequest

The following routes are available for this service:
POST/CampaignConversions/Preview
CampaignConversionPreviewRequest Parameters:
NameParameterData TypeRequiredDescription
PeoplebodyList<CampaignConversionPerson>No
WindowHoursbodyintNo
TargetEventIdbodyint?No
IncludeFoodbodyboolNo
CampaignConversionPerson Parameters:
NameParameterData TypeRequiredDescription
PhoneformstringNo
EmailformstringNo
RecipientIdformint?No
ChannelformstringNo
SentAtformDateTimeNo
CampaignConversionResult Parameters:
NameParameterData TypeRequiredDescription
RunIdformstringNo
PeopleMeasuredformintNo
PeopleConvertedformintNo
TotalAmountformdecimalNo
BySurfaceformList<CampaignConversionSurfaceCount>No
ByChannelformList<CampaignConversionSurfaceCount>No
HeadlineConversionsformintNo
HeadlineAmountformdecimalNo
MedianHoursToConvertformintNo
NotesformList<string>No
StatusCodeformintNo
MessageformstringNo
CampaignConversionSurfaceCount Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
PeopleformintNo
CountformintNo
AmountformdecimalNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /CampaignConversions/Preview HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	people: 
	[
		{
			phone: String,
			email: String,
			recipientId: 0,
			channel: String,
			sentAt: 0001-01-01
		}
	],
	windowHours: 0,
	targetEventId: 0,
	includeFood: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	runId: String,
	peopleMeasured: 0,
	peopleConverted: 0,
	totalAmount: 0,
	bySurface: 
	[
		{
			key: String,
			people: 0,
			count: 0,
			amount: 0
		}
	],
	byChannel: 
	[
		{
			key: String,
			people: 0,
			count: 0,
			amount: 0
		}
	],
	headlineConversions: 0,
	headlineAmount: 0,
	medianHoursToConvert: 0,
	notes: 
	[
		String
	],
	statusCode: 0,
	message: String
}