[HTTP GET] ~/journeys/{journeyId}/reports/emails/{emailId}/contacts/{state}

Description: Get all Contacts from a given Journey who where sent a given email which is at a specified State

Request Information

URI Parameters

NameDescriptionTypeAdditional information
journeyId

the specific Journey Id

 integer

Required
emailId

the specific Email Id

 integer

Required
state

Possible Values are: "Sent", "Delivered", "Read", "Opened", "Clicked", "Bounced", "SoftBounced", "HardBounced"

 string

Required

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

A List of Contacts

Response Content : Collection of Contact

NameDescriptionTypeAdditional information
ValidationWarnings

Collection of string

None.
EncContactId

string

None.
ListId

integer

None.
Values

Dictionary of string [key] and Object [value]

None.

Response Codes:

  • 200 - OK
    • The specified Journey Email's Contacts were retrieved and returned successfully.
  • 400 - BadRequest
    • The specified state is Invalid
  • 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 Journey or it's Email Report were not found.
  • 500 - InternalServerError
    • An error occurred while processing this request.

Formats

application/json, text/json

Sample: 
[
  {
    "ValidationWarnings": [
      "sample string 1",
      "sample string 2"
    ],
    "EncContactId": "sample string 2",
    "ListId": 3,
    "Values": {
      "sample string 1": {},
      "sample string 3": {}
    }
  },
  {
    "ValidationWarnings": [
      "sample string 1",
      "sample string 2"
    ],
    "EncContactId": "sample string 2",
    "ListId": 3,
    "Values": {
      "sample string 1": {},
      "sample string 3": {}
    }
  }
]

application/csp-report

Sample: 
[{"ValidationWarnings":["sample string 1","sample string 2"],"EncContactId":"sample string 2","ListId":3,"Values":{"sample string 1":{},"sample string 3":{}}},{"ValidationWarnings":["sample string 1","sample string 2"],"EncContactId":"sample string 2","ListId":3,"Values":{"sample string 1":{},"sample string 3":{}}}]

application/xml, text/xml

Sample: 
<ArrayOfContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO">
  <Contact>
    <EncContactId xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">sample string 2</EncContactId>
    <Id xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">1</Id>
    <ListId xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">3</ListId>
    <ValidationWarnings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ValidationWarnings>
    <Values xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Values>
  </Contact>
  <Contact>
    <EncContactId xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">sample string 2</EncContactId>
    <Id xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">1</Id>
    <ListId xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">3</ListId>
    <ValidationWarnings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ValidationWarnings>
    <Values xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Values>
  </Contact>
</ArrayOfContact>