TicketUserServices

<back to all web services

CampaignConversionGetRequest

The following routes are available for this service:
GET/CampaignConversions/{CampaignId}
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 CampaignConversionGetRequest:
    campaign_id: Optional[int] = None
    run_id: Optional[str] = None

Python CampaignConversionGetRequest DTOs

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

HTTP + XML

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

GET /CampaignConversions/{CampaignId} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignConversionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <ByChannel>
    <CampaignConversionSurfaceCount>
      <Amount>0</Amount>
      <Count>0</Count>
      <Key>String</Key>
      <People>0</People>
    </CampaignConversionSurfaceCount>
  </ByChannel>
  <BySurface>
    <CampaignConversionSurfaceCount>
      <Amount>0</Amount>
      <Count>0</Count>
      <Key>String</Key>
      <People>0</People>
    </CampaignConversionSurfaceCount>
  </BySurface>
  <HeadlineAmount>0</HeadlineAmount>
  <HeadlineConversions>0</HeadlineConversions>
  <MedianHoursToConvert>0</MedianHoursToConvert>
  <Message>String</Message>
  <Notes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Notes>
  <PeopleConverted>0</PeopleConverted>
  <PeopleMeasured>0</PeopleMeasured>
  <RunId>String</RunId>
  <StatusCode>0</StatusCode>
  <TotalAmount>0</TotalAmount>
</CampaignConversionResult>