TicketUserServices

CampaignConversionPreviewRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignConversionSurfaceCount:
    key: Optional[str] = None
    people: Optional[int] = None
    count: Optional[int] = None
    amount: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignConversionResult:
    run_id: Optional[str] = None
    people_measured: Optional[int] = None
    people_converted: Optional[int] = None
    total_amount: Optional[Decimal] = None
    by_surface: Optional[List[CampaignConversionSurfaceCount]] = None
    by_channel: Optional[List[CampaignConversionSurfaceCount]] = None
    headline_conversions: Optional[int] = None
    headline_amount: Optional[Decimal] = None
    median_hours_to_convert: Optional[int] = None
    notes: Optional[List[str]] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignConversionPerson:
    phone: Optional[str] = None
    email: Optional[str] = None
    recipient_id: Optional[int] = None
    channel: Optional[str] = None
    sent_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignConversionPreviewRequest:
    people: Optional[List[CampaignConversionPerson]] = None
    window_hours: Optional[int] = None
    target_event_id: Optional[int] = None
    include_food: Optional[bool] = None

Python CampaignConversionPreviewRequest DTOs

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
}