POST api/reporting/email/interaction
Request Information
URI Parameters
None.
Body Parameters
ReportingFilterCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| CampaignId | globally unique identifier |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| ReturnResponsesOnly | boolean |
None. |
|
| TenantId | globally unique identifier |
None. |
|
| UserID | globally unique identifier |
None. |
|
| InteractionTypeId | integer |
None. |
|
| FilterBySentDate | boolean |
None. |
|
| SearchLimit | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"CampaignId": "86402e7b-b7ca-4ae7-a37a-13f34b7bad29",
"StartDate": "2026-01-07T07:30:59.8171273+00:00",
"EndDate": "2026-01-07T07:30:59.8171273+00:00",
"ReturnResponsesOnly": true,
"TenantId": "af244fde-1b05-49bc-a7cf-30b49768955a",
"UserID": "f7fb02f0-98f1-42a7-9bf8-2aac9b905419",
"InteractionTypeId": 1,
"FilterBySentDate": true,
"SearchLimit": 1
}
application/xml, text/xml
Sample:
<ReportingFilterCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.DigitalSender.Models.FilterCriteria"> <CampaignId>86402e7b-b7ca-4ae7-a37a-13f34b7bad29</CampaignId> <EndDate>2026-01-07T07:30:59.8171273+00:00</EndDate> <FilterBySentDate>true</FilterBySentDate> <InteractionTypeId>1</InteractionTypeId> <ReturnResponsesOnly>true</ReturnResponsesOnly> <SearchLimit>1</SearchLimit> <StartDate>2026-01-07T07:30:59.8171273+00:00</StartDate> <TenantId>af244fde-1b05-49bc-a7cf-30b49768955a</TenantId> <UserID>f7fb02f0-98f1-42a7-9bf8-2aac9b905419</UserID> </ReportingFilterCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.