POST api/Events

Registers a realtime event

Request Information

URI Parameters

None.

Body Parameters

Event details

RealtimeEvent
NameDescriptionTypeAdditional information
VisitorID

Visitor ID (For known visitors)

string

None.

DeviceID

Device ID

string

None.

EventName

Event name

string

None.

EventDetail

Additional event parameter e.g. URL for link clicks

string

None.

MetricValue

Metric value

string

None.

ClientID

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

string

None.

ChannelExecutionID

RPI channel execution ID if event is related to a specific RPI interaction channel instance

integer

None.

RPContactID

RPI RPContentID if event is related to a specific RPI interaction outbound channel instance

integer

None.

PagePublishedID

For RPI landing pages, the page published ID

integer

None.

ContentID

Content ID, if event applies to specific content

string

None.

GoalDetails

For goal events

GoalEvent

None.

PageReferral

For page visit events

string

None.

Request Formats

application/json, text/json

Sample:
{
  "VisitorID": "sample string 1",
  "DeviceID": "sample string 2",
  "EventName": "sample string 3",
  "EventDetail": "sample string 4",
  "MetricValue": "sample string 5",
  "ClientID": "sample string 6",
  "ChannelExecutionID": 1,
  "RPContactID": 1,
  "PagePublishedID": 1,
  "ContentID": "sample string 7",
  "GoalDetails": {
    "GoalName": "sample string 1",
    "GoalContentID": "sample string 2"
  },
  "PageReferral": "sample string 8"
}

application/xml, text/xml

Sample:
<RealtimeEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RedPoint.InteractionRealtime.Models">
  <ChannelExecutionID>1</ChannelExecutionID>
  <ClientID>sample string 6</ClientID>
  <ContentID>sample string 7</ContentID>
  <DeviceID>sample string 2</DeviceID>
  <EventDetail>sample string 4</EventDetail>
  <EventName>sample string 3</EventName>
  <GoalDetails>
    <GoalContentID>sample string 2</GoalContentID>
    <GoalName>sample string 1</GoalName>
  </GoalDetails>
  <MetricValue>sample string 5</MetricValue>
  <PagePublishedID>1</PagePublishedID>
  <PageReferral>sample string 8</PageReferral>
  <RPContactID>1</RPContactID>
  <VisitorID>sample string 1</VisitorID>
</RealtimeEvent>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/plain

Sample:

Sample not available.

Response Information

Resource Description

None.