Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
ExplorePublic APIManagement APIUsers APIOperations APIMessaging APIReporting APIML API
Data API
ExplorePublic APIManagement APIUsers APIOperations APIMessaging APIReporting APIML API
Data API
  1. ML API
  • Introduction
  • Predict Sending KPI v1
    POST
  • Explain Sending KPI Prediction v1
    POST
  • Predict Sending KPI In Date Range v1
    POST
  • Predict Sending Popularity v2
    POST
  • Predict Bulk Sending Popularity v2
    POST
  • Predict Sending Text Popularity v2
    POST
  • Predict Sending Time Series Popularity v2
    POST
  • Explain Sending Popularity Prediction v2
    POST
  • Explain Sending Text Popularity Prediction v2
    POST
  • Explain Sending Time Series Popularity Prediction v2
    POST
  • Recommend sending time v2
    POST
  • Detect receipt fraud
    POST
  • Predict item classes
    POST
  • Generate Image
    POST
  • Generate Image Caption
    POST
  • Generate Text
    POST
  • Generate Sending Text
    POST
  1. ML API

Predict Sending Popularity v2

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.

Body Parameters#

ParameterTypeRequired?Description
channelStringyesChannel of sending. One of ["email", "push", "sms"].
kpiStringyesKPI to predict. One of ["ctr", "open_rate"].
sending_dateDateyesDate of sending.
sending_hourIntegeryesHour of sending in local time.
textStringyesSending text. For emails, it should contain both title and content, separated with a space.
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
Go
PHP
Python
HTTP
C#
Ruby
Request Request Example
Shell
JavaScript
Java
Swift
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
{
    "prediction": 0,
    "baseline": 0
}
Previous
Predict Sending KPI In Date Range v1
Next
Predict Bulk Sending Popularity v2
Built with