GET contacts/{contactId}/summary

[HTTP GET] ~/contacts/{contactId}/summary

Description: Get the last 10 Emails, Texts, LandingPages, WebForms, RSVPEvents and Competitions interactions this Contact has had with the Platform

Request Information

URI Parameters

Name	Description	Type	Additional information
contactId	Encrypted Contact Id	string	Required

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

A ContactActivitySummary

Response Content : ContactActivitySummary

Name	Description	Type	Additional information
Emails	List of a Contact's Email Interactions	Collection of ContactEmail	None.
LandingPages	List of a Contact's LandingPage Interactions	Collection of ContactLandingPage	None.
TextMessages	List of a Contact's TextMessage Interactions	Collection of ContactTextMessage	None.
WebForms	List of a Contact's Webform Interactions	Collection of ContactWebForm	None.

Response Codes:

200 - OK
- The specified Contact's Lastest Interactions were retrieved and returned successfully.
401 - Unauthorized
- Request has been denied as it lacks valid Authentication credentials.
403 - Forbidden
- The user does not have the relevant permissions to perform this action.
404 - NotFound
- The specified Contact was not found.
500 - InternalServerError
- An error occurred while processing this request.

Formats

application/json, text/json

Sample:

{
  "Emails": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Date": "2024-12-27T18:36:16.236923+00:00",
      "Delivered": 1,
      "Open": 1,
      "Read": 1,
      "Link": 1
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Date": "2024-12-27T18:36:16.236923+00:00",
      "Delivered": 1,
      "Open": 1,
      "Read": 1,
      "Link": 1
    }
  ],
  "LandingPages": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Date": "2024-12-27T18:36:16.236923+00:00",
      "Link": 1,
      "Submission": 1
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Date": "2024-12-27T18:36:16.236923+00:00",
      "Link": 1,
      "Submission": 1
    }
  ],
  "TextMessages": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Date": "2024-12-27T18:36:16.236923+00:00",
      "Delivered": 3
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Date": "2024-12-27T18:36:16.236923+00:00",
      "Delivered": 3
    }
  ],
  "WebForms": [
    {
      "Id": 1,
      "LandingPageId": 1,
      "Name": "sample string 1",
      "Date": "2024-12-27T18:36:16.236923+00:00",
      "Submitted": 3
    },
    {
      "Id": 1,
      "LandingPageId": 1,
      "Name": "sample string 1",
      "Date": "2024-12-27T18:36:16.236923+00:00",
      "Submitted": 3
    }
  ]
}

application/csp-report

Sample:

{"Emails":[{"Id":1,"Name":"sample string 2","Date":"2024-12-27T18:36:16.236923+00:00","Delivered":1,"Open":1,"Read":1,"Link":1},{"Id":1,"Name":"sample string 2","Date":"2024-12-27T18:36:16.236923+00:00","Delivered":1,"Open":1,"Read":1,"Link":1}],"LandingPages":[{"Id":1,"Name":"sample string 2","Date":"2024-12-27T18:36:16.236923+00:00","Link":1,"Submission":1},{"Id":1,"Name":"sample string 2","Date":"2024-12-27T18:36:16.236923+00:00","Link":1,"Submission":1}],"TextMessages":[{"Id":1,"Name":"sample string 2","Date":"2024-12-27T18:36:16.236923+00:00","Delivered":3},{"Id":1,"Name":"sample string 2","Date":"2024-12-27T18:36:16.236923+00:00","Delivered":3}],"WebForms":[{"Id":1,"LandingPageId":1,"Name":"sample string 1","Date":"2024-12-27T18:36:16.236923+00:00","Submitted":3},{"Id":1,"LandingPageId":1,"Name":"sample string 1","Date":"2024-12-27T18:36:16.236923+00:00","Submitted":3}]}

application/xml, text/xml

Sample:

<ContactActivitySummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO.Contacts">
  <Emails>
    <ContactEmail>
      <Date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2024-12-27T18:36:16.236923Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </Date>
      <Delivered>1</Delivered>
      <Id>1</Id>
      <Link>1</Link>
      <Name>sample string 2</Name>
      <Open>1</Open>
      <Read>1</Read>
    </ContactEmail>
    <ContactEmail>
      <Date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2024-12-27T18:36:16.236923Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </Date>
      <Delivered>1</Delivered>
      <Id>1</Id>
      <Link>1</Link>
      <Name>sample string 2</Name>
      <Open>1</Open>
      <Read>1</Read>
    </ContactEmail>
  </Emails>
  <LandingPages>
    <ContactLandingPage>
      <Date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2024-12-27T18:36:16.236923Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </Date>
      <Id>1</Id>
      <Link>1</Link>
      <Name>sample string 2</Name>
      <Submission>1</Submission>
    </ContactLandingPage>
    <ContactLandingPage>
      <Date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2024-12-27T18:36:16.236923Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </Date>
      <Id>1</Id>
      <Link>1</Link>
      <Name>sample string 2</Name>
      <Submission>1</Submission>
    </ContactLandingPage>
  </LandingPages>
  <TextMessages>
    <ContactTextMessage>
      <Date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2024-12-27T18:36:16.236923Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </Date>
      <Delivered>3</Delivered>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </ContactTextMessage>
    <ContactTextMessage>
      <Date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2024-12-27T18:36:16.236923Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </Date>
      <Delivered>3</Delivered>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </ContactTextMessage>
  </TextMessages>
  <WebForms>
    <ContactWebForm>
      <Date>2024-12-27T18:36:16.236923+00:00</Date>
      <Id>1</Id>
      <LandingPageId>1</LandingPageId>
      <Name>sample string 1</Name>
      <Submitted>3</Submitted>
    </ContactWebForm>
    <ContactWebForm>
      <Date>2024-12-27T18:36:16.236923+00:00</Date>
      <Id>1</Id>
      <LandingPageId>1</LandingPageId>
      <Name>sample string 1</Name>
      <Submitted>3</Submitted>
    </ContactWebForm>
  </WebForms>
</ContactActivitySummary>