TicketUserServices

<back to all web services

CampaignConversionPreviewRequest

The following routes are available for this service:
POST/CampaignConversions/Preview
import Foundation
import ServiceStack

public class CampaignConversionPreviewRequest : Codable
{
    public var people:[CampaignConversionPerson] = []
    public var windowHours:Int?
    public var targetEventId:Int?
    public var includeFood:Bool?

    required public init(){}
}

public class CampaignConversionPerson : Codable
{
    public var phone:String?
    public var email:String?
    public var recipientId:Int?
    public var channel:String?
    public var sentAt:Date?

    required public init(){}
}

public class CampaignConversionResult : Codable
{
    public var runId:String?
    public var peopleMeasured:Int?
    public var peopleConverted:Int?
    public var totalAmount:Double?
    public var bySurface:[CampaignConversionSurfaceCount] = []
    public var byChannel:[CampaignConversionSurfaceCount] = []
    public var headlineConversions:Int?
    public var headlineAmount:Double?
    public var medianHoursToConvert:Int?
    public var notes:[String] = []
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class CampaignConversionSurfaceCount : Codable
{
    public var key:String?
    public var people:Int?
    public var count:Int?
    public var amount:Double?

    required public init(){}
}


Swift CampaignConversionPreviewRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"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: text/csv
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"}