Predict Sending Popularity

POST

https://api.mpc.dev.placewise.com/v2/ml/sending/predict_sending_popularity

API Permit:ML:Sending:KPIPrediction

API Context:Loyalty Club

Authorizations:UserToken

Returns predictions for selected KPI for a given sending entity. Version v2, with upgraded models.

Warning: combination of "sms" channel and "open_rate" KPI is not supported.

Text should be as shown to the end user, without any HTML.

Example

When successful, returns:

{
  "baseline": 10.00,
  "prediction": 12.34,
}

Request

Header Params

Body Params application/json

Example

{
    "channel": "sms",
    "kpi": "open_rate",
    "sending_date": "2024-04-20",
    "sending_hour": 16,
    "text": "Canis acervus maxime trepide conculco strues. Calco placeat ipsam tibi."
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

curl --location --request POST 'https://api.mpc.dev.placewise.com/v2/ml/sending/predict_sending_popularity' \
--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' \
--data-raw '{
    "channel": "sms",
    "kpi": "open_rate",
    "sending_date": "2024-04-20",
    "sending_hour": 16,
    "text": "Canis acervus maxime trepide conculco strues. Calco placeat ipsam tibi."
}'

Responses

🟢200Success

application/json

Body

Example

{
    "baseline": 0,
    "prediction": 0
}

Explain Sending Time Series Popularity Prediction

Predict Bulk Sending Popularity

Predict Sending Popularity

Example#

Request

Request Code Samples

Responses

Example