| POST | /CampaignConversions/Run |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CampaignId | body | int | No | |
| People | body | List<CampaignConversionPerson> | No | |
| WindowHours | body | int | No | |
| TargetEventId | body | int? | No | |
| IncludeFood | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Phone | form | string | No | |
| form | string | No | ||
| RecipientId | form | int? | No | |
| Channel | form | string | No | |
| SentAt | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RunId | form | string | No | |
| PeopleMeasured | form | int | No | |
| PeopleConverted | form | int | No | |
| TotalAmount | form | decimal | No | |
| BySurface | form | List<CampaignConversionSurfaceCount> | No | |
| ByChannel | form | List<CampaignConversionSurfaceCount> | No | |
| HeadlineConversions | form | int | No | |
| HeadlineAmount | form | decimal | No | |
| MedianHoursToConvert | form | int | No | |
| Notes | form | List<string> | No | |
| StatusCode | form | int | No | |
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | string | No | |
| People | form | int | No | |
| Count | form | int | No | |
| Amount | form | decimal | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /CampaignConversions/Run HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
campaignId: 0,
people:
[
{
phone: String,
email: String,
recipientId: 0,
channel: String,
sentAt: 0001-01-01
}
],
windowHours: 0,
targetEventId: 0,
includeFood: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
runId: String,
peopleMeasured: 0,
peopleConverted: 0,
totalAmount: 0,
bySurface:
[
{
key: String,
people: 0,
count: 0,
amount: 0
}
],
byChannel:
[
{
key: String,
people: 0,
count: 0,
amount: 0
}
],
headlineConversions: 0,
headlineAmount: 0,
medianHoursToConvert: 0,
notes:
[
String
],
statusCode: 0,
message: String
}