POST v/1/Rest/CEContext/{client_domain}/WebPage/Visitor

Get information about the current user visiting your application.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
client_domain

string

None.

Body Parameters

None.

Response Information

Resource Description

information on the visitor.

GetPageVisitorProfileResponse
NameDescriptionTypeAdditional information
Contact

ContactRecord

None.

Successful

boolean

None.

Error

PublicApiError

None.

Response Formats

application/json, text/json

Sample:
{
  "Contact": {
    "ContactType": 1,
    "PersonDetail": {
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3"
    },
    "HighestPreviousTransaction": 1.1,
    "TotalTransactionAmount": 1.1,
    "FirstTransaction": "2023-01-28T07:56:51.298725-05:00",
    "MostRecentTransaction": "2023-01-28T07:56:51.298725-05:00",
    "Name": "sample string 1",
    "DateCreated": "2023-01-28T07:56:51.298725-05:00",
    "Id": 3
  },
  "Successful": true,
  "Error": {
    "Code": 0,
    "Message": "sample string 1"
  }
}

application/xml, text/xml

Sample:
<GetPageVisitorProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <Message>sample string 1</Message>
    <Code>None</Code>
  </Error>
  <Successful>true</Successful>
  <Contact>
    <Id>3</Id>
    <DateCreated>2023-01-28T07:56:51.298725-05:00</DateCreated>
    <Name>sample string 1</Name>
    <ContactType>Organization</ContactType>
    <FirstTransaction>2023-01-28T07:56:51.298725-05:00</FirstTransaction>
    <HighestPreviousTransaction>1.1</HighestPreviousTransaction>
    <MostRecentTransaction>2023-01-28T07:56:51.298725-05:00</MostRecentTransaction>
    <PersonDetail>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 3</LastName>
      <MiddleName>sample string 2</MiddleName>
    </PersonDetail>
    <TotalTransactionAmount>1.1</TotalTransactionAmount>
  </Contact>
</GetPageVisitorProfileResponse>