<back to all web services

TouchpointRequestDto

The following routes are available for this service:
GET/RestApi/sitefinity/data-intelligence/touchpoint
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 TouchpointRequestDto:
    filter: Optional[str] = None


class MatchingOperator(str, Enum):
    EXACT_MATCH = 'ExactMatch'
    CONTAINS = 'Contains'
    STARTS_WITH = 'StartsWith'
    ENDS_WITH = 'EndsWith'
    URL_STRIPPED_MATCH = 'UrlStrippedMatch'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConditionPart:
    id: int = 0
    predicate: Optional[str] = None
    is_negated: bool = False
    predicate_operator: Optional[MatchingOperator] = None
    object_operator: Optional[MatchingOperator] = None
    objects: Optional[List[str]] = None
    client_attribute: Optional[str] = None
    contact_property_id: Optional[str] = None
    object_metadata: Optional[Dict[str, str]] = None
    url_parameters: Optional[Dict[str, str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConditionExpression:
    relation: Optional[str] = None
    parts: Optional[IList[ConditionPart]] = None


class CalculationState(str, Enum):
    INACTIVE = 'Inactive'
    INITIALIZING = 'Initializing'
    ACTIVE = 'Active'
    TO_BE_DELETED = 'ToBeDeleted'
    ERROR = 'Error'
    PENDING = 'Pending'
    EXPIRED = 'Expired'


class TouchpointType(str, Enum):
    TOUCHPOINT = 'Touchpoint'
    DISCOVERED = 'Discovered'
    PERSONALIZATION = 'Personalization'
    AB_VARIANT = 'AbVariant'
    AB_GOAL = 'AbGoal'
    CONTENT = 'Content'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Touchpoint:
    id: int = 0
    name: Optional[str] = None
    definition: Optional[ConditionExpression] = None
    state: Optional[CalculationState] = None
    created_on: Optional[datetime.datetime] = None
    created_by_user_id: Optional[str] = None
    modified_on: Optional[datetime.datetime] = None
    modified_by_user_id: Optional[str] = None
    total_hits: Optional[int] = None
    total_meta_client_hits: Optional[int] = None
    absolute_hits: Optional[int] = None
    attributions_calculated_on: Optional[datetime.datetime] = None
    statistics_calculated_on: Optional[datetime.datetime] = None
    errors: Optional[str] = None
    touchpoint_type: Optional[TouchpointType] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TouchpointsViewModel:
    touchpoints: Optional[IList[Touchpoint]] = None

Python TouchpointRequestDto DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /RestApi/sitefinity/data-intelligence/touchpoint HTTP/1.1 
Host: www.asg.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}