TicketUserServices

<back to all web services

CampaignConversionPreviewRequest

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

export class CampaignConversionSurfaceCount
{
    public key?: string;
    public people?: number;
    public count?: number;
    public amount?: number;

    public constructor(init?: Partial<CampaignConversionSurfaceCount>) { (Object as any).assign(this, init); }
}

export class CampaignConversionResult
{
    public runId?: string;
    public peopleMeasured?: number;
    public peopleConverted?: number;
    public totalAmount?: number;
    public bySurface?: CampaignConversionSurfaceCount[];
    public byChannel?: CampaignConversionSurfaceCount[];
    public headlineConversions?: number;
    public headlineAmount?: number;
    public medianHoursToConvert?: number;
    public notes?: string[];
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<CampaignConversionResult>) { (Object as any).assign(this, init); }
}

export class CampaignConversionPerson
{
    public phone?: string;
    public email?: string;
    public recipientId?: number;
    public channel?: string;
    public sentAt?: string;

    public constructor(init?: Partial<CampaignConversionPerson>) { (Object as any).assign(this, init); }
}

export class CampaignConversionPreviewRequest
{
    public people?: CampaignConversionPerson[];
    public windowHours?: number;
    public targetEventId?: number;
    public includeFood?: boolean;

    public constructor(init?: Partial<CampaignConversionPreviewRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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"}