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

Returns predictions for selected KPI for a given sending entity.

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/ml/sending/predict_sending_kpi' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: '

Responses

🟢200Success

application/json

Body

Example

{}

Introduction

Explain Sending KPI Prediction v1

Predict Sending KPI v1

Body Parameters#

Example#

Request

Request Code Samples

Responses

Body Parameters

Example