POST api/SocialDriver/CreateReport
Create a queued report to be emailed
Request Information
URI Parameters
None.
Body Parameters
CreateReportRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ReportType |
The type of report to be ran |
ReportType |
None. |
| JourneyType |
The types of journeys to show on the report |
JourneyType |
None. |
| EmailAddresses |
The email addresses where the email should be sent |
Collection of string |
None. |
| Body |
The email body |
string |
None. |
| Subject |
The email subject |
string |
None. |
| StartDate |
The report start date |
date |
None. |
| EndDate |
The report end date |
date |
None. |
Request Formats
application/json, text/json
Sample:
{
"ReportType": 0,
"JourneyType": 0,
"EmailAddresses": [
"sample string 1",
"sample string 2"
],
"Body": "sample string 1",
"Subject": "sample string 2",
"StartDate": "2025-12-14T06:11:10.3248986+00:00",
"EndDate": "2025-12-14T06:11:10.3248986+00:00"
}
application/xml, text/xml
Sample:
<CreateReportRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ReportType>BusinessPrivate</ReportType>
<JourneyType>Business</JourneyType>
<EmailAddresses>
<string>sample string 1</string>
<string>sample string 2</string>
</EmailAddresses>
<Body>sample string 1</Body>
<Subject>sample string 2</Subject>
<StartDate>2025-12-14T06:11:10.3248986+00:00</StartDate>
<EndDate>2025-12-14T06:11:10.3248986+00:00</EndDate>
</CreateReportRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |