Back

POST api/Reports/UsageReport

Requires Authorization

Get detailed report based of the specified filter options for RMail productline

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ReportOutputType	Accepted values are : XML/JSON. If ReportReturnType is XML , xml file will be available for download If ReportReturnType is JSON , result content will be json format	string	Required
SenderType	Message sender type - User , Customer, User - All messages by this user , Customer - All messages by users belonging to this Customer .Domain - All messages by users with this domain.IP - All messages from this IP	ReportSearchFieldType_V0	Required
SenderTypeValue	The value of sender type for which report will be generated	string	Required
FromDate	From date	date	None.
ToDate	To date	date	None.
DateRangeType	Date range type for report generation	ReportDateRangeType_V0	None.
ServiceFeature	Service feature type	ServiceFeatureType_V0	None.
DeliveryStatusType	Delivery status type : All , Opened , Delivered	DeliveryStatusType_V0	None.
MessageId	Message Id	string	None.
RecipientAddress	Recipient Address (valid email address )	string	None.
RecipientDomain	Recipient domain	string	None.

Sample Request

Request Formats

application/json, text/json

Sample:

{
  "ReportOutputType": "sample string 1",
  "SenderType": 1,
  "SenderTypeValue": "sample string 2",
  "FromDate": "2024-11-21T09:39:20.2913581+00:00",
  "ToDate": "2024-11-21T09:39:20.2913581+00:00",
  "DateRangeType": 1,
  "ServiceFeature": 0,
  "DeliveryStatusType": 1,
  "MessageId": "sample string 3",
  "RecipientAddress": "sample string 4",
  "RecipientDomain": "sample string 5"
}

Response Information

Resource Description

RMailUsageReportViewModel

Name	Description	Type	Additional information
Usage	Report Data	Collection of RMailUsageReportData	None.

Sample Response

application/json, text/json

Sample:

{
  "Usage": [
    {
      "DateSentUTC": "sample string 1",
      "TimeSentUTC": "sample string 2",
      "SenderAddress": "sample string 3",
      "RecipientAddress": "sample string 4",
      "Subject": "sample string 5",
      "DeliveryStatus": "sample string 6",
      "DeliveryReport": "sample string 7",
      "ClientCode": "sample string 8",
      "SendingApplication": "sample string 9",
      "Encrypted": true,
      "Reply_eSignOff": "sample string 11",
      "EmailSizeMB": "sample string 12",
      "NumberOfUnits": 13,
      "MessageId": "sample string 14",
      "DateDelieveredUTC": "sample string 15",
      "TimeDeliveredUTC": "sample string 16",
      "DateDeliveredLocal": "sample string 17",
      "TimeDeliveredLocal": "sample string 18",
      "DateOpenedUTC": "sample string 19",
      "TimeOpenedUTC": "sample string 20",
      "LargeMail": true,
      "MessageType": "sample string 22",
      "OriginalMessageId": "sample string 23",
      "OriginalSenderAddress": "sample string 24"
    },
    {
      "DateSentUTC": "sample string 1",
      "TimeSentUTC": "sample string 2",
      "SenderAddress": "sample string 3",
      "RecipientAddress": "sample string 4",
      "Subject": "sample string 5",
      "DeliveryStatus": "sample string 6",
      "DeliveryReport": "sample string 7",
      "ClientCode": "sample string 8",
      "SendingApplication": "sample string 9",
      "Encrypted": true,
      "Reply_eSignOff": "sample string 11",
      "EmailSizeMB": "sample string 12",
      "NumberOfUnits": 13,
      "MessageId": "sample string 14",
      "DateDelieveredUTC": "sample string 15",
      "TimeDeliveredUTC": "sample string 16",
      "DateDeliveredLocal": "sample string 17",
      "TimeDeliveredLocal": "sample string 18",
      "DateOpenedUTC": "sample string 19",
      "TimeOpenedUTC": "sample string 20",
      "LargeMail": true,
      "MessageType": "sample string 22",
      "OriginalMessageId": "sample string 23",
      "OriginalSenderAddress": "sample string 24"
    }
  ]
}