POST api/reporting/sms/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": "41886d0c-9efe-41c6-b796-0f5433ae1dc8",
"StartDate": "2026-01-07T07:31:09.5961136+00:00",
"EndDate": "2026-01-07T07:31:09.5961136+00:00",
"ReturnResponsesOnly": true,
"TenantId": "84b5d39b-2c55-4dcb-91dd-d003fffe6f71",
"UserID": "16883fe1-a5e3-4e19-9f35-a27dffe072c6",
"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>41886d0c-9efe-41c6-b796-0f5433ae1dc8</CampaignId> <EndDate>2026-01-07T07:31:09.5961136+00:00</EndDate> <FilterBySentDate>true</FilterBySentDate> <InteractionTypeId>1</InteractionTypeId> <ReturnResponsesOnly>true</ReturnResponsesOnly> <SearchLimit>1</SearchLimit> <StartDate>2026-01-07T07:31:09.5961136+00:00</StartDate> <TenantId>84b5d39b-2c55-4dcb-91dd-d003fffe6f71</TenantId> <UserID>16883fe1-a5e3-4e19-9f35-a27dffe072c6</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.