TicketUserServices

<back to all web services

OutboundCampaignConversionsRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/Outbound/Campaigns/{CampaignId}/Conversions
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 OutboundCampaignConversionsResult:
    campaign_id: Optional[int] = None
    sent_people: Optional[int] = None
    sent_converted: Optional[int] = None
    sent_rate: Optional[Decimal] = None
    holdout_people: Optional[int] = None
    holdout_converted: Optional[int] = None
    holdout_rate: Optional[Decimal] = None
    lift_points: Optional[Decimal] = None
    note: Optional[str] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutboundCampaignConversionsRequest:
    campaign_id: Optional[int] = None
    window_hours: Optional[int] = None

Python OutboundCampaignConversionsRequest 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 /Outbound/Campaigns/{CampaignId}/Conversions HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	campaignId: 0,
	windowHours: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	campaignId: 0,
	sentPeople: 0,
	sentConverted: 0,
	sentRate: 0,
	holdoutPeople: 0,
	holdoutConverted: 0,
	holdoutRate: 0,
	liftPoints: 0,
	note: String,
	statusCode: 0,
	message: String
}