TicketUserServices

<back to all web services

CampaignConversionRunRequest

The following routes are available for this service:
POST/CampaignConversions/Run
CampaignConversionRunRequest Parameters:
NameParameterData TypeRequiredDescription
CampaignIdbodyintNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /CampaignConversions/Run HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"campaignId":0,"people":[{"phone":"String","email":"String","recipientId":0,"channel":"String","sentAt":"0001-01-01T00:00:00.0000000"}],"windowHours":0,"targetEventId":0,"includeFood":false}
HTTP/1.1 200 OK
Content-Type: application/json
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"}