<back to all web services

TouchpointRequestDto

The following routes are available for this service:
GET/RestApi/sitefinity/data-intelligence/touchpoint

export class TouchpointRequestDto
{
    public Filter: string;

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

export enum MatchingOperator
{
    ExactMatch = 'ExactMatch',
    Contains = 'Contains',
    StartsWith = 'StartsWith',
    EndsWith = 'EndsWith',
    UrlStrippedMatch = 'UrlStrippedMatch',
}

export class ConditionPart
{
    public Id: number;
    public Predicate: string;
    public IsNegated: boolean;
    public PredicateOperator: MatchingOperator;
    public ObjectOperator: MatchingOperator;
    public Objects: string[];
    public ClientAttribute: string;
    public ContactPropertyId?: string;
    public ObjectMetadata: { [index: string]: string; };
    public UrlParameters: { [index: string]: string; };

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

export class ConditionExpression
{
    public Relation: string;
    public Parts: IList<ConditionPart>;

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

export enum CalculationState
{
    Inactive = 'Inactive',
    Initializing = 'Initializing',
    Active = 'Active',
    ToBeDeleted = 'ToBeDeleted',
    Error = 'Error',
    Pending = 'Pending',
    Expired = 'Expired',
}

export enum TouchpointType
{
    Touchpoint = 'Touchpoint',
    Discovered = 'Discovered',
    Personalization = 'Personalization',
    AbVariant = 'AbVariant',
    AbGoal = 'AbGoal',
    Content = 'Content',
}

export class Touchpoint
{
    public Id: number;
    public Name: string;
    public Definition: ConditionExpression;
    public State: CalculationState;
    public CreatedOn?: string;
    public CreatedByUserId: string;
    public ModifiedOn?: string;
    public ModifiedByUserId: string;
    public TotalHits?: number;
    public TotalMetaClientHits?: number;
    public AbsoluteHits?: number;
    public AttributionsCalculatedOn?: string;
    public StatisticsCalculatedOn?: string;
    public Errors: string;
    public TouchpointType: TouchpointType;

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

export class TouchpointsViewModel
{
    public Touchpoints: IList<Touchpoint>;

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

TypeScript TouchpointRequestDto 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.

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

{}