POST example/api/mailstatistics/GetBounces

https://app.bwz.se/bedrock/example/api/mailstatistics/GetBounces

Gets bounces.

Request Information

URI Parameters

None.

Body Parameters

Return settings.

GetBouncesArgs
NameDescriptionTypeAdditional information
MinimumBounceCount

Minimum number times an email address have bounces.

integer

Required

BounceType

Type of bounce

BounceType

Required

FromDateTime

From when to check for bounces.

date

Required

ToDateTime

To when to check for bounces.

date

Required

RecipientReturnInfo

Return settings.

RecipientReturnInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "MinimumBounceCount": 1,
  "BounceType": 1,
  "FromDateTime": "2024-12-23T06:12:53.9222688+01:00",
  "ToDateTime": "2024-12-23T06:12:53.9222688+01:00",
  "RecipientReturnInfo": {
    "Columns": [
      "sample string 1",
      "sample string 2"
    ],
    "SortByColumn": "sample string 1",
    "SortOrder": 1,
    "PageSize": 2,
    "Page": 3,
    "ExportFormat": 2
  }
}

application/xml, text/xml

Sample:
<GetBouncesArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailStatistics">
  <BounceType>HARD_BOUNCE</BounceType>
  <FromDateTime>2024-12-23T06:12:53.9222688+01:00</FromDateTime>
  <MinimumBounceCount>1</MinimumBounceCount>
  <RecipientReturnInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models">
    <d2p1:Columns xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Columns>
    <d2p1:ExportFormat>TAB</d2p1:ExportFormat>
    <d2p1:Page>3</d2p1:Page>
    <d2p1:PageSize>2</d2p1:PageSize>
    <d2p1:SortByColumn>sample string 1</d2p1:SortByColumn>
    <d2p1:SortOrder>ASCENDING</d2p1:SortOrder>
  </RecipientReturnInfo>
  <ToDateTime>2024-12-23T06:12:53.9222688+01:00</ToDateTime>
</GetBouncesArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A tab delimited string

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>