Predict Sending KPI v1
POST
https://api.mpc.dev.placewise.com/v1/ml/sending/predict_sending_kpi
API Permit:ML:Sending:KPIPrediction
API Context:Loyalty Club
Authorizations:UserToken
Body Parameters
| Parameter | Type | Required? | Description |
|---|---|---|---|
| title | String | yes | Title of sending. |
| content | String | yes | Content of sending. |
| channel | String | yes | Channel of sending. One of ["email", "push", "sms"]. |
| scheduled_datetime | Date | yes | Scheduled datetime of sending. Format: "YYYY-MM-DD HH:MM:SS" |
| audience_conditions | Array[Object] | yes | Audience conditions of sending. |
| kpi | Array[String] | yes | KPIs to predict. One of ["ctr", "open_rate"]. |
Example
When successful, returns:
{
"predictions": [
{
"kpi": "ctr",
"predictions": [
{
"score": 0.5,
"upper_bound": 0.1,
"bottom_bound": 0.9,
"input": {
// model input features, after processing ...
}
}
],
"model_config": {
"predictions_upper_threshold": 0.5
}
}
]
}Request
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/ml/sending/predict_sending_kpi' \
--header 'X-User-Agent: ApiDog' \
--header 'X-Product-Name: default' \
--header 'X-Loyalty-Club-Slug: infinity-mall' \
--header 'X-Customer: 447' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json'Response Response Example
{}