POST api/Cache/Visit

Registers a page visit or adds visitor profile data to the realtime cache

Request Information

URI Parameters

None.

Body Parameters

Visitor details

VisitorPageRegistration
NameDescriptionTypeAdditional information
IsNewVisitor

Indicates if this is a new visitor

boolean

None.

VisitorID

Visitor ID (For known visitors)

string

None.

DeviceID

If not supplied, the visitor ID is used

string

None.

PagePublishedID

For RPI landing pages, the page published ID

integer

None.

VisitorAttributes

Visitor attributes

Collection of VisitorAttribute

None.

PageReferrer

The referrer to this page

string

None.

ClientID

The RPI client ID (guid) available from the Pulse.rpi_Clients

string

None.

Geolocation

Geolocation coordinates

GeolocationCoords

None.

InteractionTracking

Outbound interaction tracking details

OutboundOfferTrackingDetails

None.

Request Formats

application/json, text/json

Sample:
{
  "IsNewVisitor": true,
  "VisitorID": "sample string 2",
  "DeviceID": "sample string 3",
  "PagePublishedID": 1,
  "VisitorAttributes": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "PageReferrer": "sample string 4",
  "ClientID": "sample string 5",
  "Geolocation": {
    "Longitude": "sample string 1",
    "Latitude": "sample string 2"
  },
  "InteractionTracking": {
    "ChannelExecutionID": 1,
    "RPContactID": 1,
    "MessageListID": 1,
    "MessageID": 1
  }
}

application/xml, text/xml

Sample:
<VisitorPageRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RedPoint.InteractionRealtime.Models">
  <ClientID>sample string 5</ClientID>
  <DeviceID>sample string 3</DeviceID>
  <Geolocation>
    <Latitude>sample string 2</Latitude>
    <Longitude>sample string 1</Longitude>
  </Geolocation>
  <InteractionTracking>
    <ChannelExecutionID>1</ChannelExecutionID>
    <MessageID>1</MessageID>
    <MessageListID>1</MessageListID>
    <RPContactID>1</RPContactID>
  </InteractionTracking>
  <IsNewVisitor>true</IsNewVisitor>
  <PagePublishedID>1</PagePublishedID>
  <PageReferrer>sample string 4</PageReferrer>
  <VisitorAttributes>
    <VisitorAttribute>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </VisitorAttribute>
    <VisitorAttribute>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </VisitorAttribute>
  </VisitorAttributes>
  <VisitorID>sample string 2</VisitorID>
</VisitorPageRegistration>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/plain

Sample:

Sample not available.

Response Information

Resource Description

Visitor
NameDescriptionTypeAdditional information
VisitorID

string

None.

DeviceID

string

None.

Response Formats

application/json, text/json

Sample:
{
  "VisitorID": "sample string 1",
  "DeviceID": "sample string 2"
}

application/xml, text/xml

Sample:
<Visitor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RedPoint.InteractionRealtime.Models">
  <DeviceID>sample string 2</DeviceID>
  <VisitorID>sample string 1</VisitorID>
</Visitor>