POST example/api/mailstatistics/GetLinkClicksByLinkClickId

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

Gets link clicks.

Request Information

URI Parameters

None.

Body Parameters

Max number of link clicks to get.

Name	Description	Type	Additional information
FromClickId	Id of the first link click to be returned.	integer	Required
BatchSize	Max number of link clicks to get.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "FromClickId": 1,
  "BatchSize": 2
}

application/xml, text/xml

Sample:

<GetLinkClicksByIdArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailStatistics">
  <BatchSize>2</BatchSize>
  <FromClickId>1</FromClickId>
</GetLinkClicksByIdArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An array of MailMessageLinkClickModels.

Collection of MailMessageLinkClickModel

Name	Description	Type	Additional information
Id	Gets or sets the id.	integer	None.
MailRecipientModel	Gets or sets the MailRecipientModel that clicked.	MailRecipientModel	None.
MailMessageQueueId	Gets or sets the id of the MailMessageQueue.	integer	None.
LinkInfoId	Gets or sets the id of the LinkInfo that was clicked.	integer	None.
ClickDate	Gets or sets the click date and time.	date	None.
LinkUrl	Gets or sets the URL of the link that was clicked.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "MailRecipientModel": {
      "CreatedByUserId": 1,
      "CreationDate": "2024-12-03T18:29:13.9383917+01:00",
      "Email": "sample string 3",
      "Id": 4,
      "RecipientEntrySource": "sample string 5",
      "Properties": [
        {
          "Name": "sample string 1",
          "Value": {}
        },
        {
          "Name": "sample string 1",
          "Value": {}
        }
      ]
    },
    "MailMessageQueueId": 2,
    "LinkInfoId": 3,
    "ClickDate": "2024-12-03T18:29:13.9383917+01:00",
    "LinkUrl": "sample string 5"
  },
  {
    "Id": 1,
    "MailRecipientModel": {
      "CreatedByUserId": 1,
      "CreationDate": "2024-12-03T18:29:13.9383917+01:00",
      "Email": "sample string 3",
      "Id": 4,
      "RecipientEntrySource": "sample string 5",
      "Properties": [
        {
          "Name": "sample string 1",
          "Value": {}
        },
        {
          "Name": "sample string 1",
          "Value": {}
        }
      ]
    },
    "MailMessageQueueId": 2,
    "LinkInfoId": 3,
    "ClickDate": "2024-12-03T18:29:13.9383917+01:00",
    "LinkUrl": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMailMessageLinkClickModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailStatistics">
  <MailMessageLinkClickModel>
    <ClickDate>2024-12-03T18:29:13.9383917+01:00</ClickDate>
    <Id>1</Id>
    <LinkInfoId>3</LinkInfoId>
    <LinkUrl>sample string 5</LinkUrl>
    <MailMessageQueueId>2</MailMessageQueueId>
    <MailRecipientModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailRecipient">
      <d3p1:CreatedByUserId>1</d3p1:CreatedByUserId>
      <d3p1:CreationDate>2024-12-03T18:29:13.9383917+01:00</d3p1:CreationDate>
      <d3p1:Email>sample string 3</d3p1:Email>
      <d3p1:Id>4</d3p1:Id>
      <d3p1:Properties>
        <d3p1:PropertyValueModel>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Value />
        </d3p1:PropertyValueModel>
        <d3p1:PropertyValueModel>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Value />
        </d3p1:PropertyValueModel>
      </d3p1:Properties>
      <d3p1:RecipientEntrySource>sample string 5</d3p1:RecipientEntrySource>
    </MailRecipientModel>
  </MailMessageLinkClickModel>
  <MailMessageLinkClickModel>
    <ClickDate>2024-12-03T18:29:13.9383917+01:00</ClickDate>
    <Id>1</Id>
    <LinkInfoId>3</LinkInfoId>
    <LinkUrl>sample string 5</LinkUrl>
    <MailMessageQueueId>2</MailMessageQueueId>
    <MailRecipientModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailRecipient">
      <d3p1:CreatedByUserId>1</d3p1:CreatedByUserId>
      <d3p1:CreationDate>2024-12-03T18:29:13.9383917+01:00</d3p1:CreationDate>
      <d3p1:Email>sample string 3</d3p1:Email>
      <d3p1:Id>4</d3p1:Id>
      <d3p1:Properties>
        <d3p1:PropertyValueModel>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Value />
        </d3p1:PropertyValueModel>
        <d3p1:PropertyValueModel>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Value />
        </d3p1:PropertyValueModel>
      </d3p1:Properties>
      <d3p1:RecipientEntrySource>sample string 5</d3p1:RecipientEntrySource>
    </MailRecipientModel>
  </MailMessageLinkClickModel>
</ArrayOfMailMessageLinkClickModel>